API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DetailMapConfiguration

Define the code related to the detail map parameters of a material

Inspired from: Unity: https://docs.unity3d.com/Packages/com.unity.render-pipelines.high-definition@9.0/manual/Mask-Map-and-Detail-Map.html and https://docs.unity3d.com/Manual/StandardShaderMaterialParameterDetail.html Unreal: https://docs.unrealengine.com/en-US/Engine/Rendering/Materials/HowTo/DetailTexturing/index.html Cryengine: https://docs.cryengine.com/display/SDKDOC2/Detail+Maps

Hierarchy

  • DetailMapConfiguration

Index

Constructors

Properties

Methods

Constructors

constructor

  • Instantiate a new detail map

    Parameters

    • markAllSubMeshesAsTexturesDirty: () => void

      Callback to flag the material to dirty

        • (): void

        • Returns void

    Returns DetailMapConfiguration

Properties

bumpLevelSearch playground for bumpLevel

bumpLevel: number

Defines how strong the bump effect from the detail map is Bigger values mean stronger effect

diffuseBlendLevelSearch playground for diffuseBlendLevel

diffuseBlendLevel: number

Defines how strongly the detail diffuse/albedo channel is blended with the regular diffuse/albedo texture Bigger values mean stronger blending

isEnabledSearch playground for isEnabled

isEnabled: boolean

Enable or disable the detail map on this material

normalBlendMethodSearch playground for normalBlendMethod

normalBlendMethod: number

The method used to blend the bump and detail normals together

roughnessBlendLevelSearch playground for roughnessBlendLevel

roughnessBlendLevel: number

Defines how strongly the detail roughness channel is blended with the regular roughness value Bigger values mean stronger blending. Only used with PBR materials

textureSearch playground for texture

texture: Nullable<BaseTexture>

The detail texture of the material.

Methods

bindForSubMeshSearch playground for bindForSubMesh

  • 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 whether the material is frozen or not.

    Returns void

copyToSearch playground for copyTo

  • Makes a duplicate of the current instance into another one.

    Parameters

    Returns void

disposeSearch playground for dispose

  • dispose(forceDisposeTextures?: boolean): void

  • Disposes the resources of the material.

    Parameters

    • Optional forceDisposeTextures: boolean

      Forces the disposal of all textures.

    Returns void

getActiveTexturesSearch playground for getActiveTextures

  • getActiveTextures(activeTextures: BaseTexture[]): void

  • Returns an array of the actively used textures.

    Parameters

    Returns void

getAnimatablesSearch playground for getAnimatables

  • Returns the animatable textures.

    Parameters

    • animatables: IAnimatable[]

      Array of animatable textures.

    Returns void

getClassNameSearch playground for getClassName

  • getClassName(): string

  • Get the current class name useful for serialization or dynamic coding.

    Returns string

    "DetailMap"

hasTextureSearch playground for hasTexture

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

    Parameters

    Returns boolean

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

isReadyForSubMeshSearch playground for isReadyForSubMesh

  • isReadyForSubMesh(defines: IMaterialDetailMapDefines, scene: Scene): boolean

  • Gets whether the submesh is ready to be used or not.

    Parameters

    • defines: IMaterialDetailMapDefines

      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.

parseSearch playground for parse

  • parse(source: any, scene: Scene, rootUrl: string): void

  • Parses a detail map setting from a serialized object.

    Parameters

    • source: any

      Serialized object.

    • scene: Scene

      Defines the scene we are parsing for

    • rootUrl: string

      Defines the rootUrl to load from

    Returns void

prepareDefinesSearch playground for prepareDefines

  • prepareDefines(defines: IMaterialDetailMapDefines, scene: Scene): void

  • Update the defines for detail map usage

    Parameters

    • defines: IMaterialDetailMapDefines

      the list of "defines" to update.

    • scene: Scene

      defines the scene the material belongs to.

    Returns void

serializeSearch playground for serialize

  • serialize(): any

  • Serializes this detail map instance

    Returns any

    • An object with the serialized instance.

Static AddSamplersSearch playground for AddSamplers

  • AddSamplers(samplers: string[]): void

  • Add the required samplers to the current list.

    Parameters

    • samplers: string[]

      defines the current sampler list.

    Returns void

Static AddUniformsSearch playground for AddUniforms

  • AddUniforms(uniforms: string[]): void

  • Add the required uniforms to the current list.

    Parameters

    • uniforms: string[]

      defines the current uniform list.

    Returns void

Static PrepareUniformBufferSearch playground for PrepareUniformBuffer

  • Add the required uniforms to the current buffer.

    Parameters

    • uniformBuffer: UniformBuffer

      defines the current uniform buffer.

    Returns void

Legend

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