Skip to main content

Class: NullRenderer

Defined in: src/core/NullRenderer.ts:13

No-op renderer for headless mode. Drop-in replacement for Renderer that performs no actual rendering. Used when Scene is created with { headless: true } or via Scene.createHeadless().

  • render() and dispose() are no-ops; resize() updates in-memory dimensions
  • getCanvas() and getThreeRenderer() throw with descriptive errors
  • Width, height, colors are stored in memory for scene logic

Implements​

Constructors​

Constructor​

new NullRenderer(options): NullRenderer

Defined in: src/core/NullRenderer.ts:23

Create a NullRenderer with optional dimensions and colors.

Parameters​

options​

Configuration options (defaults: 800x450, black background)

backgroundColor?​

string

backgroundOpacity?​

number

height?​

number

width?​

number

Returns​

NullRenderer

Accessors​

backgroundColor​

Get Signature​

get backgroundColor(): Color

Defined in: src/core/NullRenderer.ts:46

Returns​

Color

Set Signature​

set backgroundColor(color): void

Defined in: src/core/NullRenderer.ts:49

Parameters​
color​

string | Color

Returns​

void

Implementation of​

IRenderer.backgroundColor

backgroundOpacity​

Get Signature​

get backgroundOpacity(): number

Defined in: src/core/NullRenderer.ts:52

Returns​

number

Set Signature​

set backgroundOpacity(value): void

Defined in: src/core/NullRenderer.ts:55

Parameters​
value​

number

Returns​

void

Implementation of​

IRenderer.backgroundOpacity

height​

Get Signature​

get height(): number

Defined in: src/core/NullRenderer.ts:43

Returns​

number

Implementation of​

IRenderer.height

isContextLost​

Get Signature​

get isContextLost(): boolean

Defined in: src/core/NullRenderer.ts:37

Returns​

boolean

Implementation of​

IRenderer.isContextLost

width​

Get Signature​

get width(): number

Defined in: src/core/NullRenderer.ts:40

Returns​

number

Implementation of​

IRenderer.width

Methods​

dispose()​

dispose(): void

Defined in: src/core/NullRenderer.ts:78

Returns​

void

Implementation of​

IRenderer.dispose

getCanvas()​

getCanvas(): HTMLCanvasElement

Defined in: src/core/NullRenderer.ts:67

Always throws — canvas is not available in headless mode.

Returns​

HTMLCanvasElement

Implementation of​

IRenderer.getCanvas

getThreeRenderer()​

getThreeRenderer(): WebGLRenderer

Defined in: src/core/NullRenderer.ts:73

Always throws — WebGL renderer is not available in headless mode.

Returns​

WebGLRenderer

Implementation of​

IRenderer.getThreeRenderer

render()​

render(_scene, _camera): void

Defined in: src/core/NullRenderer.ts:59

Parameters​

_scene​

Scene

_camera​

Camera

Returns​

void

Implementation of​

IRenderer.render

resize()​

resize(width, height): void

Defined in: src/core/NullRenderer.ts:62

Parameters​

width​

number

height​

number

Returns​

void

Implementation of​

IRenderer.resize