Class ForwardPass

Readonlyname

sortTransparent

iblIntensity

areaLightsUseLtc

shadowMapArray

• get shadowMapArray(): GPUTexture

  Returns GPUTexture

pointShadowCubeArray

• get pointShadowCubeArray(): GPUTexture

  Returns GPUTexture

lightingIblBindGroupLayout

• get lightingIblBindGroupLayout(): GPUBindGroupLayout

  Bind group layout for the lighting + IBL group. Exposed so other passes that want to reuse this pass's lighting state (e.g. instanced-mesh particles drawing into HDR) can build a pipeline against the same slot.

  Returns GPUBindGroupLayout

Staticcreate

• create(
      ctx: RenderContext,
      opts?: {
          useSphericalHarmonics?: boolean;
          useLtcAreaLights?: boolean;
          sampleCount?: number;
      },
  ): ForwardPass

  Parameters

  • ctx: RenderContext
  • opts: {
        useSphericalHarmonics?: boolean;
        useLtcAreaLights?: boolean;
        sampleCount?: number;
    } = {}

  Returns ForwardPass

getShadowMap

• getShadowMap(index: number): GPUTextureView

  Parameters

  • index: number

  Returns GPUTextureView

setAerial

• setAerial(maxDist: number, maxOpacity: number): void

  Enable the aerial-perspective tap on forward draws. Pass the SAME volumeMaxDist / maxOpacity the deferred aerial composites with (see DeferredLightingPass.aerialParams) plus the froxel-volume handles via ForwardDeps.aerialVolume. maxDist 0 (the default) disables the tap. Takes effect on the next updateLights.

  Parameters

  • maxDist: number
  • maxOpacity: number

  Returns void

buildLightingIblBindGroup

• buildLightingIblBindGroup(
      res: ResolvedResources,
      iblTextures?: IblTextures,
      externalShadowHandle?: ResourceHandle,
      areaShadowHandle?: ResourceHandle,
      aerialVolume?: { l: ResourceHandle; t: ResourceHandle },
  ): GPUBindGroup

  Parameters

  • res: ResolvedResources
  • OptionaliblTextures: IblTextures
  • OptionalexternalShadowHandle: ResourceHandle
  • OptionalareaShadowHandle: ResourceHandle
  • OptionalaerialVolume: { l: ResourceHandle; t: ResourceHandle }

  Returns GPUBindGroup

setDrawItems

• setDrawItems(items: ForwardDrawItem[]): void

  Parameters

  • items: ForwardDrawItem[]

  Returns void

setSkinnedDrawItems

• setSkinnedDrawItems(items: readonly SkinnedForwardDrawItem[]): void

  Set the list of skinned draws this pass will render in addition to the static items supplied via setDrawItems. The pass GPU-skins each vertex from the per-item joint palette, then runs the same forward PBR lighting as the un-skinned path. Items with material.transparent are routed through the blended sub-pass after all opaque draws.

  Parameters

  • items: readonly SkinnedForwardDrawItem[]

  Returns void

updateCamera

• updateCamera(ctx: RenderContext): void

  Parameters

  • ctx: RenderContext

  Returns void

copyShadowMapToArray

• copyShadowMapToArray(
      encoder: GPUCommandEncoder,
      sourceTexture: GPUTexture,
      arrayLayer: number,
      size?: number,
  ): void

  Parameters

  • encoder: GPUCommandEncoder
  • sourceTexture: GPUTexture
  • arrayLayer: number
  • size: number = 2048

  Returns void

updateLight

• updateLight(light: RenderSpotLight): void

  Parameters

  • light: RenderSpotLight

  Returns void

updateLights

• updateLights(
      ctx: RenderContext,
      directionalLight: DirectionalLight,
      pointLights: PointLight[],
      spotLights: RenderSpotLight[],
      areaLights?: readonly AreaLight[],
  ): void

  Parameters

  • ctx: RenderContext
  • directionalLight: DirectionalLight
  • pointLights: PointLight[]
  • spotLights: RenderSpotLight[]
  • areaLights: readonly AreaLight[] = []

  Returns void

addToGraph

• addToGraph(graph: RenderGraph, deps?: ForwardDeps): ForwardOutputs

  Insert the pass into graph for one frame. Implementations call graph.addPass(name, type, b => { ... }) exactly once and use the supplied PassBuilder to declare reads, writes, transient resources, and the execute callback.

  Parameters

  • graph: RenderGraph

    Graph being built this frame.

  • deps: ForwardDeps = {}

    Pass-specific dependency record (handles, scene data, etc.).

  Returns ForwardOutputs

  Pass-specific output record (typically a set of handles downstream passes will consume).

destroy

• destroy(): void

  Release every long-lived GPU resource owned by the pass (pipelines, persistent uniform buffers, samplers, BGLs). Called by the factory or application during teardown. Default implementation is a no-op.

  Returns void