* visualize and edit trace files.
-Basic usage
-===========
+Obtaining **apitrace**
+======================
To obtain apitrace either [download the latest
binaries](https://github.com/apitrace/apitrace/downloads) for your platform if
-available, or follow the [build instructions](INSTALL.markdown) to build it
-yourself. On 64bits Linux and Windows platforms you'll need apitrace binaries
-that match the architecture (32bits or 64bits) of the application being traced.
+available, or follow the instructions in INSTALL.markdown to build it yourself.
+On 64bits Linux and Windows platforms you'll need apitrace binaries that match
+the architecture (32bits or 64bits) of the application being traced.
+
+
+Basic usage
+===========
Run the application you want to trace as
Pass the `-sb` option to use a single buffered visual. Pass `--help` to
glretrace for more options.
+
+Basic GUI usage
+===============
+
Start the GUI as
qapitrace application.trace
+You can also tell the GUI to go directly to a specific call
+
+ qapitrace application.trace 12345
+
Advanced command line usage
===========================
This can be achieved with retracediff.py script, which invokes glretrace with
different environments, allowing to choose the desired GL driver by
-manipulating variables such as `LD_LIBRARY_PATH` or `LIBGL_DRIVERS_DIR`.
+manipulating variables such as `LD_LIBRARY_PATH`, `LIBGL_DRIVERS_DIR`, or
+`TRACE_LIBGL`.
-For example:
+For example, on Linux:
./scripts/retracediff.py \
--ref-env LD_LIBRARY_PATH=/path/to/reference/GL/implementation \
- -r ./glretrace \
+ --retrace /path/to/glretrace \
--diff-prefix=/path/to/output/diffs \
application.trace
+Or on Windows:
+
+ python scripts\retracediff.py --retrace \path\to\glretrace.exe --ref-env TRACE_LIBGL=\path\to\reference\opengl32.dll application.trace
Links
* [D3DSpy](http://doc.51windows.net/Directx9_SDK/?url=/directx9_sdk/graphics/programmingguide/TutorialsAndSamplesAndToolsAndTips/Tools/D3DSpy.htm): the predecessor of PIX
+* [NVIDIA PerfKit](http://developer.nvidia.com/nvidia-perfkit)
+
* [AMD GPU PerfStudio](http://developer.amd.com/gpu/PerfStudio/pages/APITraceWindow.aspx)
+* [Intel Graphics Performance Analyzers](http://www.intel.com/software/gpa/)
+
OpenGL
------
Closed-source:
-* [gDEBugger](http://www.gremedy.com/products.php)
+* [gDEBugger](http://www.gremedy.com/products.php) and [AMD gDEBugger](http://developer.amd.com/tools/gDEBugger/Pages/default.aspx)
* [glslDevil](http://cumbia.informatik.uni-stuttgart.de/glsldevil/index.html)