Class: Renderer
Defined in: packages/minerender/src/renderer/Renderer.ts:25
Renders a Minecraft scene with a camera and an optional effects composer. Uses a browser canvas by default, or a caller-supplied RendererSurface. Call start for browser animation or renderOnce for a single frame.
Extended by
Implements
Constructors
Constructor
new Renderer(options?, surface?): Renderer;Defined in: packages/minerender/src/renderer/Renderer.ts:102
Parameters
| Parameter | Type |
|---|---|
options? | DeepPartial<RendererOptions> |
surface? | RendererSurface |
Returns
Renderer
Properties
| Property | Modifier | Type | Defined in |
|---|---|---|---|
options | readonly | RendererOptions | packages/minerender/src/renderer/Renderer.ts:66 |
DEFAULT_OPTIONS | readonly | RendererOptions | packages/minerender/src/renderer/Renderer.ts:27 |
Accessors
camera
Get Signature
get camera(): Camera;Defined in: packages/minerender/src/renderer/Renderer.ts:709
Returns
Camera
composer
Get Signature
get composer(): Maybe<EffectComposer>;Defined in: packages/minerender/src/renderer/Renderer.ts:717
Returns
Maybe<EffectComposer>
controls
Get Signature
get controls(): Maybe<RendererControls>;Defined in: packages/minerender/src/renderer/Renderer.ts:722
Renderer-owned controls, or undefined when disabled at construction or after disposal.
Returns
controlsMode
Get Signature
get controlsMode(): Maybe<ControlsMode>;Defined in: packages/minerender/src/renderer/Renderer.ts:737
The active renderer-owned controls mode, or undefined without controls.
Returns
dirty
Get Signature
get dirty(): boolean;Defined in: packages/minerender/src/renderer/Renderer.ts:474
Returns
boolean
Set Signature
set dirty(dirty): void;Defined in: packages/minerender/src/renderer/Renderer.ts:478
Parameters
| Parameter | Type |
|---|---|
dirty | boolean |
Returns
void
element
Get Signature
get element(): Maybe<HTMLElement>;Defined in: packages/minerender/src/renderer/Renderer.ts:392
Returns
Maybe<HTMLElement>
flyControls
Get Signature
get flyControls(): Maybe<FlyControls>;Defined in: packages/minerender/src/renderer/Renderer.ts:732
Renderer-owned FlyControls, or undefined in orbit mode or without controls.
Returns
orbitControls
Get Signature
get orbitControls(): Maybe<OrbitControls>;Defined in: packages/minerender/src/renderer/Renderer.ts:727
Renderer-owned OrbitControls, or undefined in fly mode or without controls.
Returns
renderer
Get Signature
get renderer(): WebGLRenderer;Defined in: packages/minerender/src/renderer/Renderer.ts:713
Returns
WebGLRenderer
scene
Get Signature
get scene(): MineRenderScene;Defined in: packages/minerender/src/renderer/Renderer.ts:705
Returns
Methods
appendTo()
appendTo(element): void;Defined in: packages/minerender/src/renderer/Renderer.ts:397
Attaches the canvas to an element and sizes it to that element's dimensions.
Parameters
| Parameter | Type |
|---|---|
element | HTMLElement |
Returns
void
dispose()
dispose(): void;Defined in: packages/minerender/src/renderer/Renderer.ts:532
Stops rendering and releases owned resources. Repeated calls have no effect, and a disposed renderer cannot be restarted. Scene objects are detached; shared assets and caller-owned controls must be managed by their owners.
Returns
void
Implementation of
init()
init(): void;Defined in: packages/minerender/src/renderer/Renderer.ts:339
Returns
void
onFrame()
onFrame(callback): () => void;Defined in: packages/minerender/src/renderer/Renderer.ts:488
Calls a synchronous animation update before each FPS-limited draw while started. Subscriptions keep the scene drawing without manual dirty flags. Returns an unsubscribe function. Registering the same callback twice has no effect. Image exports do not invoke callbacks.
Parameters
| Parameter | Type |
|---|---|
callback | FrameCallback |
Returns
() => void
registerEventDispatcher()
registerEventDispatcher(dispatcher, changeEvent?): void;Defined in: packages/minerender/src/renderer/Renderer.ts:415
Redraws when the dispatcher emits the selected event. Registering the same pair twice has no effect. The renderer removes its listener on disposal; the caller retains ownership of the dispatcher.
Parameters
| Parameter | Type | Default value |
|---|---|---|
dispatcher | EventDispatcher<any> | undefined |
changeEvent | string | 'change' |
Returns
void
renderOnce()
renderOnce(): void;Defined in: packages/minerender/src/renderer/Renderer.ts:626
Draws a fresh frame without starting the animation loop or invoking frame callbacks.
Returns
void
resize()
resize(width, height): void;Defined in: packages/minerender/src/renderer/Renderer.ts:437
Updates the camera and canvas size. Width and height are in CSS pixels.
Parameters
| Parameter | Type |
|---|---|
width | number |
height | number |
Returns
void
setControlsMode()
setControlsMode(mode): Maybe<RendererControls>;Defined in: packages/minerender/src/renderer/Renderer.ts:293
Replaces renderer-owned controls with the selected mode, keeping the camera where it is. Switching to orbit controls targets the point the camera looks at, at the previous orbit distance. The previous controls object is disposed, so its listeners and settings do not carry over. Returns the new controls, or undefined when controls were disabled at construction or after disposal.
Parameters
| Parameter | Type |
|---|---|
mode | ControlsMode |
Returns
start()
start(): void;Defined in: packages/minerender/src/renderer/Renderer.ts:498
Starts or resumes the animation loop and registered frame callbacks. Has no effect while running.
Returns
void
stop()
stop(): void;Defined in: packages/minerender/src/renderer/Renderer.ts:507
Pauses rendering and frame callbacks, and cancels video export. Call start to resume.
Returns
void
toGLTF()
toGLTF(options?): Promise<ArrayBuffer | Record<string, any>>;Defined in: packages/minerender/src/renderer/Renderer.ts:687
Exports a static textured scene in the browser. Set options.binary for GLB output.
Parameters
| Parameter | Type |
|---|---|
options? | SceneGLTFExportOptions |
Returns
Promise<ArrayBuffer | Record<string, any>>
toImage()
toImage(
trim?,
mime?,
quality?
): string;Defined in: packages/minerender/src/renderer/Renderer.ts:637
Renders a fresh frame and returns an image data URL, including while the animation loop is stopped. Trimming removes transparent borders; an empty image becomes one transparent pixel. MIME type support and lossy quality (0–1) follow the canvas encoder.
Parameters
| Parameter | Type | Default value |
|---|---|---|
trim | boolean | false |
mime | string | "image/png" |
quality? | number | undefined |
Returns
string
toObj()
toObj(): string;Defined in: packages/minerender/src/renderer/Renderer.ts:677
Exports visible scene meshes as OBJ text, without texture images.
Returns
string
toPLY()
toPLY(options?): string | ArrayBuffer;Defined in: packages/minerender/src/renderer/Renderer.ts:682
Exports visible scene meshes as PLY. Set options.binary for an ArrayBuffer.
Parameters
| Parameter | Type |
|---|---|
options? | PLYExporterOptions |
Returns
string | ArrayBuffer
toVideo()
toVideo(options): Promise<Blob>;Defined in: packages/minerender/src/renderer/Renderer.ts:652
Records a silent browser video in real time, including frame callbacks and animated textures. Keep the tab visible; browser scheduling and render.fpsLimit limit the capture rate. The video keeps the initial drawing-buffer size and fills transparent pixels with black. Temporarily starts a stopped renderer. Stop, disposal, or options.signal cancels the export. Only one export can run at a time. Use the returned Blob's type to select a file extension.
Parameters
| Parameter | Type |
|---|---|
options | VideoExportOptions |
Returns
Promise<Blob>