Navigate the public API¶
The C++ header reference lists public include files by SnBuild module. Declaration targets link to related types the extractor can resolve. Use the search field for the selected version or the general symbol index to find overloads. The Sphinx object inventory for this version also exposes the generated declaration targets to other Sphinx projects.
Common entry points¶
RendererRuntime owns the device and canonical systems.
RenderScene holds scene objects, lights, and submission inputs.
TRenderProfile adds typed recipe and edit contracts to existing runtime handles.
OpenPBRProfile prepares the supplied realtime OpenPBR composition.
OpenUSDScene optionally adapts imported USD source into renderer-owned resources.
Versions and support scope¶
Development describes the source used to build the current manual. A dated snapshot retains the corresponding guides and declarations. Snapshots can be published without assigning an unshipped release number. Check the guide’s delivered behavior and design scope before using a feature that relies on a particular backend or provider.
The authored guides cover ownership, threading, units, and integration patterns. Their C++ examples include the source files checked by the documentation build workflow. The generated reference lists API declarations and compatibility relationships from that version’s public headers. It can include advanced module APIs that a particular product configuration has left out.