Class SkyWithLutsRasterRenderer

A sky / atmosphere renderer that renders the sky based on lookup tables. It uses GPURenderPipelines to render the sky / atmosphere.

Hierarchy

SkyRasterRenderer
- SkyWithLutsRasterRenderer

Constructors

`Private` constructor

new SkyWithLutsRasterRenderer(targetFormats, lutRenderer, bindGroupLayout, pipeline, config): SkyWithLutsRasterRenderer
Parameters
- targetFormats: GPUTextureFormat[]
- lutRenderer: SkyAtmosphereLutRenderer
- bindGroupLayout: GPUBindGroupLayout
- pipeline: GPURenderPipeline
- config: SkyAtmosphereRasterRendererConfig
Returns SkyWithLutsRasterRenderer
Overrides SkyRasterRenderer.constructor
- Defined in sky-raster-renderer.ts:186

Properties

`Protected` bindGroupLayout

bindGroupLayout: GPUBindGroupLayout

`Protected` doesRayMarchDistantSky

doesRayMarchDistantSky: boolean

`Readonly` lutRenderer

lutRenderer: SkyAtmosphereLutRenderer

`Readonly` targetFormats

targetFormats: GPUTextureFormat[]

Accessors

resources

get resources(): SkyAtmosphereResources
Returns SkyAtmosphereResources
Inherited from SkyRasterRenderer.resources
- Defined in sky-raster-renderer.ts:176

Methods

`Protected` makeBindGroup

makeBindGroup(depthBuffer): GPUBindGroup
Parameters
- depthBuffer: GPUTexture | GPUTextureView
Returns GPUBindGroup
Overrides SkyRasterRenderer.makeBindGroup
- Defined in sky-raster-renderer.ts:314

`Protected` makeExternalBindGroupEntries

makeExternalBindGroupEntries(depthBuffer): GPUBindGroupEntry[]
Parameters
- depthBuffer: GPUTexture | GPUTextureView
Returns GPUBindGroupEntry[]
Inherited from SkyRasterRenderer.makeExternalBindGroupEntries
- Defined in sky-raster-renderer.ts:90

onResize

onResize(depthBuffer): void
Replaces potentially screen-size dependent external resources (depth buffer) in the internal bind groups.
Parameters
- depthBuffer: GPUTexture | GPUTextureView
  The depth buffer to limit the ray marching distance when rendering the sky / atmosphere. If this is a textue, a texture view will be created. If this is a texture view, it must be allowed to be bound as a texture<f32>. I.e., if the texture has a depth-stencil format, the texture view must be a "depth-only" view.
Returns void
Inherited from SkyRasterRenderer.onResize
- Defined in sky-raster-renderer.ts:111

renderAerialPerspectiveLut

renderAerialPerspectiveLut(passEncoder): void
Parameters
- passEncoder: GPUComputePassEncoder
Returns void
Inherited from SkyRasterRenderer.renderAerialPerspectiveLut
- Defined in sky-raster-renderer.ts:164

renderConstantLuts

renderConstantLuts(passEncoder, atmosphere?): void
Parameters
- passEncoder: GPUComputePassEncoder
- Optional atmosphere: Atmosphere
Returns void
Inherited from SkyRasterRenderer.renderConstantLuts
- Defined in sky-raster-renderer.ts:156

renderDynamicLuts

renderDynamicLuts(passEncoder, uniforms?): void
Parameters
- passEncoder: GPUComputePassEncoder
- Optional uniforms: Uniforms
Returns void
Inherited from SkyRasterRenderer.renderDynamicLuts
- Defined in sky-raster-renderer.ts:168

renderLuts

renderLuts(passEncoder, uniforms?, atmosphere?, skipDynamicLutRendering?, forceConstantLutRendering?, forceSkyViewLutRendering?): void
Parameters
- passEncoder: GPUComputePassEncoder
- Optional uniforms: Uniforms
- Optional atmosphere: Atmosphere
- Optional skipDynamicLutRendering: boolean
- Optional forceConstantLutRendering: boolean
- Optional forceSkyViewLutRendering: boolean
Returns void
Overrides SkyRasterRenderer.renderLuts
- Defined in sky-raster-renderer.ts:318

renderMultiScatteringLut

renderMultiScatteringLut(passEncoder): void
Parameters
- passEncoder: GPUComputePassEncoder
Returns void
Inherited from SkyRasterRenderer.renderMultiScatteringLut
- Defined in sky-raster-renderer.ts:152

renderSky

renderSky(passEncoder): void
Renders the sky / atmosphere.
Parameters
- passEncoder: GPURenderPassEncoder | GPURenderBundleEncoder
  A GPURenderPassEncoder or GPURenderBundleEncoder to encode the pass with. The encoder is not end()ed by this function.
Returns void
Inherited from SkyRasterRenderer.renderSky
- Defined in sky-raster-renderer.ts:123

renderSkyViewLut

renderSkyViewLut(passEncoder): void
Parameters
- passEncoder: GPUComputePassEncoder
Returns void
Inherited from SkyRasterRenderer.renderSkyViewLut
- Defined in sky-raster-renderer.ts:160

renderTransmittanceLut

renderTransmittanceLut(passEncoder): void
Parameters
- passEncoder: GPUComputePassEncoder
Returns void
Inherited from SkyRasterRenderer.renderTransmittanceLut
- Defined in sky-raster-renderer.ts:148

updateAtmosphere

updateAtmosphere(atmosphere): void
Parameters
- atmosphere: Atmosphere
Returns void
Inherited from SkyRasterRenderer.updateAtmosphere
- Defined in sky-raster-renderer.ts:140

updateUniforms

updateUniforms(uniforms): void
Parameters
- uniforms: Uniforms
Returns void
Inherited from SkyRasterRenderer.updateUniforms
- Defined in sky-raster-renderer.ts:144

`Static` create

create(device, config, existingLutRenderer?, existingPipelines?, existingResources?): SkyWithLutsRasterRenderer
Creates a SkyAtmosphereComputeRenderer.
Parameters
- device: GPUDevice
  The GPUDevice used to create internal resources (textures, pipelines, etc.).
- config: SkyAtmosphereRasterRendererConfig
  A SkyAtmosphereRasterRendererConfig used to configure internal resources and behavior.
- Optional existingLutRenderer: SkyAtmosphereLutRenderer
  If this is defined, no new internal SkyAtmosphereLutRenderer will be created. Instead, the existing one is used.
- Optional existingPipelines: SkyAtmospherePipelines
  If this is defined, no new pipelines for rendering the internal lookup tables will be created. Instead, the existing pipelines given will be reused. The existing pipelines must be compatible with the SkyAtmosphereRendererConfig. Especially, SkyAtmosphereRendererConfig.lookUpTables and SkyAtmosphereRendererConfig.shadow should be the same.
- Optional existingResources: SkyAtmosphereResources
  If this is defined, no new resources (buffers, textures, samplers) will be created. Instead, the existing resources given will be used.
Returns SkyWithLutsRasterRenderer
- Defined in sky-raster-renderer.ts:294

`Static` createAsync

createAsync(device, config, existingLutRenderer?, existingPipelines?, existingResources?): Promise<SkyWithLutsRasterRenderer>
Asynchronously creates a SkyAtmosphereComputeRenderer.

All pipelines used by this renderer are created asynchronously.
Parameters
- device: GPUDevice
  The GPUDevice used to create internal resources (textures, pipelines, etc.).
- config: SkyAtmosphereRasterRendererConfig
  A SkyAtmosphereRasterRendererConfig used to configure internal resources and behavior.
- Optional existingLutRenderer: SkyAtmosphereLutRenderer
  If this is defined, no new internal SkyAtmosphereLutRenderer will be created. Instead, the existing one is used.
- Optional existingPipelines: SkyAtmospherePipelines
  If this is defined, no new pipelines for rendering the internal lookup tables will be created. Instead, the existing pipelines given will be reused. The existing pipelines must be compatible with the SkyAtmosphereRendererConfig. Especially, SkyAtmosphereRendererConfig.lookUpTables and SkyAtmosphereRendererConfig.shadow should be the same.
- Optional existingResources: SkyAtmosphereResources
  If this is defined, no new resources (buffers, textures, samplers) will be created. Instead, the existing resources given will be used.
Returns Promise<SkyWithLutsRasterRenderer>
- Defined in sky-raster-renderer.ts:267

`Static` `Private` makeBindGroupLayout

makeBindGroupLayout(device, config, resources): GPUBindGroupLayout
Parameters
- device: GPUDevice
- config: SkyAtmosphereRasterRendererConfig
- resources: SkyAtmosphereResources
Returns GPUBindGroupLayout
- Defined in sky-raster-renderer.ts:196

`Static` `Protected` makeBlendStates

makeBlendStates(): {
dual: GPUBlendState;
single: GPUBlendState;
}
Returns {
dual: GPUBlendState;
single: GPUBlendState;
}
- dual: GPUBlendState
- single: GPUBlendState
Inherited from SkyRasterRenderer.makeBlendStates
- Defined in sky-raster-renderer.ts:47

`Static` `Protected` makeExternalBindGroupLayoutEntries

makeExternalBindGroupLayoutEntries(config): GPUBindGroupLayoutEntry[]
Parameters
- config: SkyAtmosphereRasterRendererConfig
Returns GPUBindGroupLayoutEntry[]
Inherited from SkyRasterRenderer.makeExternalBindGroupLayoutEntries
- Defined in sky-raster-renderer.ts:76

`Static` `Private` makePipelineDescriptor

makePipelineDescriptor(device, config, lutRenderer, bindGroupLayout, blendState, dualBlendState, useDualSourceBlending): [GPURenderPipelineDescriptor, GPUTextureFormat[]]
Parameters
- device: GPUDevice
- config: SkyAtmosphereRasterRendererConfig
- lutRenderer: SkyAtmosphereLutRenderer
- bindGroupLayout: GPUBindGroupLayout
- blendState: GPUBlendState
- dualBlendState: GPUBlendState
- useDualSourceBlending: boolean
Returns [GPURenderPipelineDescriptor, GPUTextureFormat[]]
- Defined in sky-raster-renderer.ts:200

Class SkyWithLutsRasterRenderer

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

Private constructor

Parameters

Returns SkyWithLutsRasterRenderer

Properties

Protected bindGroupLayout

Protected doesRayMarchDistantSky

Readonly lutRenderer

Readonly targetFormats

Accessors

resources

Returns SkyAtmosphereResources

Methods

Protected makeBindGroup

Parameters

Returns GPUBindGroup

Protected makeExternalBindGroupEntries

Parameters

Returns GPUBindGroupEntry[]

onResize

Parameters

Returns void

renderAerialPerspectiveLut

Parameters

Returns void

renderConstantLuts

Parameters

Returns void

renderDynamicLuts

Parameters

Returns void

renderLuts

Parameters

Returns void

renderMultiScatteringLut

Parameters

Returns void

renderSky

Parameters

Returns void

renderSkyViewLut

Parameters

Returns void

renderTransmittanceLut

Parameters

Returns void

updateAtmosphere

Parameters

Returns void

updateUniforms

Parameters

Returns void

Static create

Parameters

Returns SkyWithLutsRasterRenderer

Static createAsync

Parameters

Returns Promise<SkyWithLutsRasterRenderer>

Static Private makeBindGroupLayout

Parameters

Returns GPUBindGroupLayout

Static Protected makeBlendStates

Returns { dual: GPUBlendState; single: GPUBlendState; }

dual: GPUBlendState

single: GPUBlendState

Static Protected makeExternalBindGroupLayoutEntries

Parameters

Returns GPUBindGroupLayoutEntry[]

Static Private makePipelineDescriptor

Parameters

Returns [GPURenderPipelineDescriptor, GPUTextureFormat[]]

Settings

Member Visibility

`Private` constructor

`Protected` bindGroupLayout

`Protected` doesRayMarchDistantSky

`Readonly` lutRenderer

`Readonly` targetFormats

`Protected` makeBindGroup

`Protected` makeExternalBindGroupEntries

`Static` create

`Static` createAsync

`Static` `Private` makeBindGroupLayout

`Static` `Protected` makeBlendStates

Returns {
dual: GPUBlendState;
single: GPUBlendState;
}

`Static` `Protected` makeExternalBindGroupLayoutEntries

`Static` `Private` makePipelineDescriptor