Skip to content

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 ​

ts
new Renderer(options?, surface?): Renderer;

Defined in: packages/minerender/src/renderer/Renderer.ts:102

Parameters ​

ParameterType
options?DeepPartial<RendererOptions>
surface?RendererSurface

Returns ​

Renderer

Properties ​

PropertyModifierTypeDefined in
optionsreadonlyRendererOptionspackages/minerender/src/renderer/Renderer.ts:66
DEFAULT_OPTIONSreadonlyRendererOptionspackages/minerender/src/renderer/Renderer.ts:27

Accessors ​

camera ​

Get Signature ​

ts
get camera(): Camera;

Defined in: packages/minerender/src/renderer/Renderer.ts:709

Returns ​

Camera


composer ​

Get Signature ​

ts
get composer(): Maybe<EffectComposer>;

Defined in: packages/minerender/src/renderer/Renderer.ts:717

Returns ​

Maybe<EffectComposer>


controls ​

Get Signature ​

ts
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 ​

Maybe<RendererControls>


controlsMode ​

Get Signature ​

ts
get controlsMode(): Maybe<ControlsMode>;

Defined in: packages/minerender/src/renderer/Renderer.ts:737

The active renderer-owned controls mode, or undefined without controls.

Returns ​

Maybe<ControlsMode>


dirty ​

Get Signature ​

ts
get dirty(): boolean;

Defined in: packages/minerender/src/renderer/Renderer.ts:474

Returns ​

boolean

Set Signature ​

ts
set dirty(dirty): void;

Defined in: packages/minerender/src/renderer/Renderer.ts:478

Parameters ​
ParameterType
dirtyboolean
Returns ​

void


element ​

Get Signature ​

ts
get element(): Maybe<HTMLElement>;

Defined in: packages/minerender/src/renderer/Renderer.ts:392

Returns ​

Maybe<HTMLElement>


flyControls ​

Get Signature ​

ts
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 ​

Maybe<FlyControls>


orbitControls ​

Get Signature ​

ts
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 ​

Maybe<OrbitControls>


renderer ​

Get Signature ​

ts
get renderer(): WebGLRenderer;

Defined in: packages/minerender/src/renderer/Renderer.ts:713

Returns ​

WebGLRenderer


scene ​

Get Signature ​

ts
get scene(): MineRenderScene;

Defined in: packages/minerender/src/renderer/Renderer.ts:705

Returns ​

MineRenderScene

Methods ​

appendTo() ​

ts
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 ​

ParameterType
elementHTMLElement

Returns ​

void


dispose() ​

ts
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 ​

Disposable.dispose


init() ​

ts
init(): void;

Defined in: packages/minerender/src/renderer/Renderer.ts:339

Returns ​

void


onFrame() ​

ts
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 ​

ParameterType
callbackFrameCallback

Returns ​

() => void


registerEventDispatcher() ​

ts
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 ​

ParameterTypeDefault value
dispatcherEventDispatcher<any>undefined
changeEventstring'change'

Returns ​

void


renderOnce() ​

ts
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() ​

ts
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 ​

ParameterType
widthnumber
heightnumber

Returns ​

void


setControlsMode() ​

ts
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 ​

ParameterType
modeControlsMode

Returns ​

Maybe<RendererControls>


start() ​

ts
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() ​

ts
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() ​

ts
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 ​

ParameterType
options?SceneGLTFExportOptions

Returns ​

Promise<ArrayBuffer | Record<string, any>>


toImage() ​

ts
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 ​

ParameterTypeDefault value
trimbooleanfalse
mimestring"image/png"
quality?numberundefined

Returns ​

string


toObj() ​

ts
toObj(): string;

Defined in: packages/minerender/src/renderer/Renderer.ts:677

Exports visible scene meshes as OBJ text, without texture images.

Returns ​

string


toPLY() ​

ts
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 ​

ParameterType
options?PLYExporterOptions

Returns ​

string | ArrayBuffer


toVideo() ​

ts
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 ​

ParameterType
optionsVideoExportOptions

Returns ​

Promise<Blob>