Class WebGPURenderer

Modern WebGPU implementation with dynamic vertex updates and memory management.

Hierarchy (View Summary)

AbstractRenderer
- WebGPURenderer

Index

Constructors

Properties

_activeCubeFace _activeRenderTarget _adapter _areaLightBuffer _blackCubeTexView _blackTexView _bloomPassGPU _bloomTextureView _clearColor _context _cubeTextureViewCache _defaultBrdfTexView _defaultCubeTexView _depthTexture _device _dummyBufferSize _dummyNormalBuffer _dummyTangentBuffer _dummyUvBuffer _flatNormalTexView _format _frameCount _geoCache _globalBGL _globalBindGroup _globalUniformBuffer _gpuInstanceBuffers _hdrTexture _hdrTextureView _lightData _materialBGL _materialBindGroups _objectBGL _objectUniformBuffers _opaqueTextures _opaqueTextureView? _passes _pipelines _pointLightBuffer _quality _renderTargetCubeTextures _renderTargetTextures _samplerCache _scratchAreaLightData _scratchColorArray _scratchGlobalBufferData _scratchModelMatrix _scratchObjBufferData _scratchPointLightData _scratchSpotLightData _scratchUniformValues _screenOpaqueTexture? _shaderModules _spotLightBuffer _textureViewCache _whiteTexView postProcessing type

Accessors

activeDepthView clearColor gpuDevice quality

Constructors

constructor

new WebGPURenderer(): WebGPURenderer
Returns WebGPURenderer
Inherited from AbstractRenderer.constructor

Properties

`Protected`_activeCubeFace

_activeCubeFace: number = 0

`Protected`_activeRenderTarget

_activeRenderTarget: RenderTarget | RenderTargetCube | null = null

`Protected`_adapter

_adapter: GPUAdapter | undefined = undefined

_areaLightBuffer

_areaLightBuffer: GPUBuffer

`Protected`_blackCubeTexView

_blackCubeTexView: GPUTextureView

_blackTexView

_blackTexView: GPUTextureView

_bloomPassGPU

_bloomPassGPU: BloomPassGPU | undefined = undefined

_bloomTextureView

_bloomTextureView: GPUTextureView | undefined = undefined

`Protected`_clearColor

_clearColor: Color = ...

The clear color of the renderer.

_context

_context: GPUCanvasContext

`Protected`_cubeTextureViewCache

_cubeTextureViewCache: Map<CubeTexture, GPUTextureView> = ...

`Protected`_defaultBrdfTexView

_defaultBrdfTexView: GPUTextureView

`Protected`_defaultCubeTexView

_defaultCubeTexView: GPUTextureView

_depthTexture

_depthTexture: GPUTexture

_device

_device: GPUDevice | undefined = undefined

`Protected`_dummyBufferSize

_dummyBufferSize: number = 0

`Protected`_dummyNormalBuffer

_dummyNormalBuffer: GPUBuffer

`Protected`_dummyTangentBuffer

_dummyTangentBuffer: GPUBuffer

`Protected`_dummyUvBuffer

_dummyUvBuffer: GPUBuffer

`Protected`_flatNormalTexView

_flatNormalTexView: GPUTextureView

_format

_format: GPUTextureFormat

`Protected`_frameCount

_frameCount: number = 0

`Protected`_geoCache

_geoCache: Map<GeometryDataInterface, WebGPUGeoCache> = ...

_globalBGL

_globalBGL: GPUBindGroupLayout

_globalBindGroup

_globalBindGroup: GPUBindGroup

_globalUniformBuffer

_globalUniformBuffer: GPUBuffer

`Protected`_gpuInstanceBuffers

_gpuInstanceBuffers: WeakMap<InstancedMesh, GPUBuffer> = ...

_hdrTexture

_hdrTexture: GPUTexture | undefined = undefined

_hdrTextureView

_hdrTextureView: GPUTextureView | undefined = undefined

`Protected`_lightData

_lightData: LightDataInterface = ...

Cached light data to avoid GC pressure.

_materialBGL

_materialBGL: GPUBindGroupLayout

`Protected`_materialBindGroups

_materialBindGroups: Map<string, { bg: GPUBindGroup; resources: unknown[] }> = ...

_objectBGL

_objectBGL: GPUBindGroupLayout

`Protected`_objectUniformBuffers

_objectUniformBuffers: Map<
string,
{ buffer: GPUBuffer; lastFrame: number; objBg?: GPUBindGroup },
> = ...

`Protected`_opaqueTextures

_opaqueTextures: WeakMap<
object,
{ height: number; tex: GPUTexture; view: GPUTextureView; width: number },
> = ...

`Optional`_opaqueTextureView

_opaqueTextureView?: GPUTextureView

`Protected`_passes

_passes: RenderPass[] = []

`Protected`_pipelines

_pipelines: Map<string, WebGPUPipelineCache> = ...

_pointLightBuffer

_pointLightBuffer: GPUBuffer

`Protected`_quality

_quality: QualityConfig = ...

Global quality settings.

`Protected`_renderTargetCubeTextures

_renderTargetCubeTextures: Map<
    RenderTargetCube,
    {
        cubeView: GPUTextureView;
        depth?: GPUTexture;
        depthView?: GPUTextureView;
        faceViews: GPUTextureView[];
        tex: GPUTexture;
    },
> = ...

`Protected`_renderTargetTextures

_renderTargetTextures: Map<
    RenderTarget,
    {
        depth?: GPUTexture;
        depthView?: GPUTextureView;
        tex: GPUTexture;
        view: GPUTextureView;
    },
> = ...

`Protected`_samplerCache

_samplerCache: Map<string, GPUSampler> = ...

`Protected`_scratchAreaLightData

_scratchAreaLightData: Float32Array<ArrayBuffer> = ...

`Protected`_scratchColorArray

_scratchColorArray: Float32Array<ArrayBuffer> = ...

`Protected`_scratchGlobalBufferData

_scratchGlobalBufferData: Float32Array<ArrayBuffer> = ...

`Protected`_scratchModelMatrix

_scratchModelMatrix: Float32Array<ArrayBuffer> = ...

`Protected`_scratchObjBufferData

_scratchObjBufferData: Float32Array<ArrayBuffer> = ...

`Protected`_scratchPointLightData

_scratchPointLightData: Float32Array<ArrayBuffer> = ...

`Protected`_scratchSpotLightData

_scratchSpotLightData: Float32Array<ArrayBuffer> = ...

`Protected`_scratchUniformValues

_scratchUniformValues: Record<string, unknown> = {}

`Protected` `Optional`_screenOpaqueTexture

_screenOpaqueTexture?: {
    height: number;
    tex: GPUTexture;
    view: GPUTextureView;
    width: number;
}

`Protected`_shaderModules

_shaderModules: Map<string, GPUShaderModule> = ...

_spotLightBuffer

_spotLightBuffer: GPUBuffer

`Protected`_textureViewCache

_textureViewCache: Map<Texture, GPUTextureView> = ...

_whiteTexView

_whiteTexView: GPUTextureView

postProcessing

postProcessing: PostProcessingGroup = ...

The global post processing volume/group.

`Readonly`type

type: RendererType = RendererType.WEB_GPU

The type of the renderer.

Accessors

activeDepthView

get activeDepthView(): GPUTextureView
Returns GPUTextureView
- Defined in renderers/WebGPURenderer.ts:172

clearColor

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

Returns Color
Inherited from AbstractRenderer.clearColor
- Defined in renderers/AbstractRenderer.ts:85

gpuDevice

get gpuDevice(): GPUDevice | undefined
Satisfies Renderer interface

Returns GPUDevice | undefined
- Defined in renderers/WebGPURenderer.ts:61

quality

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

Returns QualityConfig
Inherited from AbstractRenderer.quality
- Defined in renderers/AbstractRenderer.ts:90

Methods

`Protected`_ensureDummyBufferSize

_ensureDummyBufferSize(vertexCount: number): void
Parameters
- vertexCount: number
Returns void
- Defined in renderers/WebGPURenderer.ts:344

`Protected`_getGeoCache

_getGeoCache(geo: GeometryDataInterface): WebGPUGeoCache
Parameters
- geo: GeometryDataInterface
Returns WebGPUGeoCache
- Defined in renderers/WebGPURenderer.ts:612

`Protected`_getGPUCubeTextureView

_getGPUCubeTextureView(tex: CubeTexture | undefined): GPUTextureView
Parameters
- tex: CubeTexture | undefined
Returns GPUTextureView
- Defined in renderers/WebGPURenderer.ts:1174

`Protected`_getMaterialBindGroup

_getMaterialBindGroup(
    matUuid: string,
    m: RenderManifest,
    layout: GPUBindGroupLayout,
): GPUBindGroup
Parameters
- matUuid: string
- m: RenderManifest
- layout: GPUBindGroupLayout
Returns GPUBindGroup
- Defined in renderers/WebGPURenderer.ts:1060

`Protected`_getNormalTextureView

_getNormalTextureView(tex: Texture | undefined): GPUTextureView
Parameters
- tex: Texture | undefined
Returns GPUTextureView
- Defined in renderers/WebGPURenderer.ts:1169

`Protected`_getObjBindGroup

_getObjBindGroup(
objBufferData: { buffer: GPUBuffer; objBg?: GPUBindGroup },
layout: GPUBindGroupLayout,
): GPUBindGroup
Parameters
- objBufferData: { buffer: GPUBuffer; objBg?: GPUBindGroup }
- layout: GPUBindGroupLayout
Returns GPUBindGroup
- Defined in renderers/WebGPURenderer.ts:1133

`Protected`_getObjUniformBufferData

_getObjUniformBufferData(
obj: Object3D,
): { buffer: GPUBuffer; lastFrame: number; objBg?: GPUBindGroup }
Parameters
- obj: Object3D
Returns { buffer: GPUBuffer; lastFrame: number; objBg?: GPUBindGroup }
- Defined in renderers/WebGPURenderer.ts:981

`Protected`_getPipeline

_getPipeline(
    manifest: RenderManifest,
    topology: GPUPrimitiveTopology,
    isInstanced?: boolean,
): WebGPUPipelineCache
Parameters
- manifest: RenderManifest
- topology: GPUPrimitiveTopology
- isInstanced: boolean = false
Returns WebGPUPipelineCache
- Defined in renderers/WebGPURenderer.ts:491

`Protected`_getSampler

_getSampler(tex: Texture | undefined): GPUSampler
Parameters
- tex: Texture | undefined
Returns GPUSampler
- Defined in renderers/WebGPURenderer.ts:319

`Protected`_getShaderModule

_getShaderModule(shaderId: string, isInstanced?: boolean): GPUShaderModule
Parameters
- shaderId: string
- isInstanced: boolean = false
Returns GPUShaderModule
- Defined in renderers/WebGPURenderer.ts:580

`Protected`_getTextureView

_getTextureView(tex: Texture | undefined): GPUTextureView
Parameters
- tex: Texture | undefined
Returns GPUTextureView
- Defined in renderers/WebGPURenderer.ts:1146

`Protected`_pruneObjectBuffers

_pruneObjectBuffers(): void
Returns void
- Defined in renderers/WebGPURenderer.ts:847

_renderGroup

_renderGroup(
    rp: GPURenderPassEncoder,
    _shaderId: string,
    materialGroups: Map<string, Object3D[]>,
    vMat?: Float32Array<ArrayBufferLike>,
    topology?: GPUPrimitiveTopology,
): void
Parameters
- rp: GPURenderPassEncoder
- _shaderId: string
- materialGroups: Map<string, Object3D[]>
- OptionalvMat: Float32Array<ArrayBufferLike>
- topology: GPUPrimitiveTopology = "triangle-list"
Returns void
- Defined in renderers/WebGPURenderer.ts:856

`Protected`_updateObjUniformBuffer

_updateObjUniformBuffer(
    b: GPUBuffer,
    o: Object3D,
    m: RenderManifest,
    vMat?: Float32Array<ArrayBufferLike>,
): void
Parameters
- b: GPUBuffer
- o: Object3D
- m: RenderManifest
- OptionalvMat: Float32Array<ArrayBufferLike>
Returns void
- Defined in renderers/WebGPURenderer.ts:999

addPass

addPass(pass: RenderPass): void
Adds a render pass to the pipeline.
Parameters
- pass: RenderPass
  The pass to add.
Returns void
- Defined in renderers/WebGPURenderer.ts:266

captureOpaqueTexture

captureOpaqueTexture(ce: GPUCommandEncoder, targetTex: GPUTexture): void
Parameters
- ce: GPUCommandEncoder
- targetTex: GPUTexture
Returns void
- Defined in renderers/WebGPURenderer.ts:816

destroy

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

Returns void
Inherited from AbstractRenderer.destroy
- Defined in renderers/AbstractRenderer.ts:75

`Protected`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.
Inherited from AbstractRenderer.extractLights
- Defined in renderers/AbstractRenderer.ts:99

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>
Overrides AbstractRenderer.initialize
- Defined in renderers/WebGPURenderer.ts:186

render

render(
    scene: Scene,
    vp: Float32Array,
    camPos?: Vector3D,
    vMat?: Float32Array<ArrayBufferLike>,
): void
Renders a scene.
Parameters
- scene: Scene
- vp: Float32Array
- camPos: Vector3D = Vector3D.ZERO
- OptionalvMat: Float32Array<ArrayBufferLike>
Returns void
Overrides AbstractRenderer.render
- Defined in renderers/WebGPURenderer.ts:660

setClearColor

setClearColor(color: Color): void
Sets the clear color of the renderer.
Parameters
- color: Color
Returns void
Inherited from AbstractRenderer.setClearColor
- Defined in renderers/AbstractRenderer.ts:80

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
Overrides AbstractRenderer.setRenderTarget
- Defined in renderers/WebGPURenderer.ts:164

setSize

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

Class WebGPURenderer

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns WebGPURenderer

Properties

Protected_activeCubeFace

Protected_activeRenderTarget

Protected_adapter

_areaLightBuffer

Protected_blackCubeTexView

_blackTexView

_bloomPassGPU

_bloomTextureView

Protected_clearColor

_context

Protected_cubeTextureViewCache

Protected_defaultBrdfTexView

Protected_defaultCubeTexView

_depthTexture

_device

Protected_dummyBufferSize

Protected_dummyNormalBuffer

Protected_dummyTangentBuffer

Protected_dummyUvBuffer

Protected_flatNormalTexView

_format

Protected_frameCount

Protected_geoCache

_globalBGL

_globalBindGroup

_globalUniformBuffer

Protected_gpuInstanceBuffers

_hdrTexture

_hdrTextureView

Protected_lightData

_materialBGL

Protected_materialBindGroups

_objectBGL

Protected_objectUniformBuffers

Protected_opaqueTextures

Optional_opaqueTextureView

Protected_passes

Protected_pipelines

_pointLightBuffer

Protected_quality

Protected_renderTargetCubeTextures

Protected_renderTargetTextures

Protected_samplerCache

Protected_scratchAreaLightData

Protected_scratchColorArray

Protected_scratchGlobalBufferData

Protected_scratchModelMatrix

Protected_scratchObjBufferData

Protected_scratchPointLightData

Protected_scratchSpotLightData

Protected_scratchUniformValues

Protected Optional_screenOpaqueTexture

Protected_shaderModules

_spotLightBuffer

Protected_textureViewCache

_whiteTexView

postProcessing

Readonlytype

Accessors

activeDepthView

Returns GPUTextureView

clearColor

Returns Color

gpuDevice

Returns GPUDevice | undefined

quality

Returns QualityConfig

Methods

Protected_ensureDummyBufferSize

`Protected`_activeCubeFace

`Protected`_activeRenderTarget

`Protected`_adapter

`Protected`_blackCubeTexView

`Protected`_clearColor

`Protected`_cubeTextureViewCache

`Protected`_defaultBrdfTexView

`Protected`_defaultCubeTexView

`Protected`_dummyBufferSize

`Protected`_dummyNormalBuffer

`Protected`_dummyTangentBuffer

`Protected`_dummyUvBuffer

`Protected`_flatNormalTexView

`Protected`_frameCount

`Protected`_geoCache

`Protected`_gpuInstanceBuffers

`Protected`_lightData

`Protected`_materialBindGroups

`Protected`_objectUniformBuffers

`Protected`_opaqueTextures

`Optional`_opaqueTextureView

`Protected`_passes

`Protected`_pipelines

`Protected`_quality

`Protected`_renderTargetCubeTextures

`Protected`_renderTargetTextures

`Protected`_samplerCache

`Protected`_scratchAreaLightData

`Protected`_scratchColorArray

`Protected`_scratchGlobalBufferData

`Protected`_scratchModelMatrix

`Protected`_scratchObjBufferData

`Protected`_scratchPointLightData

`Protected`_scratchSpotLightData

`Protected`_scratchUniformValues

`Protected` `Optional`_screenOpaqueTexture

`Protected`_shaderModules

`Protected`_textureViewCache

`Readonly`type

`Protected`_ensureDummyBufferSize

`Protected`_getGeoCache

`Protected`_getGPUCubeTextureView

`Protected`_getMaterialBindGroup

`Protected`_getNormalTextureView

`Protected`_getObjBindGroup

`Protected`_getObjUniformBufferData

`Protected`_getPipeline

`Protected`_getSampler

`Protected`_getShaderModule

`Protected`_getTextureView

`Protected`_pruneObjectBuffers

`Protected`_updateObjUniformBuffer

`Protected`extractLights