Linux version of the Runtime SDK

The Linux version of the SpeedTree Runtime SDK uses OpenGL and shares the rendering OpenGL SpeedTree Renderer library source with the Windows version.

Minimum requirements

  • Compiler: GCC 8
  • OpenGL: 4.2

Building the SDK and reference application

As described in the SDK organization section, the SpeedTree Runtime SDK includes four libraries and comes with a reference application, all of which you have to build before use.

Note

This distribution includes several Linux/ folders that contain Linux specifics as it was built from a larger codebase that supports a number of platforms.

To build or clean them all at once, run the corresponding script:

  • [SpeedTree SDK]/SDK/Source/ReferenceApplication/OpenGL/build_all.sh
  • [SpeedTree SDK]/SDK/Source/ReferenceApplication/OpenGL/clean_all.sh

Alternatively, you can use the makefile corresponding to a specific library:

  • [SpeedTree SDK]/SDK/Source/Core/Linux/Makefile
  • [SpeedTree SDK]/SDK/Source/Forest/Linux/Makefile
  • [SpeedTree SDK]/SDK/Source/RenderInterface/Linux/Makefile
  • [SpeedTree SDK]/SDK/Source/Renderers/OpenGL/Makefile
  • [SpeedTree SDK]/SDK/Source/ReferenceApplication/OpenGL/Makefile

After the build:

  • The compiled libraries are located in [SpeedTree SDK]/SDK/Lib/Linux/.
  • The Reference Application executable is located in [SpeedTree SDK]/SDK/Bin/Linux/.

Executing the reference application

To execute the reference application with default settings, run:

[SpeedTree SDK]/SDK/Bin/Linux/runme_linux.sh

The command line options are:

File options:
 -sfc <text file>           Loads SFC (SpeedTree Forest Config) file

Window options:
 -res <width> <height>      Window resolution
 -windowed                  Makes the application run in a window
 -fullscreen                Makes the application run in fullscreen mode
 -samples <count>           Multisampling configuration
 -anisotropy <value>        Set the max texture anisotropy
 -gamma <value>             Sets the screen gamma

Limitations in Linux

The Linux version of the Runtime SDK has the following limitations:

  • The Dear ImGui code in the Linux Reference Application for graphical UI or stats is currently disabled.

  • There are no Linux scripts for recompiling shaders in [SpeedTree SDK]/SampleForest/Shaders/.

  • Navigation using WASD-style controls is not as smooth as in the Windows version. Also, the Shift key for faster navigation and the Control key for slower navigation are currently disabled.