Documentation

SpeedTree Runtime SDK

Version: 10

SpeedTree Runtime SDK

Version: 10

Introduction to the Core library

Core is the lowest level library, providing the most basic functionality.
Read time 1 minuteLast updated 2 hours ago

The Core library is written in C++ and is graphics-API independent. It offers the following functionality:
  • Parses .stsdk files generated by the SpeedTree Modeler application, which store the complete definition of a SpeedTree games model, including the following:
  • Provides an interface for retrieving the tree file data.
  • Defines a callback system for tracking heap allocations/deletions, file operations, and error messaging.
  • Computes LOD values needed to render LOD states (and constants that are uploaded to the wind shaders) that match those set by the artist in the Modeler.
  • Provides access to a wind class that controls the wind animation parameters uploaded to the wind shaders.
  • Allows an alternate coordinate systems to be set using the
    CCoordSys
    class defined in the Core library.
  • Defines a number of basic mathematical and utility classes that are used throughout the Runtime SDK.
The Forest library is the next highest level library. It depends directly on Core and deals with collections of Core objects in order to build and manage an entire dynamic forest.