API Reference
ThreeStart
The entry point. Bootstraps the scene, registers modules, and wires everything together.
ThreeStart is the entry point of every three-start project. It creates a ThreeContext, accepts ContextModule instances, and bootstraps the entire scene in a defined order when start() is called.
import { ThreeStart } from "three-start";
const starter = new ThreeStart();
starter.addModules({ ... });
starter.start();
starter.mount(document.getElementById("three")!);addModules() must be called before start(). Modules participate in the bootstrap lifecycle (onAwake → onStart), so registering after start() throws.
mount() / unmount() can be called any number of times across the instance's lifetime — by default each pair starts and stops the render loop automatically. Pass manageLoopManually: true in ThreeStartOptions to disable this and control the loop yourself via runLoop() / stopLoop().
Initialization
new ThreeStart(options?: ThreeStartOptions)ThreeStartOptions
Prop
Type
Properties
Prop
Type
Methods
Prop
Type