git.cworth.org Git - apitrace/blob - 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 * For Direct3D 11.1 support:
  68
  69   * [Microsoft Visual Studio 11 Ultimate Beta](http://www.microsoft.com/download/en/details.aspx?id=27543)
  70
  71 * Other:
  72
  73   * Microsoft Visual Studio (tested with 2010 version) or MinGW (tested with
  74     mingw-w64's gcc version 4.6.2)
  75
  76   * [Microsoft DirectX SDK](http://msdn.microsoft.com/en-us/directx/aa937781):
  77
  78     * for D3D 10, 10.1, and 11 support the [June 2010 release](http://www.microsoft.com/en-us/download/details.aspx?id=6812) is
  79       recommended.
  80
  81     * for D3D7, D3D8 support the [August 2007 release](http://www.microsoft.com/downloads/details.aspx?familyid=529F03BE-1339-48C4-BD5A-8506E5ACF571)
  82       or earlier is required, as later releases do not include the necessary
  83       headers.
  84
  85 To build with Visual Studio first invoke CMake GUI as:
  86
  87     cmake-gui -H. -B%cd%\build
  88
  89 and press the _Configure_ button.
  90
  91 It will try to detect most required/optional dependencies automatically.  When
  92 not found automatically, you can manually specify the location of the
  93 dependencies from the CMake GUI.
  94
  95 After you've successfully configured, you can start the build by opening the
  96 generated `build\apitrace.sln` solution file, or invoking `cmake` as:
  97
  98     cmake --build build --config MinSizeRel
  99
 100 The steps to build 64bit version are similar, but choosing _Visual Studio 10
 101 Win64_ instead of _Visual Studio 10_.
 102
 103 It's also possible to instruct `cmake` build Windows binaries on Linux with
 104 [MinGW cross compilers](http://www.cmake.org/Wiki/CmakeMingw).
 105
 106