Class SkyAtmosphereLutRenderer

Readonly pipelines

Readonly resources

skipDynamicLutRendering

Readonly usesCustomUniforms

renderAerialPerspectiveLut

• renderAerialPerspectiveLut(passEncoder): void

• Renders the aerial perspective lookup table.

  To produce meaningful results, this requires the transmittance and multiple scattering lookup tables, as well as the uniform buffers containing the Atmosphere and Uniforms parameters to hold valid data. Call renderConstantLuts and updateUniforms to ensure this is the case.

  If (a) user-defined shadow map(s) is used (see SkyAtmosphereRendererConfig.shadow), make sure to encode any updates of the shadow map(s) before encoding this pass.

  Parameters

  • passEncoder: GPUComputePassEncoder

    Used to encode rendering of the lookup table. The encoder is not end()ed by this function.

  Returns void

  See

  • renderConstantLuts: To initialize the transmittance and multiple scattering lookup tables, as well as the internal uniform buffer storing the Atmosphere parameters, call this function.
  • updateUniforms: To write Uniforms to the internal uniform buffer, call this function.

renderConstantLuts

• renderConstantLuts(passEncoder, atmosphere?): void

• Renders the transmittance and multiple scattering lookup tables.

  To produce meaningful results, this requires the internal uniform buffer containing the Atmosphere parameters to hold valid data. Use the atmosphere parameter to implicitly update the Atmosphere parameters or call updateAtmosphere to ensure this is the case.

  Since the transmittance and multiple scattering lookup tables are not view or light souce dependent, this only needs to be called if the Atmosphere parameters change.

  Parameters

  • passEncoder: GPUComputePassEncoder

    Used to encode rendering of the lookup tables. The encoder is not end()ed by this function.
  • Optional atmosphere: Atmosphere

    If this is defined, updateAtmosphere is called before rendering the lookup tables.

  Returns void

  See

  • updateAtmosphere: Updates the Atmosphere parameters.
  • renderTransmittanceLut: Renders the transmittance lookup table.
  • renderMultiScatteringLut: Renders the multiple scattering lookup table.

renderDynamicLuts

• renderDynamicLuts(passEncoder, uniforms?): void

• Renders the sky view and aerial perspective lookup tables.

  To produce meaningful results, this requires the transmittance and multiple scattering lookup tables, as well as the uniform buffers containing the Atmosphere and Uniforms parameters to hold valid data. Call renderConstantLuts and updateUniforms to ensure this is the case.

  If (a) user-defined shadow map(s) is used (see SkyAtmosphereRendererConfig.shadow), make sure to encode any updates of the shadow map(s) before encoding this pass.

  Parameters

  • passEncoder: GPUComputePassEncoder

    Used to encode rendering of the lookup tables. The encoder is not end()ed by this function.
  • Optional uniforms: Uniforms

    If this is defined, updateUniforms is called before rendering the lookup tables.

  Returns void

  See

  • renderConstantLuts: To initialize the transmittance and multiple scattering lookup tables, as well as the internal uniform buffer storing the Atmosphere parameters, call this function.
  • updateUniforms: Updates the internal Uniforms uniform buffer.
  • renderSkyViewLut: Renders the sky view lookup table.
  • renderAerialPerspectiveLut: Renders the aerial perspective lookup table.

renderLuts

• renderLuts(passEncoder, uniforms?, atmosphere?, skipDynamicLutRendering?, forceConstantLutRendering?, forceSkyViewLutRendering?): void

• Renders the lookup tables required for rendering the sky / atmosphere.

  To initialize or update the transmittance and multiple scattering lookup tables, pass new Atmosphere paramters to this function or use the forceConstantLutRendering parameter.

  Parameters

  • passEncoder: GPUComputePassEncoder

    A GPUComputePassEncoder to encode passes with. The encoder is not end()ed by this function.
  • Optional uniforms: Uniforms

    Uniforms to use for this frame. If this is given, the internal uniform buffer will be updated using updateUniforms.
  • Optional atmosphere: Atmosphere

    Atmosphere parameters to use for this frame. If this is given, the internal uniform buffer storing the Atmosphere parameters will be updated and the transmittance and multiple scattering lookup tables will be rendered.
  • Optional skipDynamicLutRendering: boolean

    If this is true, the sky view and aerial perspective lookup tables will not be rendered. Defaults to skipDynamicLutRendering.
  • Optional forceConstantLutRendering: boolean

    If this is true, the transmittance and multiple scattering lookup tables will be rendered regardless of whether the atmosphere parameter is undefined or not.
  • Optional forceSkyViewLutRendering: boolean

    If this is true, the sky view lookup table will be rendered, even if skipDynamicLutRendering is true. Defaults to false.

  Returns void

  See

  • renderConstantLuts: Renders the lookup tables that are constant for a given Atmosphere.
  • updateUniforms: Updates the internal Uniforms uniform buffer.
  • renderDynamicLuts: Renders the view-dependent lookup tables.
  • renderSkyViewLut: Renders the sky view lookup table.

renderMultiScatteringLut

• renderMultiScatteringLut(passEncoder): void

• Renders the multiple scattering lookup table.

  To produce meaningful results, this requires the internal uniform buffer containing the Atmosphere parameters to hold valid data. Call updateAtmosphere to ensure this is the case.

  Since the multiple scattering lookup table is not view or light souce dependent, this only needs to be called if the Atmosphere parameters change.

  Parameters

  • passEncoder: GPUComputePassEncoder

    Used to encode rendering of the lookup table. The encoder is not end()ed by this function.

  Returns void

  See

  updateAtmosphere: To write Atmosphere parameters to the internal uniform buffer, call this function.

renderSkyViewLut

• renderSkyViewLut(passEncoder): void

• Renders the sky view table.

  To produce meaningful results, this requires the transmittance and multiple scattering lookup tables, as well as the uniform buffers containing the Atmosphere and Uniforms parameters to hold valid data. Call renderConstantLuts and updateUniforms to ensure this is the case.

  Parameters

  • passEncoder: GPUComputePassEncoder

    Used to encode rendering of the lookup table. The encoder is not end()ed by this function.

  Returns void

  See

  • renderConstantLuts: To initialize the transmittance and multiple scattering lookup tables, as well as the internal uniform buffer storing the Atmosphere parameters, call this function.
  • updateUniforms: To write Uniforms to the internal uniform buffer, call this function.

renderTransmittanceLut

• renderTransmittanceLut(passEncoder): void

• Renders the transmittance lookup table.

  To produce meaningful results, this requires the internal uniform buffer containing the Atmosphere parameters to hold valid data. Call updateAtmosphere to ensure this is the case.

  Since the transmittance lookup table is not view or light souce dependent, this only needs to be called if the Atmosphere parameters change.

  Parameters

  • passEncoder: GPUComputePassEncoder

    Used to encode rendering of the lookup table. The encoder is not end()ed by this function.

  Returns void

  See

  updateAtmosphere: To write Atmosphere parameters to the internal uniform buffer, call this function.

updateAtmosphere

• updateAtmosphere(atmosphere): void

• Updates the renderer's internal uniform buffer containing the Atmosphere parameters as well as its host-side copy of Atmosphere parameters.

  Parameters

  • atmosphere: Atmosphere

    The new Atmosphere to override the current parameters.

  Returns void

  See

  SkyAtmosphereResources.updateAtmosphere: Updates the host-side Atmosphere parameters as well as the corresponding uniform buffer.

updateUniforms

• updateUniforms(uniforms): void

• Updates the renderer's internal uniform buffer containing the Uniforms as well as its host-side copy of Uniforms.

  Parameters

  • uniforms: Uniforms

    The new Uniforms to override the current parameters.

    If custom uniform buffers are used, this does nothing (see CustomUniformsSourceConfig).

  Returns void

  See

  SkyAtmosphereResources.updateUniforms: Update the Uniforms uniform buffers.

Static create

• create(device, config, existingPipelines?, existingResources?): SkyAtmosphereLutRenderer

• Creates a SkyAtmosphereLutRenderer.

  Parameters

  • device: GPUDevice

    The GPUDevice used to create internal resources (textures, pipelines, etc.).
  • config: SkyAtmosphereRendererConfig

    A SkyAtmosphereRendererConfig used to configure internal resources and behavior.
  • 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 SkyAtmosphereLutRenderer

Static createAsync

• createAsync(device, config, existingPipelines?, existingResources?): Promise<SkyAtmosphereLutRenderer>

• Asynchronously creates a SkyAtmosphereLutRenderer.

  All pipelines used by this renderer are created asynchronously.

  Parameters

  • device: GPUDevice

    The GPUDevice used to create internal resources (textures, pipelines, etc.).
  • config: SkyAtmosphereRendererConfig

    A SkyAtmosphereRendererConfig used to configure internal resources and behavior.
  • 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<SkyAtmosphereLutRenderer>