Add script to recompress traces.

[apitrace] / README

diff --git a/README b/README
index 8fc78a1d6c9b167ccb5b84532b325eddc62bb867..463cc65ceacc199aeb0f1903acdef056daa1a69f 100644 (file)
--- a/README
+++ b/README
@@ -60,6 +60,12 @@ Build as:
  cmake -H. -Bbuild
  make -C build
 
+You can also build the 32bit GL wrapper on 64bit distro with a multilib gcc by
+doing:
+
+ cmake -H. -Bbuild32 -DCMAKE_C_FLAGS=-m32 -DCMAKE_CXX_FLAGS=-m32 -DCMAKE_LINK_FLAGS=-m32
+ make -C build32 glxtrace
+
 
 == Windows ==
 
@@ -83,18 +89,46 @@ http://www.cmake.org/Wiki/CmakeMingw for detailed instructions.
 
 == Linux ==
 
-* Run the application you want to trace as
+Run the application you want to trace as
 
  LD_PRELOAD=/path/to/glxtrace.so /path/to/application
 
-* View the trace with
+and it will generate a trace named "application.trace" in the current
+directory.  You can specify the written trace filename by setting the
+TRACE_FILE envirnment variable before running.
 
- /path/to/tracedump application.trace
+View the trace with
 
-* Replay the trace with
+ /path/to/tracedump application.trace | less -R
+
+Replay the trace with
 
  /path/to/glretrace application.trace
 
+Pass the -db option to use a double buffered visual.  Pass --help to glretrace
+for more options.
+
+Start the GUI as
+
+  /path/to/qapitrace application.trace
+
+
+The LD_PRELOAD mechanism should work with most applications.  There are some
+applications, e.g., Unigine Heaven, which global function pointers with the
+same name as GL entrypoints, living in a shared object that wasn't linked with
+-Bsymbolic flag, so relocations to those globals function pointers get
+overwritten with the address to our wrapper library, and the application will
+segfault when trying to write to them.  For these applications it is possible
+to trace by using glxtrace.so as an ordinary libGL.so and injecting into
+LD_LIBRARY_PATH:
+
+  ln -s glxtrace.so libGL.so
+  ln -s glxtrace.so libGL.so.1
+  ln -s glxtrace.so libGL.so.1.2
+  export LD_LIBRARY_PATH=/path/to/directory/where/glxtrace/is:$LD_LIBRARY_PATH
+  export TRACE_LIBGL=/path/to/real/libGL.so.1
+  /path/to/application
+
 
 == Windows ==
 
@@ -114,6 +148,7 @@ http://www.cmake.org/Wiki/CmakeMingw for detailed instructions.
 
 = Links =
 
+* http://zrusin.blogspot.com/2011/04/apitrace.html
 * http://jrfonseca.blogspot.com/2008/07/tracing-d3d-applications.html
 
 
@@ -122,11 +157,16 @@ http://www.cmake.org/Wiki/CmakeMingw for detailed instructions.
  * [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]
+ * [http://msdn.microsoft.com/en-us/library/ee417062.aspx Microsoft PIX]
+ * [http://graphics.stanford.edu/~mdfisher/D3D9Interceptor.html Direct3D 9 API Interceptor]
+ * [http://developer.amd.com/gpu/PerfStudio/pages/APITraceWindow.aspx AMD GPU PerfStudio]
 
 
 == OpenGL ==
 
  * [http://www.opengl.org/sdk/tools/BuGLe/ BuGLe]
- * [http://glintercept.nutty.org/ GLIntercept]
+ * [http://code.google.com/p/glintercept/ GLIntercept]
  * [http://www.gremedy.com/products.php gDEBugger]
+ * [http://cumbia.informatik.uni-stuttgart.de/glsldevil/index.html glslDevil]
+ * [http://developer.amd.com/gpu/PerfStudio/pages/APITraceWindow.aspx AMD GPU PerfStudio]
+