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