gecko-dev/gfx/wrench
WR Updater Bot dbcebc32f4 Bug 1503263 - Update webrender to commit a2997bc78ce6e161fd379e04e2e4479525d12782 (WR PR 3245). r=kats
Differential Revision: https://phabricator.services.mozilla.com/D10318

--HG--
extra : moz-landing-system : lando
2018-10-31 00:42:58 +00:00
..
res
src Bug 1503263 - Update webrender to commit a2997bc78ce6e161fd379e04e2e4479525d12782 (WR PR 3245). r=kats 2018-10-31 00:42:58 +00:00
.gitignore
Cargo.toml Bug 1500711 - Update webrender to commit 9464adaf2634f8d11408b915323d8006474f02e2. r=kats 2018-10-22 17:13:50 +00:00
README.md
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