|
Name |
|
Date |
Size |
#Lines |
LOC |
| .. | | 03-May-2022 | - |
| ci-scripts/ | H | 30-Mar-2022 | - | 409 | 296 |
| example-compositor/ | H | 30-Mar-2022 | - | 2,686 | 2,114 |
| examples/ | H | 30-Mar-2022 | - | 2,651 | 2,205 |
| glsl-to-cxx/ | H | 30-Mar-2022 | - | 8,245 | 7,427 |
| peek-poke/ | H | 30-Mar-2022 | - | 1,981 | 1,519 |
| swgl/ | H | 30-Mar-2022 | - | 16,593 | 12,965 |
| tileview/ | H | 30-Mar-2022 | - | 844 | 682 |
| webrender/ | H | 30-Mar-2022 | - | 91,008 | 70,316 |
| webrender_api/ | H | 30-Mar-2022 | - | 6,646 | 4,885 |
| webrender_build/ | H | 30-Mar-2022 | - | 513 | 404 |
| wr_malloc_size_of/ | H | 30-Mar-2022 | - | 693 | 552 |
| wrench/ | H | 03-May-2022 | - | 49,061 | 46,172 |
| .gitignore | H A D | 30-Mar-2022 | 193 | 28 | 21 |
| .taskcluster.yml | H A D | 30-Mar-2022 | 7.5 KiB | 181 | 178 |
| Cargo.lock | H A D | 30-Mar-2022 | 44.9 KiB | 1,907 | 1,710 |
| Cargo.toml | H A D | 30-Mar-2022 | 1 KiB | 34 | 28 |
| LICENSE | H A D | 30-Mar-2022 | 15.3 KiB | 375 | 293 |
| README.md | H A D | 30-Mar-2022 | 2.1 KiB | 54 | 36 |
| rustfmt.toml | H A D | 30-Mar-2022 | 170 | 7 | 6 |
| servo-tidy.toml | H A D | 30-Mar-2022 | 902 | 39 | 35 |
README.md
1# WebRender
2
3[](https://crates.io/crates/webrender)
4
5WebRender is a GPU-based 2D rendering engine written in [Rust](https://www.rust-lang.org/). [Firefox](https://www.mozilla.org/firefox), the research web browser [Servo](https://github.com/servo/servo), and other GUI frameworks draw with it. It currently uses the OpenGL API internally.
6
7Note that the canonical home for this code is in gfx/wr folder of the
8mozilla-central repository at https://hg.mozilla.org/mozilla-central. The
9Github repository at https://github.com/servo/webrender should be considered
10a downstream mirror, although it contains additional metadata (such as Github
11wiki pages) that do not exist in mozilla-central. Pull requests against the
12Github repository are still being accepted, although once reviewed, they will
13be landed on mozilla-central first and then mirrored back. If you are familiar
14with the mozilla-central contribution workflow, filing bugs in
15[Bugzilla](https://bugzilla.mozilla.org/enter_bug.cgi?product=Core&component=Graphics%3A%20WebRender)
16and submitting patches there would be preferred.
17
18## Update as a Dependency
19After updating shaders in WebRender, go to servo and:
20
21 * Go to the servo directory and do ./mach update-cargo -p webrender
22 * Create a pull request to servo
23
24
25## Use WebRender with Servo
26To use a local copy of WebRender with servo, go to your servo build directory and:
27
28 * Edit Cargo.toml
29 * Add at the end of the file:
30
31```
32[patch."https://github.com/servo/webrender"]
33"webrender" = { path = "<path>/webrender" }
34"webrender_api" = { path = "<path>/webrender_api" }
35```
36
37where `<path>` is the path to your local copy of WebRender.
38
39 * Build as normal
40
41## Documentation
42
43The Wiki has a [few pages](https://github.com/servo/webrender/wiki/) describing the internals and conventions of WebRender.
44
45## Testing
46
47Tests run using OSMesa to get consistent rendering across platforms.
48
49Still there may be differences depending on font libraries on your system, for
50example.
51
52See [this gist](https://gist.github.com/finalfantasia/129cae811e02bf4551ac) for
53how to make the text tests useful in Fedora, for example.
54
){kind=link}