gfx/wr/wrench/README.md

   1 # wrench
   2
   3 `wrench` is a tool for debugging webrender outside of a browser engine.
   4
   5 ## Build
   6
   7 Build `wrench` with `cargo build --release` within the `wrench` directory.
   8
   9 ## headless
  10
  11 `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`.
  12
  13 ## `show`
  14
  15 If you are working on gecko integration you can capture a frame via the following steps.
  16 * 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.
  17 * Hit ctrl-shift-3 to capture the frame. The data will be put in `~/wr-capture`.
  18 * View the capture with `wrench show ~/wr-capture`.
  19
  20 ## `reftest`
  21
  22 Wrench also has a reftest system for catching regressions.
  23 * To run all reftests, run `script/headless.py reftest`
  24 * To run specific reftests, run `script/headless.py reftest path/to/test/or/dir`
  25 * To examine test failures, use the [reftest analyzer](https://hg.mozilla.org/mozilla-central/raw-file/tip/layout/tools/reftest/reftest-analyzer.xhtml)
  26 * To add a new reftest, create an example frame and a reference frame in `reftests/` and then add an entry to `reftests/reftest.list`