git.cworth.org Git - apitrace/blob - README

   1                               API Trace & Retrace
   2
   3
   4 = Copyright =
   5
   6 Copyright 2011 Jose Fonseca, Zack Rusin
   7 Copyright 2008-2010 VMware, Inc.
   8 All Rights Reserved.
   9
  10 Permission is hereby granted, free of charge, to any person obtaining a copy
  11 of this software and associated documentation files (the "Software"), to deal
  12 in the Software without restriction, including without limitation the rights
  13 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  14 copies of the Software, and to permit persons to whom the Software is
  15 furnished to do so, subject to the following conditions:
  16
  17 The above copyright notice and this permission notice shall be included in
  18 all copies or substantial portions of the Software.
  19
  20 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  21 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  22 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  23 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  24 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  25 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  26 THE SOFTWARE.
  27
  28
  29 = About =
  30
  31 This includes a set of tools for:
  32 - trace OpenGL, D3D8, and D3D9 APIs calls to a file;
  33 - retrace OpenGL calls from a file;
  34 - visualize trace files, and inspect state.
  35
  36
  37 = Status =
  38
  39 * It has not been tested with many applications. Bugs in less used features may
  40   cause application crashes.
  41 * Direct3D 8 support is currently broken.
  42 * No Direct3D retrace support
  43
  44
  45 = Building from source =
  46
  47 Requirements common for all platforms:
  48 * Python (requires version 2.6)
  49 * CMake (tested with version 2.8)
  50
  51 Requirements to build the GUI (optional):
  52 * Qt (tested with version 4.7)
  53 * QJSON (tested with version 0.7.1)
  54
  55
  56 == Linux ==
  57
  58 Build as:
  59
  60  cmake -H. -Bbuild
  61  make -C build
  62
  63
  64 == Windows ==
  65
  66 Requirements:
  67
  68 * Microsoft Visual Studio (tested with 2008 version) or MinGW (tested with gcc version 4.4)
  69
  70 * Microsoft DirectX SDK (tested with August 2007 release)
  71
  72 To build with Visual Studio invoke CMake as:
  73
  74  cmake -G "Visual Studio 9 2008" -H. -Bbuild
  75  cmake --build build --config MinSizeRel
  76
  77 It's also possible to build on Linux with MinGW cross compilers.  See
  78 http://www.cmake.org/Wiki/CmakeMingw for detailed instructions.
  79
  80
  81 = Usage =
  82
  83
  84 == Linux ==
  85
  86 * Run the application you want to trace as
  87
  88  LD_PRELOAD=/path/to/glxtrace.so /path/to/application
  89
  90 * View the trace with
  91
  92  /path/to/dump application.trace
  93
  94 * Replay the trace with
  95
  96  /path/to/glretrace application.trace
  97
  98
  99 == Windows ==
 100
 101 * Copy opengl32.dll, d3d8.dll, or d3d9.dll from build/wrappers directory to the
 102   directory with the application you want to trace.
 103
 104 * Run the application.
 105
 106 * View the trace with
 107
 108  /path/to/dump application.trace
 109
 110 * Replay the trace with
 111
 112  /path/to/glretrace application.trace
 113
 114
 115 = Links =
 116
 117 * http://jrfonseca.blogspot.com/2008/07/tracing-d3d-applications.html
 118
 119
 120 == Direct3D ==
 121
 122  * [http://www.mikoweb.eu/index.php?node=21 Proxy DLL]
 123    * [http://www.codeguru.com/cpp/g-m/directx/directx8/article.php/c11453/ Intercept Calls to DirectX with a Proxy DLL]
 124  * [http://doc.51windows.net/Directx9_SDK/?url=/directx9_sdk/graphics/programmingguide/TutorialsAndSamplesAndToolsAndTips/Tools/D3DSpy.htm D3DSpy]
 125  * [http://msdn.microsoft.com/en-us/library/ee417062.aspx PIX]
 126
 127
 128 == OpenGL ==
 129
 130  * [http://www.opengl.org/sdk/tools/BuGLe/ BuGLe]
 131  * [http://glintercept.nutty.org/ GLIntercept]
 132  * [http://www.gremedy.com/products.php gDEBugger]