For the complete documentation index, see llms.txt. This page is also available as Markdown.

Instance Renderer

Renders a scene-backed instance with Flora.

The FloraInstanceRenderer is a component that enables Flora rendering for a scene object with a LODGroup or MeshRenderer. A prefab reference is optional; the scene object supplies the render definition and owns the registered instance.

Adding this component to the root object automatically registers it with the FloraSystem and renders the instance using GPU instancing.

Disabling or removing the component will:

  • Unregister the instance from Flora

  • Reactivate Unity’s built-in MeshRenderer or LODGroup rendering path

Flora Instance Renderer component
Current Inspector in the Container Prefab sample.

Properties

InstanceHandle

When the component is active, this property holds the FloraInstanceHandle for the instance.

  • Use this handle to interact with the FloraSystem

  • If the component is disabled or destroyed, the handle becomes invalid

SpeedTreeWindProxyMode

Overrides the scene-wide SpeedTree wind sampling policy for this renderer:

  • UseSceneSettings follows FloraSceneSettings.SceneSpeedTreeWindProxyMode. This is the default.

  • PerPrototype shares wind with matching render prototypes and samples position-dependent wind at the world origin.

  • PerInstance samples wind separately for this renderer.

Performance: PerInstance creates a separate hidden wind proxy and rendering binding for every Instance Renderer using it. This reduces batching and is intended for a limited number of scene-backed trees that require position-dependent wind. Prefer PerPrototype for forests and repeated vegetation.

Changing the mode refreshes the Flora registration automatically.

SpeedTreeWindProxyAnchor

Optional transform used as the sampling position in PerInstance mode. When it is unset, Flora uses this component's transform. Moving the resolved anchor moves the hidden wind proxy.

Last updated