]> git.cworth.org Git - apitrace/blob - README
Inline the HTML style sheet.
[apitrace] / README
1                                    D3D Trace
2
3
4 = Copyright =
5
6 Copyright 2008 Tungsten Graphics, Inc.
7
8 This program is free software: you can redistribute it and/or modify it
9 under the terms of the GNU Lesser General Public License as published
10 by the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
12
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 GNU Lesser General Public License for more details.
17
18 You should have received a copy of the GNU Lesser General Public License
19 along with this program.  If not, see <http://www.gnu.org/licenses/>.
20
21
22 = About =
23
24 Wrapper DLLs to trace D3D8 and D3D9 APIs calls.
25
26 Based on the idea from Michael Koch. 
27
28 See also:
29 * http://www.mikoweb.eu/index.php?node=21
30 * http://www.codeguru.com/cpp/g-m/directx/directx8/article.php/c11453/
31 * http://doc.51windows.net/Directx9_SDK/?url=/directx9_sdk/graphics/programmingguide/TutorialsAndSamplesAndToolsAndTips/Tools/D3DSpy.htm
32
33
34 = Status =
35
36 * Only Direct3D 8 and 9 are supported at the moment.
37 * It has not been tested with many applications. Bugs may cause the application to crash. 
38
39
40 = Building from source =
41
42 Requirements:
43 * Python (tested with version 2.5)
44 * SCons (tested with 0.98.4)
45 * Microsoft Visual Studio (tested with 2005 version)
46 * Microsoft DirectX SDK (tested with August 2007 release)
47
48 Instructions:
49
50 * Invoke scons:
51
52  scons debug=no dxsdk=C:\DXSDK
53  
54 * You can write those options to a file named config.py:
55
56  # config.py
57  debug=1
58  dxsdk='C:\\DXSDK'
59  
60 * Invoke
61
62   scons -h
63
64 See the scons manpage for more info.
65
66
67 = Usage =
68
69 * Copy d3d8.dll, d3d9.dll, or opengl32.dll and apitrace.xsl to the directory with the application you want to trace.
70 * Run the application.
71 * Open the output XML file with Firefox or Internet Explorer to view the log.
72 * For long XML files is better to use xml2txt.py script.
73
74