Interface RenderTarget

Public render-target surface with no native WebGL or WebGPU handles.

interface RenderTarget {
    backend: RendererBackend;
    colorAttachmentCount: number;
    colorFormats: readonly RenderTargetColorFormat[];
    depthStencilFormat: RenderTargetDepthStencilFormat | null;
    height: number;
    isDestroyed: boolean;
    label: string;
    sampleCount: RenderTargetSampleCount;
    width: number;
    destroy(): void;
    getColorTexture(index?: number): Texture<unknown>;
    getDepthTexture(): Texture<unknown> | null;
    readColorAttachment(
        options?: RenderTargetReadColorAttachmentOptions,
    ): Promise<RenderTargetColorAttachmentReadback>;
    resize(width: number, height: number): void;
}

Index

Properties

backend colorAttachmentCount colorFormats depthStencilFormat height isDestroyed label sampleCount width

Methods

destroy getColorTexture getDepthTexture readColorAttachment resize

Properties

`Readonly`backend

backend: RendererBackend

`Readonly`colorAttachmentCount

colorAttachmentCount: number

`Readonly`colorFormats

colorFormats: readonly RenderTargetColorFormat[]

`Readonly`depthStencilFormat

depthStencilFormat: RenderTargetDepthStencilFormat | null

`Readonly`height

height: number

`Readonly`isDestroyed

isDestroyed: boolean

`Readonly`label

label: string

`Readonly`sampleCount

sampleCount: RenderTargetSampleCount

`Readonly`width

width: number

Methods

destroy

destroy(): void
Returns void
- Defined in render/RenderTarget.ts:116

getColorTexture

getColorTexture(index?: number): Texture<unknown>
Stable attachment identity for this target's lifetime, including resize and recovery.
Parameters
- Optionalindex: number
Returns Texture<unknown>
- Defined in render/RenderTarget.ts:109

getDepthTexture

getDepthTexture(): Texture<unknown> | null
Stable sampled-depth identity for this target's lifetime, including resize and recovery.

Returns Texture<unknown> | null
- Defined in render/RenderTarget.ts:111

readColorAttachment

readColorAttachment(
options?: RenderTargetReadColorAttachmentOptions,
): Promise<RenderTargetColorAttachmentReadback>
Parameters
- Optionaloptions: RenderTargetReadColorAttachmentOptions
Returns Promise<RenderTargetColorAttachmentReadback>
- Defined in render/RenderTarget.ts:112

resize

resize(width: number, height: number): void
Parameters
- width: number
- height: number
Returns void
- Defined in render/RenderTarget.ts:115