gecko-dev/gfx/wr/wrench
2019-05-30 19:28:10 +00:00
..
benchmarks Bug 1528157 - Optimize GPU time for clip mask generation. r=kvark 2019-02-19 20:52:27 +00:00
examples Bug 1525741 - Support animating yaml files in wrench. r=kvark 2019-02-07 18:03:59 +00:00
reftests Bug 1555476 - Implement flood filter in WebRender r=gw 2019-05-30 03:11:53 +00:00
res
script Bug 1533282 - Restore the debugging options in wrench/script/headless.py. r=kvark,kats 2019-03-08 11:15:32 +01:00
src Bug 1536240 - Add debug option to wrench to output specified shader source r=kvark 2019-05-30 19:28:10 +00:00
.gitignore
android.txt Bug 1549776 - Add taskcluster jobs for running wrench on Android. r=jrmuizel 2019-05-23 19:31:06 +00:00
build.rs
Cargo.toml Bug 1554401 - Part 1: Update dwrote to 0.9. r=emilio 2019-05-25 17:08:40 +00:00
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