gecko-dev/gfx/wr/wrench
Nicolas Silva e1d3184a15 Bug 1627299 - Remove the separation between API messages and payloads. r=kvark
Differential Revision: https://phabricator.services.mozilla.com/D69979

--HG--
extra : moz-landing-system : lando
2020-04-14 16:58:39 +00:00
..
benchmarks
examples
reftests Bug 1624468 - Add a fast path for more gradient types in WR r=gw 2020-04-08 22:19:11 +00:00
res
script Bug 1620642 - reftest-analyzer improvements for analyzing test failures r=jgilbert 2020-03-09 19:45:11 +00:00
src Bug 1627299 - Remove the separation between API messages and payloads. r=kvark 2020-04-14 16:58:39 +00:00
.gitignore
Cargo.toml Bug 1628772 - Update core-foundation dependency to 0.7 r=kats 2020-04-11 20:14:41 +00:00
README.md
android.txt Bug 1581628 - Update wrench jobs to work with NDK r20. r=jrmuizel 2019-09-27 13:50:43 +00:00
build.rs

README.md

wrench

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

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.

replay and show

Binary recordings can be generated by webrender and replayed with wrench replay. Enable binary recording in RendererOptions.

RendererOptions {
    ...
    recorder: Some(Box::new(BinaryRecorder::new("wr-frame.bin"))),
    ...
}

If you are working on gecko integration you can enable recording in webrender_bindings/src/bindings.rs by setting

static ENABLE_RECORDING: bool = true;

wrench replay --save yaml will convert the recording into frames described in yaml. Frames can then be replayed with wrench show.

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