summaryrefslogtreecommitdiff
path: root/README.markdown
blob: 4827ebb2a17d16c58a911d32f3396db78c02114d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
About **apitrace**
==================

**apitrace** consists of a set of tools to:

* trace OpenGL, OpenGL ES, Direct3D, and DirectDraw APIs calls to a file;

* replay OpenGL and OpenGL ES calls from a file;

* inspect OpenGL state at any call while retracing;

* visualize and edit trace files.

See the [apitrace homepage](http://apitrace.github.io/) for more details.


Obtaining **apitrace**
======================

To obtain apitrace either [download the latest
binaries](http://apitrace.github.io/#download) for your platform if available,
or follow the instructions in `docs/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.


Usage
=====

Read `docs/USAGE.markdown` for detailed usage instructions.