vello/README.md

# piet-gpu

This repo contains the new prototype for a new compute-centric 2D GPU renderer.

It succeeds the previous prototype, [piet-metal].

The latest version is a middleware for [`wgpu`]. This is used as the rendering backend for
[xilem], a UI toolkit.

<!-- TODO: Are we transitioning to more production? If so, should we rewrite the README a bit? -->

## Goals

The main goal is to answer research questions about the future of 2D rendering:

-   Is a compute-centered approach better than rasterization ([Direct2D])? How much so?

-   To what extent do "advanced" GPU features (subgroups, descriptor arrays) help?

-   Can we improve quality and extend the imaging model in useful ways?

## Blogs and other writing

Much of the research progress on piet-gpu is documented in blog entries. See [doc/blogs.md](doc/blogs.md) for pointers to those.

There is a much larger and detailed [vision](doc/vision.md) that explains the longer-term goals of the project, and how we might get there.

## History

A prior incarnation used a custom cross-API hal. An archive of this version can be found in the branches [`custom-hal-archive-with-shaders`] and [`custom-hal-archive`].

## License and contributions.

The piet-gpu project is dual-licensed under both [Apache 2.0](LICENSE-APACHE) and [MIT](LICENSE_MIT) licenses.

In addition, the shaders are provided under the terms of the [Unlicense](UNLICENSE). The intent is for this research to be used in as broad a context as possible.

The dx12 backend was adapted from piet-dx12 by Brian Merchant.

Contributions are welcome by pull request. The [Rust code of conduct] applies.

[piet-metal]: https://github.com/linebender/piet-metal
[direct2d]: https://docs.microsoft.com/en-us/windows/win32/direct2d/direct2d-portal
[`wgpu`]: https://wgpu.rs/
[xilem]: https://github.com/linebender/xilem/
[rust code of conduct]: https://www.rust-lang.org/policies/code-of-conduct
[`custom-hal-archive-with-shaders`]: https://github.com/linebender/piet-gpu/tree/custom-hal-archive-with-shaders
[`custom-hal-archive`]: https://github.com/linebender/piet-gpu/tree/custom-hal-archive
Licenses and README 2020-04-16 01:56:39 +10:00			`# piet-gpu`

			`This repo contains the new prototype for a new compute-centric 2D GPU renderer.`

			`It succeeds the previous prototype, [piet-metal].`

Remove the old pipeline (#209) Remove the old hal and pipeline. Update the README to reflect this 2022-11-28 03:02:16 +11:00			The latest version is a middleware for [`wgpu`]. This is used as the rendering backend for
			`[xilem], a UI toolkit.`

			`<!-- TODO: Are we transitioning to more production? If so, should we rewrite the README a bit? -->`

Licenses and README 2020-04-16 01:56:39 +10:00			`## Goals`

			`The main goal is to answer research questions about the future of 2D rendering:`

Remove the old pipeline (#209) Remove the old hal and pipeline. Update the README to reflect this 2022-11-28 03:02:16 +11:00			`- Is a compute-centered approach better than rasterization ([Direct2D])? How much so?`
Licenses and README 2020-04-16 01:56:39 +10:00
Remove the old pipeline (#209) Remove the old hal and pipeline. Update the README to reflect this 2022-11-28 03:02:16 +11:00			`- To what extent do "advanced" GPU features (subgroups, descriptor arrays) help?`
Licenses and README 2020-04-16 01:56:39 +10:00
Remove the old pipeline (#209) Remove the old hal and pipeline. Update the README to reflect this 2022-11-28 03:02:16 +11:00			`- Can we improve quality and extend the imaging model in useful ways?`
Licenses and README 2020-04-16 01:56:39 +10:00
Add vision document 2020-12-11 04:15:50 +11:00			`## Blogs and other writing`
Licenses and README 2020-04-16 01:56:39 +10:00
Add vision document 2020-12-11 04:15:50 +11:00			`Much of the research progress on piet-gpu is documented in blog entries. See [doc/blogs.md](doc/blogs.md) for pointers to those.`
Licenses and README 2020-04-16 01:56:39 +10:00
Add vision document 2020-12-11 04:15:50 +11:00			`There is a much larger and detailed [vision](doc/vision.md) that explains the longer-term goals of the project, and how we might get there.`
Licenses and README 2020-04-16 01:56:39 +10:00
Remove the old pipeline (#209) Remove the old hal and pipeline. Update the README to reflect this 2022-11-28 03:02:16 +11:00			`## History`
Licenses and README 2020-04-16 01:56:39 +10:00
Remove the old pipeline (#209) Remove the old hal and pipeline. Update the README to reflect this 2022-11-28 03:02:16 +11:00			A prior incarnation used a custom cross-API hal. An archive of this version can be found in the branches [`custom-hal-archive-with-shaders`] and [`custom-hal-archive`].
Licenses and README 2020-04-16 01:56:39 +10:00
Add unlicense Also take the opportunity to add more links to the README and adopt the Rust code of conduct. 2020-07-03 10:32:14 +10:00			`## License and contributions.`

			`The piet-gpu project is dual-licensed under both [Apache 2.0](LICENSE-APACHE) and [MIT](LICENSE_MIT) licenses.`

Clarify licensing for WGSL shaders (#205) As stated by the README, the intention is for the shaders to be provided under the terms of the Unlicense in addition to the MIT and Apache-2.0 licenses. While here, add a self-contained UNLICENSE file to replace the external reference to unlicense.org. 2022-11-20 03:45:42 +11:00			`In addition, the shaders are provided under the terms of the [Unlicense](UNLICENSE). The intent is for this research to be used in as broad a context as possible.`
Add unlicense Also take the opportunity to add more links to the README and adopt the Rust code of conduct. 2020-07-03 10:32:14 +10:00
Start DX12 backend Very early so far, but cool to have a branch for it. 2020-11-20 04:29:57 +11:00			`The dx12 backend was adapted from piet-dx12 by Brian Merchant.`

Remove the old pipeline (#209) Remove the old hal and pipeline. Update the README to reflect this 2022-11-28 03:02:16 +11:00			`Contributions are welcome by pull request. The [Rust code of conduct] applies.`
Add unlicense Also take the opportunity to add more links to the README and adopt the Rust code of conduct. 2020-07-03 10:32:14 +10:00
Licenses and README 2020-04-16 01:56:39 +10:00			`[piet-metal]: https://github.com/linebender/piet-metal`
Remove the old pipeline (#209) Remove the old hal and pipeline. Update the README to reflect this 2022-11-28 03:02:16 +11:00			`[direct2d]: https://docs.microsoft.com/en-us/windows/win32/direct2d/direct2d-portal`
			[`wgpu`]: https://wgpu.rs/
			`[xilem]: https://github.com/linebender/xilem/`
			`[rust code of conduct]: https://www.rust-lang.org/policies/code-of-conduct`
			[`custom-hal-archive-with-shaders`]: https://github.com/linebender/piet-gpu/tree/custom-hal-archive-with-shaders
			[`custom-hal-archive`]: https://github.com/linebender/piet-gpu/tree/custom-hal-archive