Class SkyRayMarchComputeRenderer

A sky / atmosphere renderer that renders the sky using full-resolution ray marching. It uses GPUComputePipelines to render the sky / atmosphere.

Hierarchy

SkyComputeRenderer
- SkyRayMarchComputeRenderer

Constructors

`Private` constructor

new SkyRayMarchComputeRenderer(lutRenderer, bindGroupLayout, pipeline, config): SkyRayMarchComputeRenderer
Parameters
- lutRenderer: SkyAtmosphereLutRenderer
- bindGroupLayout: GPUBindGroupLayout
- pipeline: GPUComputePipeline
- config: SkyAtmosphereComputeRendererConfig
Returns SkyRayMarchComputeRenderer
Overrides SkyComputeRenderer.constructor
- Defined in sky-compute-renderer.ts:335

Properties

`Protected` bindGroupLayout

bindGroupLayout: GPUBindGroupLayout

`Protected` doesRayMarchDistantSky

doesRayMarchDistantSky: boolean

`Protected` lutRenderer

lutRenderer: SkyAtmosphereLutRenderer

Accessors

rayMarchDistantSky

get rayMarchDistantSky(): boolean
Returns boolean
- Defined in sky-compute-renderer.ts:430

resources

get resources(): SkyAtmosphereResources
Returns SkyAtmosphereResources
Inherited from SkyComputeRenderer.resources
- Defined in sky-compute-renderer.ts:234

Methods

`Protected` makeBindGroup

makeBindGroup(config): GPUBindGroup
Parameters
- config: SkyAtmosphereComputeRendererResizeConfig
Returns GPUBindGroup
Overrides SkyComputeRenderer.makeBindGroup
- Defined in sky-compute-renderer.ts:421

`Protected` makeExternalBindGroupEntries

makeExternalBindGroupEntries(config): GPUBindGroupEntry[]
Parameters
- config: SkyAtmosphereComputeRendererResizeConfig
Returns GPUBindGroupEntry[]
Inherited from SkyComputeRenderer.makeExternalBindGroupEntries
- Defined in sky-compute-renderer.ts:124

onResize

onResize(config): void
Replaces potentially screen-size dependent external resources (back buffer, depth buffer, and render target) in the internal bind groups.
Parameters
- config: SkyAtmosphereComputeRendererResizeConfig
  Configuration of external resources.
Returns void
Inherited from SkyComputeRenderer.onResize
- Defined in sky-compute-renderer.ts:150

renderAerialPerspectiveLut

renderAerialPerspectiveLut(passEncoder): void
Parameters
- passEncoder: GPUComputePassEncoder
Returns void
Inherited from SkyComputeRenderer.renderAerialPerspectiveLut
- Defined in sky-compute-renderer.ts:222

renderConstantLuts

renderConstantLuts(passEncoder, atmosphere?): void
Parameters
- passEncoder: GPUComputePassEncoder
- Optional atmosphere: Atmosphere
Returns void
Inherited from SkyComputeRenderer.renderConstantLuts
- Defined in sky-compute-renderer.ts:214

renderDynamicLuts

renderDynamicLuts(passEncoder, uniforms?): void
Parameters
- passEncoder: GPUComputePassEncoder
- Optional uniforms: Uniforms
Returns void
Inherited from SkyComputeRenderer.renderDynamicLuts
- Defined in sky-compute-renderer.ts:226

renderLuts

renderLuts(passEncoder, uniforms?, atmosphere?, useFullResolutionRayMarch?, forceConstantLutRendering?, forceSkyViewLutRendering?): void
Parameters
- passEncoder: GPUComputePassEncoder
- Optional uniforms: Uniforms
- Optional atmosphere: Atmosphere
- Optional useFullResolutionRayMarch: boolean
- Optional forceConstantLutRendering: boolean
- Optional forceSkyViewLutRendering: boolean
Returns void
Inherited from SkyComputeRenderer.renderLuts
- Defined in sky-compute-renderer.ts:230

renderLutsAndSky

renderLutsAndSky(passEncoder, uniforms?, atmosphere?, forceConstantLutRendering?): void
Parameters
- passEncoder: GPUComputePassEncoder
- Optional uniforms: Uniforms
- Optional atmosphere: Atmosphere
- Optional forceConstantLutRendering: boolean
Returns void
Overrides SkyComputeRenderer.renderLutsAndSky
- Defined in sky-compute-renderer.ts:425

renderMultiScatteringLut

renderMultiScatteringLut(passEncoder): void
Parameters
- passEncoder: GPUComputePassEncoder
Returns void
Inherited from SkyComputeRenderer.renderMultiScatteringLut
- Defined in sky-compute-renderer.ts:210

renderSky

renderSky(passEncoder): void
Renders the sky / atmosphere.
Parameters
- passEncoder: GPUComputePassEncoder
  A GPUComputePassEncoder to encode the pass with. Can be the same encoder used to initialize lookup tables required. The encoder is not end()ed by this function.
Returns void
Inherited from SkyComputeRenderer.renderSky
- Defined in sky-compute-renderer.ts:179

renderSkyViewLut

renderSkyViewLut(passEncoder): void
Parameters
- passEncoder: GPUComputePassEncoder
Returns void
Inherited from SkyComputeRenderer.renderSkyViewLut
- Defined in sky-compute-renderer.ts:218

renderTransmittanceLut

renderTransmittanceLut(passEncoder): void
Parameters
- passEncoder: GPUComputePassEncoder
Returns void
Inherited from SkyComputeRenderer.renderTransmittanceLut
- Defined in sky-compute-renderer.ts:206

updateAtmosphere

updateAtmosphere(atmosphere): void
Parameters
- atmosphere: Atmosphere
Returns void
Inherited from SkyComputeRenderer.updateAtmosphere
- Defined in sky-compute-renderer.ts:198

updateUniforms

updateUniforms(uniforms): void
Parameters
- uniforms: Uniforms
Returns void
Inherited from SkyComputeRenderer.updateUniforms
- Defined in sky-compute-renderer.ts:202

`Static` create

create(device, config, existingLutRenderer?, existingPipelines?, existingResources?): SkyRayMarchComputeRenderer
Creates a SkyAtmosphereComputeRenderer.
Parameters
- device: GPUDevice
  The GPUDevice used to create internal resources (textures, pipelines, etc.).
- config: SkyAtmosphereComputeRendererConfig
  A SkyAtmosphereRendererConfig 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 SkyRayMarchComputeRenderer
- Defined in sky-compute-renderer.ts:408

`Static` createAsync

createAsync(device, config, existingLutRenderer?, existingPipelines?, existingResources?): Promise<SkyRayMarchComputeRenderer>
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: SkyAtmosphereComputeRendererConfig
  A SkyAtmosphereRendererConfig 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<SkyRayMarchComputeRenderer>
- Defined in sky-compute-renderer.ts:387

`Static` `Private` makeBindGroupLayout

makeBindGroupLayout(device, config, resources, rayMarchDistantSky): GPUBindGroupLayout
Parameters
- device: GPUDevice
- config: SkyAtmosphereComputeRendererConfig
- resources: SkyAtmosphereResources
- rayMarchDistantSky: boolean
Returns GPUBindGroupLayout
- Defined in sky-compute-renderer.ts:344

`Static` `Protected` makeExternalBindGroupLayoutEntries

makeExternalBindGroupLayoutEntries(config): GPUBindGroupLayoutEntry[]
Parameters
- config: SkyAtmosphereComputeRendererConfig
Returns GPUBindGroupLayoutEntry[]
Inherited from SkyComputeRenderer.makeExternalBindGroupLayoutEntries
- Defined in sky-compute-renderer.ts:91

`Static` `Private` makeRayMarchPipelineDescriptor

makeRayMarchPipelineDescriptor(device, config, lutRenderer, renderSkyRaymarchingBindGroupLayout, rayMarchDistantSky): GPUComputePipelineDescriptor
Parameters
- device: GPUDevice
- config: SkyAtmosphereComputeRendererConfig
- lutRenderer: SkyAtmosphereLutRenderer
- renderSkyRaymarchingBindGroupLayout: GPUBindGroupLayout
- rayMarchDistantSky: boolean
Returns GPUComputePipelineDescriptor
- Defined in sky-compute-renderer.ts:348

Class SkyRayMarchComputeRenderer

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

Private constructor

Parameters

Returns SkyRayMarchComputeRenderer

Properties

Protected bindGroupLayout

Protected doesRayMarchDistantSky

Protected lutRenderer

Accessors

rayMarchDistantSky

Returns boolean

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

renderLutsAndSky

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 SkyRayMarchComputeRenderer

Static createAsync

Parameters

Returns Promise<SkyRayMarchComputeRenderer>

Static Private makeBindGroupLayout

Parameters

Returns GPUBindGroupLayout

Static Protected makeExternalBindGroupLayoutEntries

Parameters

Returns GPUBindGroupLayoutEntry[]

Static Private makeRayMarchPipelineDescriptor

Parameters

Returns GPUComputePipelineDescriptor

Settings

Member Visibility

`Private` constructor

`Protected` bindGroupLayout

`Protected` doesRayMarchDistantSky

`Protected` lutRenderer

`Protected` makeBindGroup

`Protected` makeExternalBindGroupEntries

`Static` create

`Static` createAsync

`Static` `Private` makeBindGroupLayout

`Static` `Protected` makeExternalBindGroupLayoutEntries

`Static` `Private` makeRayMarchPipelineDescriptor