Interface RendererContract

Public backend-neutral renderer contract used by Stage and scene resources.

interface RendererContract {
    backend: RendererBackend;
    className: string;
    clearColor: Color;
    domElement: HTMLCanvasElement | null;
    forceMaterial: Material | null;
    height: number;
    isReady: boolean;
    lightManager: LightManager;
    pixelRatio: number;
    ready: Promise<void>;
    renderInfo: RenderInfo;
    renderTarget: RenderTarget | null;
    resourceManager: RendererResourceManager;
    useInstanced: boolean;
    width: number;
    createRenderTarget(parameters: RenderTargetParameters): RenderTarget;
    createStorageBuffer(
        descriptor: Readonly<StorageBufferDescriptor>,
    ): StorageBuffer;
    destroy(): void;
    getExtension(name: string): object | null;
    getViewport(): RendererViewport;
    off(type?: string, listener?: EventListener): this;
    on(type: string, listener: EventListener, once?: boolean): this;
    onInit(callback: (renderer: this) => void): void;
    present(target?: RenderTarget): void;
    releaseGPUResources(): void;
    render(stage: RendererScene, camera: Camera, fireEvent?: boolean): void;
    renderFrame(callback: RendererFrameCallback): void;
    renderToTarget(
        target: RenderTarget,
        stage: RendererScene,
        camera: Camera,
        fireEvent?: boolean,
    ): void;
    resize(width: number, height: number, force?: boolean): void;
    setOffset(x: number, y: number): void;
    setRenderTarget(
        target: RenderTarget | null,
        options?: RenderTargetSelectionOptions,
    ): this;
    supportsTextureCompression(format: TextureCompressionFormat): boolean;
    waitForIdle(): Promise<void>;
}

Implemented by

Renderer

Properties

`Readonly`backend

backend: RendererBackend

`Readonly`className

className: string

clearColor

clearColor: Color

domElement

domElement: HTMLCanvasElement | null

forceMaterial

forceMaterial: Material | null

height

height: number

`Readonly`isReady

isReady: boolean

`Readonly`lightManager

lightManager: LightManager

pixelRatio

pixelRatio: number

`Readonly`ready

ready: Promise<void>

`Readonly`renderInfo

renderInfo: RenderInfo

`Readonly`renderTarget

renderTarget: RenderTarget | null

`Readonly`resourceManager

resourceManager: RendererResourceManager

useInstanced

useInstanced: boolean

width

width: number

Methods

createRenderTarget

createRenderTarget(parameters: RenderTargetParameters): RenderTarget
Parameters
- parameters: RenderTargetParameters
Returns RenderTarget
- Defined in render/RendererCore.ts:151

createStorageBuffer

createStorageBuffer(
descriptor: Readonly<StorageBufferDescriptor>,
): StorageBuffer
Create a WebGPU renderer-owned storage buffer. WebGL 2 rejects this operation.
Parameters
- descriptor: Readonly<StorageBufferDescriptor>
Returns StorageBuffer
- Defined in render/RendererCore.ts:150

destroy

destroy(): void
Returns void
- Defined in render/RendererCore.ts:167

getExtension

getExtension(name: string): object | null
Explicit opt-in access to a backend extension; unknown names return null.
Parameters
- name: string
Returns object | null
- Defined in render/RendererCore.ts:165

getViewport

getViewport(): RendererViewport
Return the viewport that numeric shader semantics use for the active render pass.

Returns RendererViewport
- Defined in render/RendererCore.ts:144

off

off(type?: string, listener?: EventListener): this
Parameters
- Optionaltype: string
- Optionallistener: EventListener
Returns this
- Defined in render/RendererCore.ts:169

on

on(type: string, listener: EventListener, once?: boolean): this
Parameters
- type: string
- listener: EventListener
- Optionalonce: boolean
Returns this
- Defined in render/RendererCore.ts:168

onInit

onInit(callback: (renderer: this) => void): void
Parameters
- callback: (renderer: this) => void
Returns void
- Defined in render/RendererCore.ts:161

present

present(target?: RenderTarget): void
Present the first color attachment of a renderer-owned target to the canvas.
Parameters
- Optionaltarget: RenderTarget
Returns void
- Defined in render/RendererCore.ts:154

releaseGPUResources

releaseGPUResources(): void
Returns void
- Defined in render/RendererCore.ts:166

render

render(stage: RendererScene, camera: Camera, fireEvent?: boolean): void
Parameters
- stage: RendererScene
- camera: Camera
- OptionalfireEvent: boolean
Returns void
- Defined in render/RendererCore.ts:145

renderFrame

renderFrame(callback: RendererFrameCallback): void
Record resource-ready renderer passes in one synchronous backend frame boundary.
Parameters
- callback: RendererFrameCallback
Returns void
- Defined in render/RendererCore.ts:147

renderToTarget

renderToTarget(
    target: RenderTarget,
    stage: RendererScene,
    camera: Camera,
    fireEvent?: boolean,
): void
Parameters
- target: RenderTarget
- stage: RendererScene
- camera: Camera
- OptionalfireEvent: boolean
Returns void
- Defined in render/RendererCore.ts:155

resize

resize(width: number, height: number, force?: boolean): void
Parameters
- width: number
- height: number
- Optionalforce: boolean
Returns void
- Defined in render/RendererCore.ts:141

setOffset

setOffset(x: number, y: number): void
Parameters
- x: number
- y: number
Returns void
- Defined in render/RendererCore.ts:142

setRenderTarget

setRenderTarget(
target: RenderTarget | null,
options?: RenderTargetSelectionOptions,
): this
Parameters
- target: RenderTarget | null
- Optionaloptions: RenderTargetSelectionOptions
Returns this
- Defined in render/RendererCore.ts:152

supportsTextureCompression

supportsTextureCompression(format: TextureCompressionFormat): boolean
Parameters
- format: TextureCompressionFormat
Returns boolean
- Defined in render/RendererCore.ts:148

waitForIdle

waitForIdle(): Promise<void>
Resolve after all work submitted before this call has completed.

Returns Promise<void>
- Defined in render/RendererCore.ts:163