kc3-lang/angle/doc/CaptureAndReplay.md

• Show log

  Commit

• Hash : 653ee5f1
  Author :
  Date : 2019-11-07T09:14:22
  

  Capture/Replay: Introduce capture index file.
  
  This index file lets us very easily write a generic capture sample.
  Previously the dev had to maintain a list of multiple sources files.
  Potentially hundreds. By writing the source file list to an index file
  we can load this easily in GN as a variable and plug that into the
  sources.
  
  Also updates docs.
  
  Bug: angleproject:3611
  Change-Id: I69ba961e271d6d13d06ae01c89a0605a6fd725ec
  Reviewed-on: https://chromium-review.googlesource.com/c/angle/angle/+/1902189
  Commit-Queue: Jamie Madill <jmadill@chromium.org>
  Reviewed-by: Cody Northrop <cnorthrop@google.com>
  

Download

angle_with_capture_by_default = true

$ ANGLE_CAPTURE_FRAME_END=4 ANGLE_CAPTURE_OUT_DIR=samples/capture_replay out/Debug/simple_texture_2d

angle_build_capture_replay_sample = true

$ autoninja -C out/Debug capture_replay_sample
$ ANGLE_CAPTURE_ENABLED=0 out/Debug/capture_replay_sample

Source

• doc/CaptureAndReplay.md

• # ANGLE OpenGL Frame Capture and Replay
  
  ANGLE currently supports a limited OpenGL capture and replay framework.
  
  Limitations:
  
   * GLES capture has many unimplemented functions.
   * EGL capture and replay is not yet supported.
   * Mid-execution capture is supported with the Vulkan back-end.
   * Mid-execution capture has many unimplemented features.
   * Capture and replay is currently only tested on desktop platforms.
   * Binary replay is unimplemented. CPP replay is supported.
  
  ## Capturing and replaying an application
  
  To build ANGLE with capture and replay enabled update your GN args:
  
  ```
  angle_with_capture_by_default = true
  ```
  
  Once built ANGLE will capture the OpenGL ES calls to CPP replay files. By default the replay will be
  stored in the current working directory. The capture files will be named according to the pattern
  `angle_capture_context{id}_frame{n}.cpp`. Each GL Context currently has its own replay sources.
  ANGLE will write out data binary blobs for large Texture or Buffer contents to
  `angle_capture_context{id}_frame{n}.angledata`. Replay programs must be able to load data from the
  corresponding `angledata` files.
  
  ## Controlling Frame Capture
  
  Some simple environment variables control frame capture:
  
   * `ANGLE_CAPTURE_ENABLED`:
     * Set to `0` to disable capture entirely. Default is `1`.
   * `ANGLE_CAPTURE_OUT_DIR=<path>`:
     * Can specify an alternate replay output directory.
     * Example: `ANGLE_CAPTURE_OUT_DIR=samples/capture_replay`. Default is the CWD.
   * `ANGLE_CAPTURE_FRAME_START=<n>`:
     * Uses mid-execution capture to write "Setup" functions that starts a Context at frame `n`.
     * Example: `ANGLE_CAPTURE_FRAME_START=2`. Default is `0`.
   * `ANGLE_CAPTURE_FRAME_END=<n>`:
     * By default ANGLE will capture the first ten frames. This variable can override the default.
     * Example: `ANGLE_CAPTURE_FRAME_END=4`. Default is `10`.
  
  A good way to test out the capture is to use environment variables in conjunction with the sample
  template. For example:
  
  ```
  $ ANGLE_CAPTURE_FRAME_END=4 ANGLE_CAPTURE_OUT_DIR=samples/capture_replay out/Debug/simple_texture_2d
  ```
  
  ## Running a CPP replay
  
  To run a CPP replay you can use a template located in
  [samples/capture_replay](../samples/capture_replay). First run your capture and ensure all capture
  files are written to `samples/capture_replay`. You can conveniently use `ANGLE_CAPTURE_OUT_DIR`.
  Then enable the `capture_replay_sample` via `gn args`:
  
  ```
  angle_build_capture_replay_sample = true
  ```
  
  See [samples/BUILD.gn](../samples/BUILD.gn) for details. Then build and run your replay sample:
  
  ```
  $ autoninja -C out/Debug capture_replay_sample
  $ ANGLE_CAPTURE_ENABLED=0 out/Debug/capture_replay_sample
  ```
  
  Note that we specify `ANGLE_CAPTURE_ENABLED=0` to prevent re-capturing when running the replay.
  

Download