* visualize and edit trace files.
-See the [apitrace homepage](http://apitrace.github.com/) for more details.
+See the [apitrace homepage](http://apitrace.github.io/) for more details.
Obtaining **apitrace**
======================
To obtain apitrace either [download the latest
-binaries](http://apitrace.github.com/#download) for your platform if
+binaries](http://apitrace.github.io/#download) for your platform if
available, or follow the instructions in INSTALL.markdown to build it yourself.
On 64bits Linux and Windows platforms you'll need apitrace binaries that match
the architecture (32bits or 64bits) of the application being traced.
### Linux ###
-On 64 bits systems, you'll need to determine ether the application is 64 bits
+On 64 bits systems, you'll need to determine whether the application is 64 bits
or 32 bits. This can be done by doing
file /path/to/application
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
shared object that wasn't linked with `-Bsymbolic` flag, so relocations to
-those globals function pointers get overwritten with the address to our wrapper
+those global 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 it via `LD_LIBRARY_PATH`:
See the `ld.so` man page for more information about `LD_PRELOAD` and
`LD_LIBRARY_PATH` environment flags.
-To trace the application inside gdb, invoke gdb as:
-
- gdb --ex 'set exec-wrapper env LD_PRELOAD=/path/to/glxtrace.so' --args /path/to/application
-
### Android ###
To trace standalone native OpenGL ES applications, use
-`LD_PRELOAD=/path/to/egltrace.so /path/to/application` like described in the
+`LD_PRELOAD=/path/to/egltrace.so /path/to/application` as described in the
previous section. To trace Java applications, refer to Dalvik.markdown.
### Mac OS X ###
Emitting annotations to the trace
---------------------------------
-From OpenGL applications you can embed annotations in the trace file through the
-[`GL_GREMEDY_string_marker`](http://www.opengl.org/registry/specs/GREMEDY/string_marker.txt)
-and
-[`GL_GREMEDY_frame_terminator`](http://www.opengl.org/registry/specs/GREMEDY/frame_terminator.txt)
-GL extensions.
+From whitin OpenGL applications you can embed annotations in the trace file
+through the following extensions:
+
+* [`GL_KHR_debug`](http://www.opengl.org/registry/specs/KHR/debug.txt)
+
+* [`GL_ARB_debug_output`](http://www.opengl.org/registry/specs/ARB/debug_output.txt)
+
+* [`GL_AMD_debug_output`](http://www.opengl.org/registry/specs/AMD/debug_output.txt)
+
+* [`GL_GREMEDY_string_marker`](http://www.opengl.org/registry/specs/GREMEDY/string_marker.txt)
+
+* [`GL_GREMEDY_frame_terminator`](http://www.opengl.org/registry/specs/GREMEDY/frame_terminator.txt)
-**apitrace** will advertise and intercept these GL extensions independently of
-the GL implementation. So all you have to do is to use these extensions when
-available.
+**apitrace** will advertise and intercept these GL extensions regardless
+of whether the GL implementation supports them or not. So all you have
+to do is to use these extensions when available, and you can be sure they
+will be available when tracing inside **apitrace**.
For example, if you use [GLEW](http://glew.sourceforge.net/) to dynamically
detect and use GL extensions, you could easily accomplish this by doing:
}
-This has the added advantage of working equally well with gDEBugger.
+This has the added advantage of working equally well with
+[(discontinued) gDEBugger](http://developer.amd.com/tools-and-sdks/heterogeneous-computing/archived-tools/amd-gdebugger/).
+Also, provided that the OpenGL implementation supports `GL_KHR_debug`, labels
+defined via glObjectLabel() , and the labels of several objects (textures,
+framebuffers, samplers, etc. ) will appear in the GUI state dumps, in the
+parameters tab.
-From OpenGL ES applications you can embed annotations in the trace file through the
+
+For OpenGL ES applications you can embed annotations in the trace file through the
[`GL_EXT_debug_marker`](http://www.khronos.org/registry/gles/extensions/EXT/EXT_debug_marker.txt)
extension.
apitrace replay -D 12345 application.trace > 12345.json
-This is precisely the mechanism the GUI obtains its own state.
+This is precisely the mechanism the GUI uses to obtain its own state.
You can compare two state dumps by doing:
limitations.
-Recording a video with FFmpeg
------------------------------
+Recording a video with FFmpeg/Libav
+-----------------------------------
-You can make a video of the output by doing
+You can make a video of the output with FFmpeg by doing
apitrace dump-images -o - application.trace \
| ffmpeg -r 30 -f image2pipe -vcodec ppm -i pipe: -vcodec mpeg4 -y output.mp4
+or Libav (which replaces FFmpeg on recent Debian/Ubuntu distros) doing
+
+ apitrace dump-images -o - application.trace \
+ | avconv -r 30 -f image2pipe -vcodec ppm -i - -vcodec mpeg4 -y output.mp4
+
Recording a video with gstreamer
--------------------------------------
Trimming a trace
----------------
-You can make a smaller trace by doing:
+You can truncate a trace by doing:
- apitrace trim --callset 100-1000 -o trimed.trace applicated.trace
+ apitrace trim --exact --calls 0-12345 -o trimed.trace application.trace
If you need precise control over which calls to trim you can specify the
-individual call numbers a plaintext file, as described in the 'Call sets'
+individual call numbers in a plain text file, as described in the 'Call sets'
section above.
+There is also experimental support for automatically trimming the calls
+necessary for a given frame or call:
+
+ apitrace trim --auto --calls=12345 -o trimed.trace application.trace
+ apitrace trim --auto --frames=12345 -o trimed.trace application.trace
+
Profiling a trace
-----------------
* `--ppd` record pixels drawn for each draw call.
-The results from this can then be read by hand or analysed with a script.
+The results from these can then be read by hand or analyzed with a script.
`scripts/profileshader.py` will read the profile results and format them into a
table which displays profiling results per shader.
make "$@"
It is important that builds are both robust, and efficient. Due to broken
-dependency discovery in Mesa's makefile system, it was necessary invoke `make
+dependency discovery in Mesa's makefile system, it was necessary to invoke `make
clean` in every iteration step. `ccache` should be installed to avoid
recompiling unchanged source files.
The `--gl-renderer` option will also cause a commit to be skipped if the
`GL_RENDERER` is unexpected (e.g., when a software renderer or another GL
-driver is unintentionally loaded due to missing symbol in the DRI driver, or
+driver is unintentionally loaded due to a missing symbol in the DRI driver, or
another runtime fault).
projects / apitrace / blobdiff