Class RenderContext

Static ReadonlyDEFAULT_DEPTH_FORMAT

Readonlydevice

Readonlyqueue

Readonlycontext

Readonlyformat

ReadonlydepthFormat

Readonlycanvas

Readonlyhdr

ReadonlyenableErrorHandling

ReadonlyshaderBlockManager

ReadonlyxrCompatible

ReadonlymaxPixelRatio

ReadonlyreversedZ

activeCamera

elapsedTime

deltaTime

frameCount

framesPerSecond

fps

width

• get width(): number

  Backing canvas pixel width (or the XR render-size override when set).

  Returns number

height

• get height(): number

  Backing canvas pixel height (or the XR render-size override when set).

  Returns number

depthClearValue

• get depthClearValue(): number

  Depth value the main camera's depth buffer clears to: the FAR plane. 0 under reversed-Z (far→0), 1 under standard-Z. Use this for depth attachment clearValue/depthClearValue so a pass works in either mode.

  Returns number

backbufferTexture

• get backbufferTexture(): GPUTexture

  Returns the swap chain texture for the current frame.

  Returns GPUTexture

backbufferView

• get backbufferView(): GPUTextureView

  Returns the swap chain texture view for the current frame.

  Returns GPUTextureView

backbufferDepth

• get backbufferDepth(): GPUTexture | null

  Returns the depth texture for the current frame, or null if depth is not enabled.

  Returns GPUTexture | null

backbufferDepthView

• get backbufferDepthView(): GPUTextureView | null

  Returns the depth texture view for the current frame, or null if depth is not enabled.

  Returns GPUTextureView | null

setRenderSizeOverride

• setRenderSizeOverride(size: { width: number; height: number } | null): void

  Override the reported render size (see _renderSizeOverride); pass null to revert to the canvas backing-store size. Used by the engine's WebXR driver per eye.

  Parameters

  • size: { width: number; height: number } | null

  Returns void

depthCompare

• depthCompare(standard: GPUCompareFunction): GPUCompareFunction

  Maps a standard-Z depth-compare function to the equivalent under the active mode. Under reversed-Z, "nearer" is a GREATER depth, so 'less'→'greater' and 'less-equal'→'greater-equal'; other functions pass through. Pass the standard-Z function you'd normally use; the result is what the pipeline should use.

  Parameters

  • standard: GPUCompareFunction

  Returns GPUCompareFunction

update

• update(): boolean

  Call each frame to detect canvas resizes and update the backbuffer depth texture accordingly.

  Also updates deltaTime, elapsedTime, frameCount, framesPerSecond and fps.

  Returns boolean

  true if a resize was detected and handled, false otherwise.

Staticcreate

• create(
      canvas: HTMLCanvasElement,
      options?: RenderContextOptions,
  ): Promise<RenderContext>

  Requests a WebGPU adapter and device, configures the canvas swap chain and returns a ready-to-use context.

  Attempts an HDR (rgba16float + display-p3 + extended tonemapping) swap chain and falls back to the preferred SDR format if unsupported.

  Parameters

  • canvas: HTMLCanvasElement

    canvas to bind the swap chain to

  • options: RenderContextOptions = {}

    optional context configuration

  Returns Promise<RenderContext>

  initialized render context

  Throws

  if WebGPU is unavailable or no adapter can be acquired

StaticcreateShared

• createShared(
      canvas: HTMLCanvasElement,
      base: RenderContext,
      options?: RenderContextOptions,
  ): Promise<RenderContext>

  Build a second RenderContext for another canvas that SHARES the GPU device of an existing context, rather than requesting a fresh adapter/device.

  WebGPU allows one device to drive multiple canvas contexts, and GPU resources (buffers, textures) are only usable on the device that created them — so a picture-in-picture / preview canvas that renders an already-loaded scene MUST share the primary context's device. Use this for any secondary view of a scene whose GPU resources live on base.

  Reuses base's surface format and HDR flag so the two contexts are pipeline-compatible (render pipelines are keyed on the surface format).

  Parameters

  • canvas: HTMLCanvasElement
  • base: RenderContext
  • options: RenderContextOptions = {}

  Returns Promise<RenderContext>

createShaderModule

• createShaderModule(
      code: string,
      label?: string,
      defines?: Record<string, string>,
  ): GPUShaderModule

  Creates a GPU shader module from the provided WGSL code.

  Parameters

  • code: string

    WGSL shader code

  • Optionallabel: string

    optional debug label

  • Optionaldefines: Record<string, string>

    optional preprocessor defines for shader block imports

  Returns GPUShaderModule

  GPUShaderModule instance

registerShaderBlock

• registerShaderBlock(name: string, code: string): void

  Registers a shader block for later use in shader modules.

  Parameters

  • name: string

    unique identifier for the shader block

  • code: string

    WGSL code of the shader block

  Returns void

removeShaderBlock

• removeShaderBlock(name: string): void

  Removes a previously registered shader block by name.

  Parameters

  • name: string

    name of the shader block to remove

  Returns void

getShaderBlock

• getShaderBlock(name: string, defines?: Record<string, string>): string

  Retrieves the WGSL code for a registered shader block by name.

  Parameters

  • name: string

    name of the shader block

  • Optionaldefines: Record<string, string>

  Returns string

  WGSL code of the shader block, or a placeholder comment if not found

createBuffer

• createBuffer(size: number, usage: number, label?: string): GPUBuffer

  Convenience wrapper around device.createBuffer.

  Parameters

  • size: number

    buffer size in bytes

  • usage: number

    usage flags

  • Optionallabel: string

    optional debug label

  Returns GPUBuffer

writeBuffer

• writeBuffer(
      buffer: GPUBuffer,
      data: ArrayBuffer | ArrayBufferView<ArrayBufferLike>,
      offset?: number,
  ): void

  Uploads CPU data into a GPU buffer, handling both ArrayBuffer and typed-array sources.

  Parameters

  • buffer: GPUBuffer

    destination GPU buffer

  • data: ArrayBuffer | ArrayBufferView<ArrayBufferLike>

    source bytes to copy

  • offset: number = 0

    destination byte offset

  Returns void

pushInitErrorScope

• pushInitErrorScope(): void

  Pushes a validation error scope used during one-time resource initialization. No-op when error handling is disabled.

  Returns void

popInitErrorScope

• popInitErrorScope(label: string): Promise<void>

  Pops the matching init error scope and logs any validation failure.

  Parameters

  • label: string

    identifier included in the log message

  Returns Promise<void>

pushFrameErrorScope

• pushFrameErrorScope(): void

  Pushes a per-frame validation error scope. No-op when error handling is disabled.

  Returns void

popFrameErrorScope

• popFrameErrorScope(): Promise<void>

  Pops the matching per-frame error scope and logs any validation failure.

  Returns Promise<void>

pushPassErrorScope

• pushPassErrorScope(_passName: string): void

  Pushes nested validation, out-of-memory and internal error scopes around a single render pass. No-op when error handling is disabled.

  Parameters

  • _passName: string

    pass identifier (currently unused; reserved for diagnostics)

  Returns void

popPassErrorScope

• popPassErrorScope(passName: string): Promise<void>

  Pops the three pass-level error scopes pushed by pushPassErrorScope and logs any captured errors.

  Parameters

  • passName: string

    pass identifier included in log messages

  Returns Promise<void>

createDefaultCubemap

• createDefaultCubemap(): GPUTexture

  Convenience method to create a 1x1 cubemap texture with a neutral gray color, used as a fallback when IBL textures fail to load.

  Returns GPUTexture

createDefaultBrdfLUT

• createDefaultBrdfLUT(): GPUTexture

  Convenience method to create a 1x1 BRDF LUT texture with a neutral value, used as a fallback when IBL textures fail to load.

  Returns GPUTexture