StringTune-3D/Docs

API Reference

Provider API

The I3DEngineProvider contract and the default ThreeJSProvider implementation exported by the package.

Type
API reference
Status
Stable
Scope
API only
Activation
String3D.setProvider(new ThreeJSProvider(...))

Provider API

The provider boundary keeps the runtime renderer-agnostic.

Core contract

An I3DEngineProvider can expose:

  • initialize()
  • getEngine()
  • getName()
  • getBackend()
  • getCapabilities()

Default implementation

ThreeJSProvider is the packaged implementation for three.

Practical rule

  • If you only use Three.js, use ThreeJSProvider.
  • If you want another backend, implement I3DEngineProvider and the matching I3DEngine.
Related
Three.js ProviderModel LoadingEngine Abstraction
Previous← String3D ModuleNextScene Runtime →