]> git.cworth.org Git - apitrace/blob - INSTALL.markdown
Merge branch 'd3dretrace'
[apitrace] / INSTALL.markdown
1 Building from source
2 ====================
3
4
5 Requirements
6 ------------
7
8 Requirements common for all platforms:
9
10 * Python version 2.6 or 2.7
11
12   * Python Image Library
13
14 * CMake version 2.8 or higher (tested with version 2.8)
15
16
17 The GUI also dependends on:
18
19 * Qt version 4.7
20
21 * QJSON version 0.5 or higher (tested with version 0.7.1, which is bundled)
22
23 Qt and QJSON will be required if `-DENABLE_GUI=TRUE` is passed to `cmake`, and
24 never used if `-DENABLED_GUI=FALSE` is passed instead.  The implicit default is
25 `-DENABLE_GUI=AUTO`, which will build the GUI if Qt is available, using the
26 bundled QJSON if it is not found on the system.
27
28
29 The code also depends on zlib, libpng, and snappy libraries, but the bundled
30 sources are always used regardless of system availability, to make the wrapper
31 shared-objects/DLL self contained, and to prevent symbol collisions when
32 tracing.
33
34
35 Linux / Mac OS X
36 ----------------
37
38 Build as:
39
40     cmake -H. -Bbuild
41     make -C build
42
43 You can also build the 32bit GL wrapper on 64bit distro with a multilib gcc by
44 doing:
45
46     cmake -H. -Bbuild32 -DCMAKE_C_FLAGS=-m32 -DCMAKE_CXX_FLAGS=-m32 -DCMAKE_EXE_LINKER_FLAGS=-m32 -DENABLE_GUI=FALSE
47     make -C build32 glxtrace
48
49 Android
50 -------
51
52 Additional requirements:
53
54 * [Android NDK](http://developer.android.com/sdk/ndk/index.html)
55
56 Build as:
57
58     export ANDROID_NDK=/path/to/your/ndk
59     cmake -DCMAKE_TOOLCHAIN_FILE=cmake/toolchain/android.toolchain.cmake -DANDROID_API_LEVEL=9 -H. -Bbuild
60     make -C build
61
62 Windows
63 -------
64
65 Additional requirements:
66
67 * Microsoft Visual Studio (tested with 2008 version) or MinGW (tested with gcc version 4.4)
68
69 * Microsoft DirectX SDK:
70
71   * for D3D10 support the [latest](http://msdn.microsoft.com/en-us/directx/default.aspx) is
72     recommended.
73
74   * for DDRAW, D3D7, D3D8 support the [August 2007 release](http://www.microsoft.com/downloads/details.aspx?familyid=529F03BE-1339-48C4-BD5A-8506E5ACF571)
75     or earlier is required, as later releases do not include the necessary
76     headers.
77
78 To build with Visual Studio first invoke CMake GUI as:
79
80     cmake-gui -H. -B%cd%\build
81
82 and press the _Configure_ button.
83
84 It will try to detect most required/optional dependencies automatically.  When
85 not found automatically, you can manually specify the location of the
86 dependencies from the CMake GUI.
87
88 After you've successfully configured, you can start the build by opening the
89 generated `build\apitrace.sln` solution file, or invoking `cmake` as:
90
91     cmake --build build --config MinSizeRel
92
93 The steps to build 64bit version are similar, but choosing _Visual Studio 9
94 2008 Win64_ instead of _Visual Studio 9 2008_.
95
96 It's also possible to instruct `cmake` build Windows binaries on Linux with
97 [MinGW cross compilers](http://www.cmake.org/Wiki/CmakeMingw).
98
99