X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=README.markdown;h=ab1453059d6f97b325197a14ce07b1e961889a39;hb=fbcb5d9fc467da2d91b330bfd62f15e7d07ed1c2;hp=6f212f5e94413068cbd209cb4c5ec1c08b854bc4;hpb=2f4d15d67b7365d57c4dc031ab4878d976927166;p=apitrace

diff --git a/README.markdown b/README.markdown
index 6f212f5..ab14530 100644
--- a/README.markdown
+++ b/README.markdown
@@ -52,7 +52,9 @@ Replay an OpenGL trace with
     glretrace application.trace
 
 Pass the `-sb` option to use a single buffered visual.  Pass `--help` to
-glretrace for more options.
+`glretrace` for more options.
+
+EGL traces must be replayed with `eglretrace` instead of `glretrace`.
 
 
 Basic GUI usage
@@ -112,14 +114,17 @@ or 32 bits.  This can be done by doing
 But beware of wrapper shell scripts -- what matters is the architecture of the
 main process.
 
-Run the application you want to trace as
+Run the GLX application you want to trace as
 
-     LD_PRELOAD=/path/to/apitrace/wrappers/glxtrace.so /path/to/application
+    LD_PRELOAD=/path/to/apitrace/wrappers/glxtrace.so /path/to/application
 
 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` environment variable before running.
 
+For EGL applications you will need to use `egltrace.so` instead of
+`glxtrace.so`.
+
 The `LD_PRELOAD` mechanism should work with the majority applications.  There
 are some applications (e.g., Unigine Heaven, Android GPU emulator, etc.), that
 have global function pointers with the same name as GL entrypoints, living in a
@@ -277,8 +282,14 @@ From OpenGL ES applications you can embed annotations in the trace file through
 extension.
 
 
-For Direct3D applications you can follow the same procedure used for 
-[instrumenting an application for PIX](http://technet.microsoft.com/en-us/query/ee417250)
+For Direct3D applications you can follow the standard procedure for
+[adding user defined events to Visual Studio Graphics Debugger / PIX](http://msdn.microsoft.com/en-us/library/vstudio/hh873200.aspx):
+
+- `D3DPERF_BeginEvent`, `D3DPERF_EndEvent`, and `D3DPERF_SetMarker` for D3D9 applications.
+
+- `ID3DUserDefinedAnnotation::BeginEvent`,
+  `ID3DUserDefinedAnnotation::EndEvent`, and
+  `ID3DUserDefinedAnnotation::SetMarker` for D3D11.1 applications.
 
 
 Dump GL state at a particular call