PBRSheenConfiguration

Define the code related to the Sheen parameters of the pbr material.

Hierarchy

  • PBRSheenConfiguration

Index

Constructors

constructor

Find examples in Playground
  • Instantiate a new istance of clear coat configuration.

    Parameters

    • markAllSubMeshesAsTexturesDirty: function

      Callback to flag the material to dirty

        • (): void
        • Returns void

    Returns PBRSheenConfiguration

Properties

color

Find examples in Playground
color: Color3

Defines the sheen color.

intensity

Find examples in Playground
intensity: number

Defines the sheen intensity.

isEnabled

Find examples in Playground
isEnabled: boolean

Defines if the material uses sheen.

linkSheenWithAlbedo

Find examples in Playground
linkSheenWithAlbedo: boolean

Defines if the sheen is linked to the sheen color.

texture

Find examples in Playground

Stores the sheen tint values in a texture. rgb is tint a is a intensity

Methods

bindForSubMesh

Find examples in Playground
  • Binds the material data.

    Parameters

    • uniformBuffer: UniformBuffer

      defines the Uniform buffer to fill in.

    • scene: Scene

      defines the scene the material belongs to.

    • isFrozen: boolean

      defines wether the material is frozen or not.

    Returns void

copyTo

Find examples in Playground
  • Makes a duplicate of the current configuration into another one.

    Parameters

    Returns void

dispose

Find examples in Playground
  • dispose(forceDisposeTextures?: boolean): void
  • Disposes the resources of the material.

    Parameters

    • Optional forceDisposeTextures: boolean

      Forces the disposal of all textures.

    Returns void

getActiveTextures

Find examples in Playground
  • getActiveTextures(activeTextures: BaseTexture[]): void
  • Returns an array of the actively used textures.

    Parameters

    Returns void

getAnimatables

Find examples in Playground
  • Returns the animatable textures.

    Parameters

    • animatables: IAnimatable[]

      Array of animatable textures.

    Returns void

getClassName

Find examples in Playground
  • getClassName(): string
  • Get the current class name of the texture useful for serialization or dynamic coding.

    Returns string

    "PBRSheenConfiguration"

hasTexture

Find examples in Playground
  • Checks to see if a texture is used in the material.

    Parameters

    Returns boolean

    • Boolean specifying if a texture is used in the material.

isReadyForSubMesh

Find examples in Playground
  • isReadyForSubMesh(defines: IMaterialSheenDefines, scene: Scene): boolean
  • Specifies that the submesh is ready to be used.

    Parameters

    • defines: IMaterialSheenDefines

      the list of "defines" to update.

    • scene: Scene

      defines the scene the material belongs to.

    Returns boolean

    • boolean indicating that the submesh is ready or not.

parse

Find examples in Playground
  • parse(source: any): void
  • Parses a Sheen Configuration from a serialized object.

    Parameters

    • source: any

      Serialized object.

    Returns void

prepareDefines

Find examples in Playground
  • prepareDefines(defines: IMaterialSheenDefines, scene: Scene): void
  • Checks to see if a texture is used in the material.

    Parameters

    • defines: IMaterialSheenDefines

      the list of "defines" to update.

    • scene: Scene

      defines the scene the material belongs to.

    Returns void

serialize

Find examples in Playground
  • serialize(): any
  • Serializes this BRDF configuration.

    Returns any

    • An object with the serialized config.

Static AddFallbacks

Find examples in Playground
  • AddFallbacks(defines: IMaterialSheenDefines, fallbacks: EffectFallbacks, currentRank: number): number
  • Add fallbacks to the effect fallbacks list.

    Parameters

    • defines: IMaterialSheenDefines

      defines the Base texture to use.

    • fallbacks: EffectFallbacks

      defines the current fallback list.

    • currentRank: number

      defines the current fallback rank.

    Returns number

    the new fallback rank.

Static AddSamplers

Find examples in Playground
  • AddSamplers(samplers: string[]): void
  • Add the required samplers to the current list.

    Parameters

    • samplers: string[]

      defines the current sampler list.

    Returns void

Static AddUniforms

Find examples in Playground
  • AddUniforms(uniforms: string[]): void
  • Add the required uniforms to the current list.

    Parameters

    • uniforms: string[]

      defines the current uniform list.

    Returns void

Static PrepareUniformBuffer

Find examples in Playground
  • Add the required uniforms to the current buffer.

    Parameters

    • uniformBuffer: UniformBuffer

      defines the current uniform buffer.

    Returns void

Generated using TypeDoc