summaryrefslogtreecommitdiff
path: root/README
blob: be3a5b73d1f6fc815900b86b07d75ddbe3ddc76b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
			      API Trace & Retrace


= Copyright =

Copyright 2008-2010 VMware, Inc.
All Rights Reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.


= About =

Wrapper DLLs to trace OpenGL, D3D8, and D3D9 APIs calls.


= Status =

* Direct3D 8 and 9 are broken at the moment.
* It has not been tested with many applications. Bugs may cause the application to crash. 


= Building from source =

Common requirements:
* Python (requires version 2.6)
* CMake (tested with version 2.8)

== Linux ==

Build as:

 cmake -H. -Bbuild
 make -C build

== Windows ==

Requirements:
* Microsoft Visual Studio (tested with 2008 version) or MinGW (tested with gcc version 4.4)
* Microsoft DirectX SDK (tested with August 2007 release)

To build with Visual Studio invoke CMake as:

 cmake -G "Visual Studio 9 2008" -H%CD% -B%CD%\build
 cmake --build %CD%\build --config MinSizeRel
 
It's also possible to build on Linux with MinGW cross compilers.  See
http://www.cmake.org/Wiki/CmakeMingw for detailed instructions.


= Usage =

== Linux ==

* Run the application you want to trace as

 LD_PRELOAD=path/to/glxtrace.so path/to/application

* View the trace with

 path/to/dump application.trace

* Replay the trace with

 path/to/glretrace application.trace


== Windows ==

* Copy opengl32.dll, d3d8.dll, or d3d9.dll to the directory with the application you want to trace.
* Run the application.
* View the trace with

 path/to/dump application.trace

* Replay the trace with

 path/to/glretrace application.trace


= Related Links =

* http://jrfonseca.blogspot.com/2008/07/tracing-d3d-applications.html

== Direct3D ==

 * [http://www.mikoweb.eu/index.php?node=21 Proxy DLL]
   * [http://www.codeguru.com/cpp/g-m/directx/directx8/article.php/c11453/ Intercept Calls to DirectX with a Proxy DLL]
 * [http://doc.51windows.net/Directx9_SDK/?url=/directx9_sdk/graphics/programmingguide/TutorialsAndSamplesAndToolsAndTips/Tools/D3DSpy.htm D3DSpy]
 * [http://msdn.microsoft.com/en-us/library/ee417062.aspx PIX]

== OpenGL ==

 * [http://www.opengl.org/sdk/tools/BuGLe/ BuGLe]
 * [http://glintercept.nutty.org/ GLIntercept]
 * [http://www.gremedy.com/products.php gDEBugger]