Documentation

SpeedTree Runtime SDK

Version: 10

SpeedTree Runtime SDK

Version: 10

Usage and controls

Learn about the reference application's configuration options and interactive controls.
Read time 1 minuteLast updated 2 hours ago

The reference application has a wide range of options for both up-front user configuration and interactive features to be used as the forest is rendering.
Navigation on a PC is handled with the standard WASD + mouse navigation. Press and hold the middle mouse button for free-look mode. Use the right mouse button to raise and lower the camera (must deactivate terrain following). Other navigation-related keys include:

Key

Behavior

ControlHold to move more slowly
ShiftHold to move more quickly
SpaceToggle terrain following
CToggle collision (will allow the camera to move through the terrain if terrain following off)
Note
Navigation in the Linux version of the reference application has some limitations.

Keyboard shortcuts

There are numerous keyboard shortcuts that can be used to adjust the scene and rendering style on the fly. This list will print in the console when the application starts.

Key

Behavior

~ (tilde)Toggle output console
OToggle control panel
PToggle performance panel
TToggle 3D tree geometry
BToggle billboard geometry
LToggle terrain (think "Land")
GToggle grass
YToggle sky
QPrint resource usage to console
XPrint CPU timing report, if enabled during compile
V (+ mouse motion)Move sun position
F (+ mouse motion)Change wind direction (think "Fan")
0-9Go to preset camera position
Shift + 0-9Record preset camera position
Ctrl + RGo in camera demo mode
ESCQuit/exit

Command-line options

If you run the reference application with "-help" it will print the extensive command-line options to the console.