Skip to content

Commit f418c10

Browse files
ianelliottusCommit Bot
authored andcommitted
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>
1 parent 5c1d21a commit f418c10

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

doc/DebuggingTips.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,37 @@ apitrace trace -o mytrace ./out/Debug/hello_triangle
3838
qapitrace mytrace
3939
```
4040

41+
## Enabling Debug Markers
42+
43+
ANGLE can emit debug-utils markers for every GLES API command that are visible to both Android
44+
GPU Inspector (AGI) and RenderDoc. This support is compiled for debug builds or when the
45+
following GN arg is set:
46+
```
47+
angle_enable_trace = true
48+
```
49+
Once compiled, the markers need to be turned on.
50+
51+
### Turning on Debug Markers on Android
52+
53+
On Android, debug markers are turned on and off with an Android debug property that is
54+
automatically deleted at the next reboot:
55+
56+
```
57+
adb shell setprop debug.angle.markers 1
58+
```
59+
60+
* 0: Turned off/disabled (default)
61+
* 1: Turned on/enabled
62+
63+
### Turning on Debug Markers on Desktop
64+
65+
On desktop, debug markers are turned on and off with the ANGLE_ENABLE_DEBUG_MARKERS environment
66+
variable (set in OS-specific manner):
67+
68+
* 0: Turned off/disabled (default)
69+
* 1: Turned on/enabled
70+
71+
4172
## Running ANGLE under GAPID on Linux
4273

4374
[GAPID](https://github.com/google/gapid) can be used to capture trace of Vulkan commands on Linux.

0 commit comments

Comments
 (0)