• Public
  • Public/Protected
  • All

Interface IWebXRLightEstimationOptions

Options for Light Estimation feature


  • IWebXRLightEstimationOptions



Optional createDirectionalLightSourceSearch playground for createDirectionalLightSource

createDirectionalLightSource: boolean

Should a directional light source be created. If created, this light source will be updated whenever the light estimation values change

Optional cubeMapPollIntervalSearch playground for cubeMapPollInterval

cubeMapPollInterval: number

How often should the cubemap update in ms. If not set the cubemap will be updated every time the underlying system updates the environment texture.

Optional disableCubeMapReflectionSearch playground for disableCubeMapReflection

disableCubeMapReflection: boolean

Disable the cube map reflection feature. In this case only light direction and color will be updated

Optional disableSphericalPolynomialSearch playground for disableSphericalPolynomial

disableSphericalPolynomial: boolean

disable applying the spherical polynomial to the cube map texture

Optional disableVectorReuseSearch playground for disableVectorReuse

disableVectorReuse: boolean

Should the light estimation's needed vectors be constructed on each frame. Use this when you use those vectors and don't want their values to change outside of the light estimation feature

Optional lightEstimationPollIntervalSearch playground for lightEstimationPollInterval

lightEstimationPollInterval: number

How often should the light estimation properties update in ms. If not set the light estimation properties will be updated on every frame (depending on the underlying system)

Optional reflectionFormatSearch playground for reflectionFormat

reflectionFormat: XRReflectionFormat

Define the format to be used for the light estimation texture.

Optional setSceneEnvironmentTextureSearch playground for setSceneEnvironmentTexture

setSceneEnvironmentTexture: boolean

Should the scene's env texture be set to the cube map reflection texture Note that this doesn't work is disableCubeMapReflection if set to false


  • Constructor
  • Property
  • Method
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Static property
  • Static method