gecko-dev/gfx/wrench
Kartikaya Gupta 71c85d4c22 Bug 1432789 - Update webrender to 1d8157c71f88d5c673f5d084f02515ab74263814. r=jrmuizel
MozReview-Commit-ID: JakzOipPChe

--HG--
extra : rebase_source : 5f3db52bd59749bc79c0e5c530ae04ab19c03d1d
2018-01-26 15:54:36 -05:00
..
res
src
.gitignore
build.rs
Cargo.toml
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 ./headless.py reftest
  • To run specific reftests, run ./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