gecko-dev/gfx/wr/wrench
2023-06-28 17:41:13 -04:00
..
benchmarks Bug 1778030 - Remove clip_id_stack from wrench r=gfx-reviewers,lsalzman 2022-07-05 20:52:31 +00:00
examples
invalidation
reftests Backed out changeset 928b0d1a27d5 (bug 1830588) with Bug 1836052 and Bug 1836693 for causing regressions 2023-06-28 17:41:13 -04:00
res
script Bug 1804543 - Run webrender wrench scripts with python3. r=gfx-reviewers,gw 2022-12-09 01:35:31 +00:00
src Bug 1824891 - Remove background color and viewport size from ScenePipeline r=gfx-reviewers,ahale 2023-04-02 22:51:05 +00:00
.gitignore
android.txt Bug 1823842 - Explicitly only build the wrench library on android. r=gfx-reviewers,jnicol 2023-03-22 09:02:37 +00:00
build.rs
Cargo.toml Bug 1828248 - Update gleam to 0.15. r=gfx-reviewers,supply-chain-reviewers,jrmuizel 2023-04-24 16:37:06 +00:00
README.md

wrench

wrench is a tool for debugging webrender outside of a browser engine.

Build

Build wrench with cargo build --release within the wrench directory.

headless

wrench has an optional headless mode for use in continuous integration. To run in headless mode, instead of using cargo run -- args, use ./headless.py args.

show

If you are working on gecko integration you can capture a frame via the following steps.

  • Visit about:support and check that the "Compositing" value in the "Graphics" table says "WebRender". Enable gfx.webrender.all in about:config if necessary to enable WebRender.
  • Hit ctrl-shift-3 to capture the frame. The data will be put in ~/wr-capture.
  • View the capture with wrench show ~/wr-capture.

reftest

Wrench also has a reftest system for catching regressions.

  • To run all reftests, run script/headless.py reftest
  • To run specific reftests, run script/headless.py reftest path/to/test/or/dir
  • To examine test failures, use the reftest analyzer
  • To add a new reftest, create an example frame and a reference frame in reftests/ and then add an entry to reftests/reftest.list