diff options
Diffstat (limited to 'third_party/webrender/wrench/README.md')
| -rw-r--r-- | third_party/webrender/wrench/README.md | 27 |
1 files changed, 18 insertions, 9 deletions
diff --git a/third_party/webrender/wrench/README.md b/third_party/webrender/wrench/README.md index 6a60c6bb56c..1119a27112e 100644 --- a/third_party/webrender/wrench/README.md +++ b/third_party/webrender/wrench/README.md @@ -2,20 +2,29 @@ `wrench` is a tool for debugging webrender outside of a browser engine. -## Build - -Build `wrench` with `cargo build --release` within the `wrench` directory. - ## 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`. -## `show` +## `replay` and `show` + +Binary recordings can be generated by webrender and replayed with `wrench replay`. Enable binary recording in `RendererOptions`. + +```rust +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 + +```rust +static ENABLE_RECORDING: bool = true; +``` -If you are working on gecko integration you can capture a frame via the following steps. -* 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. -* Hit ctrl-shift-3 to capture the frame. The data will be put in `~/wr-capture`. -* View the capture with `wrench show ~/wr-capture`. +`wrench replay --save yaml` will convert the recording into frames described in yaml. Frames can then be replayed with `wrench show`. ## `reftest` |