User Tools

Site Tools

API Overview

The SpeedTree Engine API is contained completely in the relatively compact speedtree_engine.h header file which has no external dependencies. That is, it includes no other header files.

The library API is written in C and since C does not support namespaces, all data types and functions are prefixed with “Ste” (STE for SpeedTree Engine).

The API functions are declared at the end of the header file and are organized into a few different groups:

  • Startup functions for licensing, creating new objects, and setting up a message port from the library to the host application.
  • Functions for loading and computing STE files.
  • Functions for querying geometry, changing seeds and seasons, animating wind and growth, and providing other details about the loaded tree model.