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

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