StringTune/Docs

API Reference

RenderState

Internal holder for external render-context references such as Three.js instances.

RenderState

RenderState is a very small render-context holder.

Public status

RenderState lives in src/states and is mainly runtime reference.

Current field

  • threeInstance

What it is for

It exists so render-engine integrations can keep a shared render-context reference inside the broader runtime state model.

Practical note

In the current built-in module set, this state is much less central than:

  • scroll
  • viewport
  • cursor
  • time

So most users will only care about it if they are wiring custom render-engine behavior into StringTune.