summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorcomicfans <comicfans44@gmail.com>2016-01-25 09:02:54 +0800
committerJose Fonseca <jfonseca@vmware.com>2016-01-26 23:16:23 +0000
commitff00df3bfe673574888c55d7325dca271a012b5b (patch)
treeb52a7304c3670a703808d6cca327d25717e948d7 /docs
parent83956caa335991c164481e6294d6a1764a2a4da6 (diff)
docs: Add description to leak trace function.
v2: Minor tweaks (Jose). [ci skip]
Diffstat (limited to 'docs')
-rw-r--r--docs/USAGE.markdown15
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/USAGE.markdown b/docs/USAGE.markdown
index 4edb6565..89dcccf4 100644
--- a/docs/USAGE.markdown
+++ b/docs/USAGE.markdown
@@ -315,6 +315,21 @@ parameters.
String values are contained inside `""` pairs and may span multiple lines.
Integer values are given without quotes.
+## Identify OpenGL object leaks ##
+
+You can identify OpenGL object leaks by running:
+
+ apitrace leaks application.trace
+
+This will print leaked object list and its generated call numbers.
+
+apitrace provides very basic leak tracking: it tracks all textures/
+framebuffers/renderbuffers/buffers name generate and delete call. If a object is not
+deleted until context destruction, it's treated as 'leaked'. This logic doesn't
+consider multi-context in multi-thread situation, so may report incorrect
+results in such scenarios.
+
+To use this fomr the GUI, go to menu -> Trace -> LeakTrace
## Dump OpenGL state at a particular call ##