StringTune-3D/Docs

API Reference

String3D Module

Public module API for provider setup, font registration, settings, and StringTune integration.

Type
API reference
Status
Stable
Scope
Global
Activation
stringTune.use(String3D)

String3D Module

String3D is the main integration export.

Public API

Static methods

  • String3D.setProvider(provider)
  • String3D.getInstance()
  • String3D.registerFont(name, url, options?)
  • String3D.setDefaultFont(name)

Settings

The runtime reads these module settings from StringTune:

  • hideHTML
  • container
  • zIndex
  • modelLoaderType
  • modelLoader
  • modelLoaderFactory
  • useDirtySync
  • styleReadIntervalMs
  • layoutReadIntervalMs

Detailed Behavior

  • onInit() exits early if no provider has been registered.
  • onSettingsChange() re-applies sync-related settings without rebuilding the whole runtime.
  • destroy() tears down the renderer, scene, filter state, and injected stylesheet.