args.yaml

name: wrench
version: "0.1"
author: Vladimir Vukicevic <vladimir@pobox.com>
about: WebRender testing and debugging utility

args:
  - verbose:
      short: v
      long: verbose
      help: Enable verbose display
  - debug:
      short: d
      long: debug
      help: Enable debug renderer
  - shaders:
      long: shaders
      help: Override path for shaders
      takes_value: true
  - rebuild:
      short: r
      long: rebuild
      help: Rebuild display list from scratch every frame
  - save:
      long: save
      help: 'Save frames, one of: yaml, json, or binary'
      takes_value: true
  - subpixel_aa:
      short: a
      long: subpixel-aa
      help: Enable subpixel aa
  - headless:
      short: h
      long: headless
      help: Enable headless rendering
  - dp_ratio:
      short: p
      long: device-pixel-ratio
      help: Device pixel ratio
      takes_value: true
  - size:
      short: s
      long: size
      help: Window size, specified as widthxheight (e.g. 1024x768), in pixels
      takes_value: true
  - time:
      short: t
      long: time
      help: Time limit (in seconds)
      takes_value: true
  - vsync:
      long: vsync
      help: Enable vsync for OpenGL window
  - no_batch:
      long: no-batch
      help: Disable batching of instanced draw calls

subcommands:
    - png:
        about: render frame described by YAML and save it to a png file
        args:
          - INPUT:
              help: The input YAML file
              required: true
              index: 1
    - show:
        about: show frame(s) described by YAML
        args:
          - queue:
              short: q
              long: queue
              help: How many frames to submit to WR ahead of time (default 1)
              takes_value: true
          - include:
              long: include
              help: Include the given element type. Can be specified multiple times. (rect/image/text/glyphs/border)
              multiple: true
              takes_value: true
          - watch:
              short: w
              long: watch
              help: Watch the given YAML file, reloading whenever it changes
          - INPUT:
              help: The input YAML file
              required: true
              index: 1
    - replay:
        about: replay binary recording
        args:
          - api:
              long: api
              help: Reissue Api messsages for each frame
          - skip-uploads:
              long: skip-uploads
              help: Skip re-uploads while reissuing Api messages (BROKEN)
          - play:
              long: play
              help: Play entire recording through, then quit (useful with --save)
          - INPUT:
              help: The input binary file or directory
              required: true
              index: 1
    - reftest:
        about: run reftests
        args:
          - REFTEST:
              help: a specific reftest or directory to run
              required: false
              index: 1
    - perf:
        about: run benchmarks
        args:
          - filename:
              help: name of the file to save benchmarks to
              required: true
              index: 1
    - compare_perf:
        about: compare two benchmark files
        args:
          - first_filename:
              help: first benchmark file to compare
              required: true
              index: 1
          - second_filename:
              help: second benchmark file to compare
              required: true
              index: 2