| José Fonseca | 0b21731 | 2011-06-30 14:32:57 +0100 | [diff] [blame] | 1 | About **apitrace** |
| 2 | ================== |
| 3 | |
| 4 | **apitrace** consists of a set of tools to: |
| 5 | |
| José Fonseca | f9c5da2 | 2012-04-30 22:59:40 +0100 | [diff] [blame] | 6 | * trace OpenGL, OpenGL ES, Direct3D, and DirectDraw APIs calls to a file; |
| José Fonseca | 0b21731 | 2011-06-30 14:32:57 +0100 | [diff] [blame] | 7 | |
| Carl Worth | f5f7f7f | 2013-02-11 13:49:02 -0800 | [diff] [blame] | 8 | * replay OpenGL and OpenGL ES calls from a file; |
| José Fonseca | 0b21731 | 2011-06-30 14:32:57 +0100 | [diff] [blame] | 9 | |
| José Fonseca | 892cad6 | 2011-09-23 08:24:28 +0100 | [diff] [blame] | 10 | * inspect OpenGL state at any call while retracing; |
| 11 | |
| 12 | * visualize and edit trace files. |
| José Fonseca | 0b21731 | 2011-06-30 14:32:57 +0100 | [diff] [blame] | 13 | |
| José Fonseca | 5785b4f | 2013-06-14 23:47:06 +0100 | [diff] [blame] | 14 | See the [apitrace homepage](http://apitrace.github.io/) for more details. |
| José Fonseca | ab8b9df | 2012-10-21 11:08:36 +0100 | [diff] [blame] | 15 | |
| José Fonseca | 0b21731 | 2011-06-30 14:32:57 +0100 | [diff] [blame] | 16 | |
| Jose Fonseca | 75c7c00 | 2016-10-13 22:52:57 +0100 | [diff] [blame] | 17 | Status |
| 18 | ====== |
| 19 | |
| 20 | TL;DR: Apitrace is still being maintained, but the maintainer has very little |
| 21 | time to work on it, so patches/issues/requests are addressed if/as time permits. |
| 22 | |
| 23 | Long version [here](https://jrfonseca.blogspot.co.uk/2016/10/apitrace-maintenance.html) |
| 24 | |
| 25 | |
| José Fonseca | 45afa26 | 2012-03-09 18:22:28 +0000 | [diff] [blame] | 26 | Obtaining **apitrace** |
| 27 | ====================== |
| José Fonseca | 0b21731 | 2011-06-30 14:32:57 +0100 | [diff] [blame] | 28 | |
| José Fonseca | 5104ef4 | 2012-02-29 09:15:29 +0000 | [diff] [blame] | 29 | To obtain apitrace either [download the latest |
| José Fonseca | 2127819 | 2015-01-20 14:27:04 +0000 | [diff] [blame] | 30 | binaries](http://apitrace.github.io/#download) for your platform if available, |
| José Fonseca | 365fb3e | 2015-01-20 14:30:39 +0000 | [diff] [blame] | 31 | or follow [these instructions](docs/INSTALL.markdown) to build and install it |
| 32 | yourself. |
| 33 | |
| 34 | On 64bits Linux and Windows platforms you'll need apitrace binaries that match |
| 35 | the architecture (32bits or 64bits) of the application being traced. |
| José Fonseca | 5104ef4 | 2012-02-29 09:15:29 +0000 | [diff] [blame] | 36 | |
| José Fonseca | 45afa26 | 2012-03-09 18:22:28 +0000 | [diff] [blame] | 37 | |
| José Fonseca | 2127819 | 2015-01-20 14:27:04 +0000 | [diff] [blame] | 38 | Usage |
| 39 | ===== |
| José Fonseca | 45afa26 | 2012-03-09 18:22:28 +0000 | [diff] [blame] | 40 | |
| José Fonseca | 365fb3e | 2015-01-20 14:30:39 +0000 | [diff] [blame] | 41 | Detailed usage instructions are available [here](docs/USAGE.markdown). |