Class: NodeRenderer

Defined in: packages/minerender/src/env/node/NodeRenderer.ts:38

Renders individual frames in Node using an injected or factory-owned WebGL 2 context.

Extends

• Renderer

Constructors

Constructor

new NodeRenderer(options, surface): NodeRenderer;

Defined in: packages/minerender/src/env/node/NodeRenderer.ts:47

Uses a caller-owned surface; alpha-enabled contexts require premultipliedAlpha: true. Disposal releases renderer resources but retains the canvas and context.

Parameters

Parameter	Type
options	DeepPartial<RendererOptions>
surface	RendererSurface

Returns

NodeRenderer

Overrides

Renderer.constructor

Properties

Property	Modifier	Type	Inherited from	Defined in
options	readonly	RendererOptions	Renderer.options	packages/minerender/src/renderer/Renderer.ts:66
DEFAULT_OPTIONS	readonly	RendererOptions	Renderer.DEFAULT_OPTIONS	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

Inherited from

Renderer.camera

---

composer

Get Signature

get composer(): Maybe<EffectComposer>;

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

Returns

Maybe<EffectComposer>

Inherited from

Renderer.composer

---

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

Maybe<RendererControls>

Inherited from

Renderer.controls

---

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

Maybe<ControlsMode>

Inherited from

Renderer.controlsMode

---

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

Inherited from

Renderer.dirty

---

element

Get Signature

get element(): Maybe<HTMLElement>;

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

Returns

Maybe<HTMLElement>

Inherited from

Renderer.element

---

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

Maybe<FlyControls>

Inherited from

Renderer.flyControls

---

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

Maybe<OrbitControls>

Inherited from

Renderer.orbitControls

---

renderer

Get Signature

get renderer(): WebGLRenderer;

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

Returns

WebGLRenderer

Inherited from

Renderer.renderer

---

scene

Get Signature

get scene(): MineRenderScene;

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

Returns

MineRenderScene

Inherited from

Renderer.scene

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

Inherited from

Renderer.appendTo

---

dispose()

dispose(): void;

Defined in: packages/minerender/src/env/node/NodeRenderer.ts:180

Releases renderer resources and destroys contexts created by create.

Returns

void

Overrides

Renderer.dispose

---

init()

init(): void;

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

Returns

void

Inherited from

Renderer.init

---

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

Inherited from

Renderer.onFrame

---

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

Inherited from

Renderer.registerEventDispatcher

---

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

Inherited from

Renderer.renderOnce

---

renderToBuffer()

renderToBuffer(options?): Promise<Buffer>;

Defined in: packages/minerender/src/env/node/NodeRenderer.ts:109

Draws and returns a PNG with straight alpha, including while stopped. Frame callbacks are not invoked.

Parameters

Parameter	Type
options	NodeImageOptions

Returns

Promise<Buffer>

---

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

Inherited from

Renderer.resize

---

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

Maybe<RendererControls>

Inherited from

Renderer.setControlsMode

---

start()

start(): never;

Defined in: packages/minerender/src/env/node/NodeRenderer.ts:170

Node renderers draw on demand. Use renderOnce or renderToBuffer.

Returns

never

Overrides

Renderer.start

---

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

Inherited from

Renderer.stop

---

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

Inherited from

Renderer.toGLTF

---

toImage()

toImage(
   _trim?, 
   _mime?, 
   _quality?
): never;

Defined in: packages/minerender/src/env/node/NodeRenderer.ts:175

Node image capture returns encoded bytes through renderToBuffer.

Parameters

Parameter	Type	Default value
_trim	boolean	false
_mime	string	"image/png"
_quality?	number	undefined

Returns

never

Overrides

Renderer.toImage

---

toObj()

toObj(): string;

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

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

Returns

string

Inherited from

Renderer.toObj

---

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

Inherited from

Renderer.toPLY

---

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>

Inherited from

Renderer.toVideo

---

create()

static create(options): Promise<NodeRenderer>;

Defined in: packages/minerender/src/env/node/NodeRenderer.ts:55

Creates an owned native context through the optional gl package. Dimensions are in logical pixels. Native antialiasing is unavailable; increase render.pixelRatio for a larger output image.

Parameters

Parameter	Type
options	NodeRendererOptions

Returns

Promise<NodeRenderer>