Vulkan: Document how to turn on debug markers

Bug: b/170249632
Change-Id: Ie71a2e9699c3da88dd7e285177bb0ce1520f5bbc
Reviewed-on: https://chromium-review.googlesource.com/c/angle/angle/+/2506420
Commit-Queue: Ian Elliott <ianelliott@google.com>
Reviewed-by: Tim Van Patten <timvp@google.com>
Reviewed-by: Cody Northrop <cnorthrop@google.com>
This commit is contained in:
Ian Elliott
2020-10-28 15:15:15 -06:00
committed by Commit Bot
parent 5c1d21a1c0
commit f418c10909

View File

@@ -38,6 +38,37 @@ apitrace trace -o mytrace ./out/Debug/hello_triangle
qapitrace mytrace
```
## Enabling Debug Markers
ANGLE can emit debug-utils markers for every GLES API command that are visible to both Android
GPU Inspector (AGI) and RenderDoc. This support is compiled for debug builds or when the
following GN arg is set:
```
angle_enable_trace = true
```
Once compiled, the markers need to be turned on.
### Turning on Debug Markers on Android
On Android, debug markers are turned on and off with an Android debug property that is
automatically deleted at the next reboot:
```
adb shell setprop debug.angle.markers 1
```
* 0: Turned off/disabled (default)
* 1: Turned on/enabled
### Turning on Debug Markers on Desktop
On desktop, debug markers are turned on and off with the ANGLE_ENABLE_DEBUG_MARKERS environment
variable (set in OS-specific manner):
* 0: Turned off/disabled (default)
* 1: Turned on/enabled
## Running ANGLE under GAPID on Linux
[GAPID](https://github.com/google/gapid) can be used to capture trace of Vulkan commands on Linux.