summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJosé Fonseca <jfonseca@vmware.com>2015-02-05 12:15:15 +0000
committerJosé Fonseca <jfonseca@vmware.com>2015-02-05 12:15:15 +0000
commitbda81f079cd90ebf952831109500626cbe645266 (patch)
treee2d5f2ce881fd6f1e4e387c755295081020a3eed /docs
parent2208f5a73133df665649880ca4b5aaf5809def4f (diff)
docs: Move gltrace.conf explanation to docs.
Diffstat (limited to 'docs')
-rw-r--r--docs/USAGE.markdown27
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/USAGE.markdown b/docs/USAGE.markdown
index 3e819568..6df7ba0f 100644
--- a/docs/USAGE.markdown
+++ b/docs/USAGE.markdown
@@ -270,6 +270,33 @@ For Direct3D applications you can follow the standard procedure for
`ID3DUserDefinedAnnotation::SetMarker` for D3D11.1 applications.
+## Mask OpenGL features ##
+
+It's now possible to mask some of OpenGL features while tracing via a configuration file:
+
+ * `$XDG_CONFIG_HOME/apitrace/gltrace.conf` or `$HOME/.config/apitrace/gltrace.conf` on Linux
+
+ * `$HOME/Library/Preferences/apitrace/gltrace.conf` on MacOS X
+
+ * `%LOCALAPPDATA%\apitrace\gltrace.conf` on Windows
+
+Here's an example `gltrace.conf` config file showing some variables:
+
+ # comment line
+ GL_VERSION = "2.0"
+ GL_VENDOR = "Acme, Inc."
+ GL_EXTENSIONS = "GL_EXT_texture_swizzle GL_ARB_multitexture"
+ GL_RENDERER = "Acme rasterizer"
+ GL_SHADING_LANGUAGE_VERSION = "1.30"
+ GL_MAX_TEXTURE_SIZE = 1024
+
+This basically overrides the respective `glGetString()` and `glGetIntegerv()`
+parameters.
+
+String values are contained inside `""` pairs and may span multiple lines.
+Integer values are given without quotes.
+
+
## Dump OpenGL state at a particular call ##
You can get a dump of the bound OpenGL state at call 12345 by doing: