Class: Renderer

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

Implements

• Disposable

Constructors

Constructor

new Renderer(options?): Renderer;

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

Parameters

Parameter	Type
options?	DeepPartial<RendererOptions>

Returns

Renderer

Properties

Property	Modifier	Type	Defined in
options	readonly	RendererOptions	packages/minerender/src/renderer/Renderer.ts:55
DEFAULT_OPTIONS	readonly	RendererOptions	packages/minerender/src/renderer/Renderer.ts:17

Accessors

camera

Get Signature

get camera(): Camera;

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

Returns

Camera

---

composer

Get Signature

get composer(): Maybe<EffectComposer>;

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

Returns

Maybe<EffectComposer>

---

controls

Get Signature

get controls(): Maybe<OrbitControls>;

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

Renderer-owned controls, or undefined when disabled at construction or after disposal.

Returns

Maybe<OrbitControls>

---

dirty

Get Signature

get dirty(): boolean;

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

Returns

boolean

Set Signature

set dirty(dirty): void;

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

Parameters

Parameter	Type
dirty	boolean

Returns

void

---

element

Get Signature

get element(): Maybe<HTMLElement>;

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

Returns

Maybe<HTMLElement>

---

renderer

Get Signature

get renderer(): WebGLRenderer;

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

Returns

WebGLRenderer

---

scene

Get Signature

get scene(): MineRenderScene;

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

Returns

MineRenderScene

Methods

appendTo()

appendTo(element): void;

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

Parameters

Parameter	Type
element	HTMLElement

Returns

void

---

dispose()

dispose(): void;

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

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

init(): void;

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

Returns

void

---

onFrame()

onFrame(callback): () => void;

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

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

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

---

resize()

resize(width, height): void;

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

Parameters

Parameter	Type
width	number
height	number

Returns

void

---

start()

start(): void;

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

Returns

void

---

stop()

stop(): void;

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

Returns

void

---

toGLTF()

toGLTF(options?): Promise<ArrayBuffer | Record<string, any>>;

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

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

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

Returns

string

---

toPLY()

toPLY(options?): string | ArrayBuffer;

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

Parameters

Parameter	Type
options?	PLYExporterOptions

Returns

string | ArrayBuffer