Class ReflectionProbe

constructor

• new ReflectionProbe(
      name: string,
      size: number,
      scene: Scene,
      generateMipMaps?: boolean,
      useFloat?: boolean,
      linearSpace?: boolean,
  ): ReflectionProbe

  Creates a new reflection probe

  Parameters

  • name: string

    defines the name of the probe

  • size: number

    defines the texture resolution (for each face)

  • scene: Scene

    defines the hosting scene

  • generateMipMaps: boolean = true

    defines if mip maps should be generated automatically (true by default)

  • useFloat: boolean = false

    defines if HDR data (float data) should be used to store colors (false by default)

  • linearSpace: boolean = false

    defines if the probe should be generated in linear space or not (false by default)

  Returns ReflectionProbe

metadata

name

position

cubeTexture

• get cubeTexture(): RenderTargetTexture

  Gets the internal CubeTexture used to render to

  Returns RenderTargetTexture

refreshRate

• get refreshRate(): number

  Gets or sets the refresh rate to use (on every frame by default)

  Returns number

• set refreshRate(value: number): void

  Parameters

  • value: number

  Returns void

renderList

• get renderList(): Nullable<AbstractMesh[]>

  Gets or sets the list of meshes to render

  Returns Nullable<AbstractMesh[]>

• set renderList(value: Nullable<AbstractMesh[]>): void

  Parameters

  • value: Nullable<AbstractMesh[]>

  Returns void

samples

• get samples(): number

  Gets or sets the number of samples to use for multi-sampling (0 by default). Required WebGL2

  Returns number

• set samples(value: number): void

  Parameters

  • value: number

  Returns void

attachToMesh

• attachToMesh(mesh: Nullable<AbstractMesh>): void

  Attach the probe to a specific mesh (Rendering will be done from attached mesh's position)

  Parameters

  • mesh: Nullable<AbstractMesh>

    defines the mesh to attach to

  Returns void

dispose

• dispose(): void

  Clean all associated resources

  Returns void

getClassName

• getClassName(): string

  Get the class name of the refection probe.

  Returns string

  "ReflectionProbe"

getScene

• getScene(): Scene

  Gets the hosting scene

  Returns Scene

  a Scene

serialize

• serialize(): any

  Serialize the reflection probe to a JSON representation we can easily use in the respective Parse function.

  Returns any

  The JSON representation of the texture

setRenderingAutoClearDepthStencil

• setRenderingAutoClearDepthStencil(
      renderingGroupId: number,
      autoClearDepthStencil: boolean,
  ): void

  Specifies whether or not the stencil and depth buffer are cleared between two rendering groups

  Parameters

  • renderingGroupId: number

    The rendering group id corresponding to its index

  • autoClearDepthStencil: boolean

    Automatically clears depth and stencil between groups if true.

  Returns void

toString

• toString(fullDetails?: boolean): string

  Converts the reflection probe information to a readable string for debug purpose.

  Parameters

  • OptionalfullDetails: boolean

    Supports for multiple levels of logging within scene loading

  Returns string

  the human readable reflection probe info