Class AbstractRenderer`Abstract`

Base class for all renderer implementations.

Backends are expected to implement defensive rendering strategies to prevent "silent failures":

Validate that all uniforms defined in a material's layout are actually present in the compiled shader.
Log warnings or errors if expected data structures (e.g., WebGPU uniform blocks) are missing or misaligned.
Provide fallback values or behaviors if specific features (like rounded rects) are not supported by the hardware.

Hierarchy (View Summary)

AbstractRenderer
- WebGPURenderer
- AbstractWebGLRenderer

Implements

Renderer

Index

Constructors

constructor

new AbstractRenderer(context?: RendererContext): AbstractRenderer
Parameters
- context: RendererContext = ...
Returns AbstractRenderer
- Defined in renderers/AbstractRenderer.ts:71

Properties

`Protected`_clearColor

_clearColor: Color = ...

The clear color of the renderer.

`Protected`_lightData

_lightData: LightDataInterface = ...

Cached light data to avoid GC pressure.

`Protected`_quality

_quality: QualityConfig = ...

Global quality settings.

`Readonly`context

context: RendererContext

Per-instance bundle of DeviceCaps/ShaderRegistry/AssetManager -- see RendererContext.

`Optional`onContextLost

onContextLost?: (info: { message?: string; reason?: string }) => void

Optional callback triggered when the GPU context is lost.

postProcessing

postProcessing: PostProcessingGroup = ...

The global post processing volume/group.

`Abstract` `Readonly`type

type: RendererType

The type of the renderer.

Accessors

clearColor

get clearColor(): Color
Gets the clear color of the renderer.

Returns Color
Implementation of Renderer.clearColor
- Defined in renderers/AbstractRenderer.ts:112

isContextLost

get isContextLost(): boolean
Whether the underlying GPU context has been lost.

Returns boolean
Implementation of Renderer.isContextLost
- Defined in renderers/AbstractRenderer.ts:52

quality

get quality(): QualityConfig
Gets the global quality settings of the renderer.

Returns QualityConfig
Implementation of Renderer.quality
- Defined in renderers/AbstractRenderer.ts:117

Methods

applyPendingOcclusionResults

applyPendingOcclusionResults(_scene: Scene): void
Applies the previous frame's Hierarchical-Z occlusion culling results (if ready) by setting occlusionCulled on the tested objects. Called once per frame, before FrustumCuller.cull(). WebGPU-only (see docs/adr/0008-hzb-occlusion-culling-webgpu-only.md); a no-op on WebGL1/WebGL2 and whenever occlusion culling isn't enabled.
Parameters
- _scene: Scene
Returns void
Implementation of Renderer.applyPendingOcclusionResults
- Defined in renderers/AbstractRenderer.ts:102

destroy

destroy(): void
Destroys the renderer and releases its resources.

Returns void
Implementation of Renderer.destroy
- Defined in renderers/AbstractRenderer.ts:97

extractLights

extractLights(scene: Scene): LightDataInterface
Extracts all lights from the scene for rendering.
Parameters
- scene: Scene
  The scene to extract lights from.
Returns LightDataInterface
An object containing all extracted light data.
- Defined in renderers/AbstractRenderer.ts:126

`Abstract`initialize

initialize(
    canvas: HTMLCanvasElement,
    attributes?: Record<string, unknown>,
    config?: EngineOptions,
): Promise<void>
Initializes the renderer.
Parameters
- canvas: HTMLCanvasElement
- Optionalattributes: Record<string, unknown>
- Optionalconfig: EngineOptions
Returns Promise<void>
Implementation of Renderer.initialize
- Defined in renderers/AbstractRenderer.ts:76

`Abstract`render

render(scene: Scene, vpMatrix: Float32Array, camPos?: Vector3D): void
Renders a scene.
Parameters
- scene: Scene
- vpMatrix: Float32Array
- OptionalcamPos: Vector3D
Returns void
Implementation of Renderer.render
- Defined in renderers/AbstractRenderer.ts:83

setClearColor

setClearColor(color: Color): void
Sets the clear color of the renderer.
Parameters
- color: Color
Returns void
Implementation of Renderer.setClearColor
- Defined in renderers/AbstractRenderer.ts:107

`Abstract`setRenderTarget

setRenderTarget(
target: RenderTarget | RenderTargetCube | null,
activeCubeFace?: number,
): void
Sets the active render target for off-screen rendering. If null, the renderer targets the screen/post-processing buffer.
Parameters
- target: RenderTarget | RenderTargetCube | null
  The target to render into.
- OptionalactiveCubeFace: number
  Optional. Which face (0-5) of the RenderTargetCube to render into.
Returns void
Implementation of Renderer.setRenderTarget
- Defined in renderers/AbstractRenderer.ts:89

`Abstract`setSize

setSize(width: number, height: number): void
Sets the size of the render viewport.
Parameters
- width: number
- height: number
Returns void
Implementation of Renderer.setSize
- Defined in renderers/AbstractRenderer.ts:86

Class AbstractRendererAbstract

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns AbstractRenderer

Properties

Protected_clearColor

Protected_lightData

Protected_quality

Readonlycontext

OptionalonContextLost

postProcessing

Abstract Readonlytype

Accessors

clearColor

Returns Color

isContextLost

Returns boolean

quality

Returns QualityConfig

Methods

applyPendingOcclusionResults

Parameters

Returns void

destroy

Returns void

extractLights

Parameters

Returns LightDataInterface

Abstractinitialize

Parameters

Returns Promise<void>

Abstractrender

Parameters

Returns void

setClearColor

Parameters

Returns void

AbstractsetRenderTarget

Parameters

Returns void

AbstractsetSize

Parameters

Returns void

Settings

On This Page

Class AbstractRenderer`Abstract`

`Protected`_clearColor

`Protected`_lightData

`Protected`_quality

`Readonly`context

`Optional`onContextLost

`Abstract` `Readonly`type

`Abstract`initialize

`Abstract`render

`Abstract`setRenderTarget

`Abstract`setSize