6 This includes a set of tools for:
7 - trace OpenGL, D3D8, and D3D9 APIs calls to a file;
8 - retrace OpenGL calls from a file;
9 - visualize trace files, and inspect state.
12 = Building from source =
14 Requirements common for all platforms:
15 * Python (requires version 2.6)
16 * CMake (tested with version 2.8)
18 Requirements to build the GUI (optional):
19 * Qt (tested with version 4.7)
20 * QJSON (tested with version 0.7.1)
23 == Linux / Mac OS X ==
30 You can also build the 32bit GL wrapper on 64bit distro with a multilib gcc by
33 cmake -H. -Bbuild32 -DCMAKE_C_FLAGS=-m32 -DCMAKE_CXX_FLAGS=-m32 -DCMAKE_LINK_FLAGS=-m32
34 make -C build32 glxtrace
39 Additional requirements:
41 * Microsoft Visual Studio (tested with 2008 version) or MinGW (tested with gcc version 4.4)
43 * Microsoft DirectX SDK (tested with August 2007 release)
45 To build with Visual Studio invoke CMake as:
47 cmake -G "Visual Studio 9 2008" -H. -Bbuild
48 cmake --build build --config MinSizeRel
50 If you are building with GUI support (i.e, with QT and QJSON), it should detect
51 the official QT sdk automatically, but you will need to build QJSON yourself
52 and also set the QJSON_INCLUDE_DIR and QJSON_LIBRARIES variables in the
53 generated CMakeCache.txt when building apitrace and repeat the above sequence.
55 It's also possible to build for Windows on Linux with MinGW cross compilers.
56 See http://www.cmake.org/Wiki/CmakeMingw for detailed instructions.
64 Run the application you want to trace as
66 LD_PRELOAD=/path/to/glxtrace.so /path/to/application
68 and it will generate a trace named "application.trace" in the current
69 directory. You can specify the written trace filename by setting the
70 TRACE_FILE envirnment variable before running.
74 /path/to/tracedump application.trace | less -R
78 /path/to/glretrace application.trace
80 Pass the -db option to use a double buffered visual. Pass --help to glretrace
85 /path/to/qapitrace application.trace
88 The LD_PRELOAD mechanism should work with most applications. There are some
89 applications, e.g., Unigine Heaven, which global function pointers with the
90 same name as GL entrypoints, living in a shared object that wasn't linked with
91 -Bsymbolic flag, so relocations to those globals function pointers get
92 overwritten with the address to our wrapper library, and the application will
93 segfault when trying to write to them. For these applications it is possible
94 to trace by using glxtrace.so as an ordinary libGL.so and injecting into
97 ln -s glxtrace.so libGL.so
98 ln -s glxtrace.so libGL.so.1
99 ln -s glxtrace.so libGL.so.1.2
100 export LD_LIBRARY_PATH=/path/to/directory/where/glxtrace/is:$LD_LIBRARY_PATH
101 export TRACE_LIBGL=/path/to/real/libGL.so.1
104 See the 'ld.so' man page for more information about LD_PRELOAD and
105 LD_LIBRARY_PATH environment flags.
110 Usage on Mac OS X is similar to Linux above, except for the tracing procedure,
113 DYLD_LIBRARY_PATH=/path/to/apitrace/wrappers /path/to/application
115 Note that although Mac OS X has an LD_PRELOAD equivalent,
116 DYLD_INSERT_LIBRARIES, it is mostly useless because it only works with
117 DYLD_FORCE_FLAT_NAMESPACE=1 which breaks most applications. See the 'dyld' man
118 page for more details about these environment flags.
123 * Copy opengl32.dll, d3d8.dll, or d3d9.dll from build/wrappers directory to the
124 directory with the application you want to trace.
126 * Run the application.
128 * View the trace with
130 /path/to/tracedump application.trace
132 * Replay the trace with
134 /path/to/glretrace application.trace
139 * http://zrusin.blogspot.com/2011/04/apitrace.html
140 * http://jrfonseca.blogspot.com/2008/07/tracing-d3d-applications.html
146 * [http://www.mikoweb.eu/index.php?node=21 Proxy DLL]
147 * [http://www.codeguru.com/cpp/g-m/directx/directx8/article.php/c11453/ Intercept Calls to DirectX with a Proxy DLL]
148 * [http://graphics.stanford.edu/~mdfisher/D3D9Interceptor.html Direct3D 9 API Interceptor]
151 * [http://msdn.microsoft.com/en-us/library/ee417062.aspx Microsoft PIX]
152 * [http://doc.51windows.net/Directx9_SDK/?url=/directx9_sdk/graphics/programmingguide/TutorialsAndSamplesAndToolsAndTips/Tools/D3DSpy.htm D3DSpy]: the predecessor of PIX
153 * [http://developer.amd.com/gpu/PerfStudio/pages/APITraceWindow.aspx AMD GPU PerfStudio]
159 * [http://www.opengl.org/sdk/tools/BuGLe/ BuGLe]
160 * [http://code.google.com/p/glintercept/ GLIntercept]
161 * [https://gitorious.org/tracy tracy]: OpenGL ES and OpenVG trace, retrace, and state inspection
164 * [http://www.gremedy.com/products.php gDEBugger]
165 * [http://cumbia.informatik.uni-stuttgart.de/glsldevil/index.html glslDevil]
166 * [http://developer.amd.com/gpu/PerfStudio/pages/APITraceWindow.aspx AMD GPU PerfStudio]