PBRBRDFConfiguration | Babylon.js API documentation

Class PBRBRDFConfiguration

Plugin that implements the BRDF component of the PBR material

Hierarchy (View Summary)

MaterialPluginBase
- PBRBRDFConfiguration

Index

Constructors

Properties

doNotSerialize markAllDefinesAsDirty mixIblRadianceWithIrradiance name priority registerForExtraEvents resolveIncludes useEnergyConservation useSmithVisibilityHeightCorrelated useSpecularGlossinessInputEnergyConservation useSphericalHarmonics DEFAULT_MIX_IBL_RADIANCE_WITH_IRRADIANCE DEFAULT_USE_ENERGY_CONSERVATION DEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED DEFAULT_USE_SPECULAR_GLOSSINESS_INPUT_ENERGY_CONSERVATION DEFAULT_USE_SPHERICAL_HARMONICS

Constructors

constructor

new PBRBRDFConfiguration(
material: PBRBaseMaterial,
addToPluginList?: boolean,
): PBRBRDFConfiguration
Parameters
- material: PBRBaseMaterial
- OptionaladdToPluginList: boolean
Returns PBRBRDFConfiguration
Overrides MaterialPluginBase.constructor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:83199

Properties

doNotSerialize

doNotSerialize: boolean

Specifies if the material plugin should be serialized, true to skip serialization

`Readonly`markAllDefinesAsDirty

markAllDefinesAsDirty: () => void

Helper function to mark defines as being dirty.

mixIblRadianceWithIrradiance

mixIblRadianceWithIrradiance: boolean

Defines if IBL irradiance is used to augment rough radiance. If activated, irradiance is blended into the radiance contribution when the material is rough. This better approximates raytracing results for rough surfaces.

name

name: string

Defines the name of the plugin

priority

priority: number

Defines the priority of the plugin. Lower numbers run first.

registerForExtraEvents

registerForExtraEvents: boolean

Indicates that this plugin should be notified for the extra events (HasRenderTargetTextures / FillRenderTargetTextures / HardBindForSubMesh)

resolveIncludes

resolveIncludes: boolean

Indicates that any #include directive in the plugin code must be replaced by the corresponding code.

useEnergyConservation

useEnergyConservation: boolean

Defines if the material uses energy conservation.

useSmithVisibilityHeightCorrelated

useSmithVisibilityHeightCorrelated: boolean

LEGACY Mode set to false Defines if the material uses height smith correlated visibility term. If you intent to not use our default BRDF, you need to load a separate BRDF Texture for the PBR You can either load https://assets.babylonjs.com/environments/uncorrelatedBRDF.png or https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds to have more precision Not relying on height correlated will also disable energy conservation.

useSpecularGlossinessInputEnergyConservation

useSpecularGlossinessInputEnergyConservation: boolean

Defines if the material uses energy conservation, when the specular workflow is active. If activated, the albedo color is multiplied with (1. - maxChannel(specular color)). If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1. In the deactivated case, the material author has to ensure energy conservation, for a physically plausible rendering.

useSphericalHarmonics

useSphericalHarmonics: boolean

LEGACY Mode set to false Defines if the material uses spherical harmonics vs spherical polynomials for the diffuse part of the IBL. The harmonics despite a tiny bigger cost has been proven to provide closer results to the ground truth.

`Static`DEFAULT_MIX_IBL_RADIANCE_WITH_IRRADIANCE

DEFAULT_MIX_IBL_RADIANCE_WITH_IRRADIANCE: boolean

Default value for whether IBL irradiance is used to augment rough radiance. If activated, irradiance is blended into the radiance contribution when the material is rough. This better approximates raytracing results for rough surfaces.

`Static`DEFAULT_USE_ENERGY_CONSERVATION

DEFAULT_USE_ENERGY_CONSERVATION: boolean

Default value used for the energy conservation. This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.

`Static`DEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED

DEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED: boolean

Default value used for the Smith Visibility Height Correlated mode. This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.

`Static`DEFAULT_USE_SPECULAR_GLOSSINESS_INPUT_ENERGY_CONSERVATION

DEFAULT_USE_SPECULAR_GLOSSINESS_INPUT_ENERGY_CONSERVATION: boolean

Default value used for activating energy conservation for the specular workflow. If activated, the albedo color is multiplied with (1. - maxChannel(specular color)). If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.

`Static`DEFAULT_USE_SPHERICAL_HARMONICS

DEFAULT_USE_SPHERICAL_HARMONICS: boolean

Default value used for the IBL diffuse part. This can help switching back to the polynomials mode globally which is a tiny bit less GPU intensive at the drawback of a lower quality.

Methods

addFallbacks

addFallbacks(
    defines: MaterialDefines,
    fallbacks: EffectFallbacks,
    currentRank: number,
): number
Add fallbacks to the effect fallbacks list.
Parameters
- defines: MaterialDefines
  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.
Inherited from MaterialPluginBase.addFallbacks
- Defined in .temp/typedoc/docdirectory/doc.d.ts:71768

bindForSubMesh

bindForSubMesh(
    _uniformBuffer: UniformBuffer,
    _scene: Scene,
    _engine: AbstractEngine,
    _subMesh: SubMesh,
): void
Binds the material data.
Parameters
- _uniformBuffer: UniformBuffer
  defines the Uniform buffer to fill in.
- _scene: Scene
  defines the scene the material belongs to.
- _engine: AbstractEngine
  the engine this scene belongs to.
- _subMesh: SubMesh
  the submesh to bind data for
Returns void
Inherited from MaterialPluginBase.bindForSubMesh
- Defined in .temp/typedoc/docdirectory/doc.d.ts:71693

collectDefines

collectDefines(
defines: { [name: string]: { default: any; type: string } },
): void
Collects all defines.
Parameters
- defines: { [name: string]: { default: any; type: string } }
  The object to append to.
Returns void
Inherited from MaterialPluginBase.collectDefines
- Defined in .temp/typedoc/docdirectory/doc.d.ts:71715

copyTo

copyTo(plugin: MaterialPluginBase): void
Makes a duplicate of the current configuration into another one.
Parameters
- plugin: MaterialPluginBase
  define the config where to copy the info
Returns void
Inherited from MaterialPluginBase.copyTo
- Defined in .temp/typedoc/docdirectory/doc.d.ts:71805

dispose

dispose(_forceDisposeTextures?: boolean): void
Disposes the resources of the material.
Parameters
- Optional_forceDisposeTextures: boolean
  Forces the disposal of all textures.
Returns void
Inherited from MaterialPluginBase.dispose
- Defined in .temp/typedoc/docdirectory/doc.d.ts:71698

fillRenderTargetTextures

fillRenderTargetTextures(_renderTargets: SmartArray<RenderTargetTexture>): void
Fills the list of render target textures.
Parameters
- _renderTargets: SmartArray<RenderTargetTexture>
  the list of render targets to update
Returns void
Inherited from MaterialPluginBase.fillRenderTargetTextures
- Defined in .temp/typedoc/docdirectory/doc.d.ts:71750

getActiveTextures

getActiveTextures(_activeTextures: BaseTexture[]): void
Returns an array of the actively used textures.
Parameters
- _activeTextures: BaseTexture[]
  Array of BaseTextures
Returns void
Inherited from MaterialPluginBase.getActiveTextures
- Defined in .temp/typedoc/docdirectory/doc.d.ts:71755

getAnimatables

getAnimatables(_animatables: IAnimatable[]): void
Returns the animatable textures.
Parameters
- _animatables: IAnimatable[]
  Array of animatable textures.
Returns void
Inherited from MaterialPluginBase.getAnimatables
- Defined in .temp/typedoc/docdirectory/doc.d.ts:71760

getAttributes

getAttributes(_attributes: string[], _scene: Scene, _mesh: AbstractMesh): void
Gets the attributes used by the plugin.
Parameters
- _attributes: string[]
  list that the attribute names should be added to.
- _scene: Scene
  the scene that the material belongs to.
- _mesh: AbstractMesh
  the mesh being rendered.
Returns void
Inherited from MaterialPluginBase.getAttributes
- Defined in .temp/typedoc/docdirectory/doc.d.ts:71780

getClassName

getClassName(): string
Gets the current class name useful for serialization or dynamic coding.

Returns string
The class name.
Overrides MaterialPluginBase.getClassName
- Defined in .temp/typedoc/docdirectory/doc.d.ts:83201

getCustomCode

getCustomCode(
_shaderType: string,
_shaderLanguage?: ShaderLanguage,
): Nullable<{ [pointName: string]: string }>
Returns a list of custom shader code fragments to customize the shader.
Parameters
- _shaderType: string
  "vertex" or "fragment"
- Optional_shaderLanguage: ShaderLanguage
  The shader language to use.
Returns Nullable<{ [pointName: string]: string }>
null if no code to be added, or a list of pointName => code. Note that pointName can also be a regular expression if it starts with a !. In that case, the string found by the regular expression (if any) will be replaced by the code provided.
Inherited from MaterialPluginBase.getCustomCode
- Defined in .temp/typedoc/docdirectory/doc.d.ts:71708

getSamplers

getSamplers(_samplers: string[]): void
Gets the samplers used by the plugin.
Parameters
- _samplers: string[]
  list that the sampler names should be added to.
Returns void
Inherited from MaterialPluginBase.getSamplers
- Defined in .temp/typedoc/docdirectory/doc.d.ts:71773

getUniformBuffersNames

getUniformBuffersNames(_ubos: string[]): void
Gets the uniform buffers names added by the plugin.
Parameters
- _ubos: string[]
  list that the ubo names should be added to.
Returns void
Inherited from MaterialPluginBase.getUniformBuffersNames
- Defined in .temp/typedoc/docdirectory/doc.d.ts:71785

getUniforms

getUniforms(
    _shaderLanguage?: ShaderLanguage,
): {
    fragment?: string;
    ubo?: { arraySize?: number; name: string; size?: number; type?: string }[];
    vertex?: string;
}
Gets the description of the uniforms to add to the ubo (if engine supports ubos) or to inject directly in the vertex/fragment shaders (if engine does not support ubos)
Parameters
- Optional_shaderLanguage: ShaderLanguage
  The shader language to use.
Returns {
    fragment?: string;
    ubo?: { arraySize?: number; name: string; size?: number; type?: string }[];
    vertex?: string;
}
the description of the uniforms
Inherited from MaterialPluginBase.getUniforms
- Defined in .temp/typedoc/docdirectory/doc.d.ts:71791

hardBindForSubMesh

hardBindForSubMesh(
    _uniformBuffer: UniformBuffer,
    _scene: Scene,
    _engine: AbstractEngine,
    _subMesh: SubMesh,
): void
Binds the material data (this function is called even if mustRebind() returns false)
Parameters
- _uniformBuffer: UniformBuffer
  defines the Uniform buffer to fill in.
- _scene: Scene
  defines the scene the material belongs to.
- _engine: AbstractEngine
  defines the engine the material belongs to.
- _subMesh: SubMesh
  the submesh to bind data for
Returns void
Inherited from MaterialPluginBase.hardBindForSubMesh
- Defined in .temp/typedoc/docdirectory/doc.d.ts:71685

hasRenderTargetTextures

hasRenderTargetTextures(): boolean
Gets a boolean indicating that current material needs to register RTT

Returns boolean
true if this uses a render target otherwise false.
Inherited from MaterialPluginBase.hasRenderTargetTextures
- Defined in .temp/typedoc/docdirectory/doc.d.ts:71745

hasTexture

hasTexture(_texture: BaseTexture): boolean
Checks to see if a texture is used in the material.
Parameters
- _texture: BaseTexture
  Base texture to use.
Returns boolean
- Boolean specifying if a texture is used in the material.
Inherited from MaterialPluginBase.hasTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:71740

isCompatible

isCompatible(): boolean
Gets a boolean indicating that the plugin is compatible with a given shader language.

Returns boolean
true if the plugin is compatible with the shader language
Overrides MaterialPluginBase.isCompatible
- Defined in .temp/typedoc/docdirectory/doc.d.ts:83198

isReadyForSubMesh

isReadyForSubMesh(
    _defines: MaterialDefines,
    _scene: Scene,
    _engine: AbstractEngine,
    _subMesh: SubMesh,
): boolean
Specifies that the submesh is ready to be used.
Parameters
- _defines: MaterialDefines
  the list of "defines" to update.
- _scene: Scene
  defines the scene the material belongs to.
- _engine: AbstractEngine
  the engine this scene belongs to.
- _subMesh: SubMesh
  the submesh to check for readiness
Returns boolean
- boolean indicating that the submesh is ready or not.
Inherited from MaterialPluginBase.isReadyForSubMesh
- Defined in .temp/typedoc/docdirectory/doc.d.ts:71677

parse

parse(source: any, scene: Scene, rootUrl: string): void
Parses a plugin configuration 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
Inherited from MaterialPluginBase.parse
- Defined in .temp/typedoc/docdirectory/doc.d.ts:71817

prepareDefines

prepareDefines(defines: MaterialBRDFDefines): void
Sets the defines for the next rendering
Parameters
- defines: MaterialBRDFDefines
Returns void
Overrides MaterialPluginBase.prepareDefines
- Defined in .temp/typedoc/docdirectory/doc.d.ts:83200

prepareDefinesBeforeAttributes

prepareDefinesBeforeAttributes(
    _defines: MaterialDefines,
    _scene: Scene,
    _mesh: AbstractMesh,
): void
Sets the defines for the next rendering. Called before PrepareDefinesForAttributes is called.
Parameters
- _defines: MaterialDefines
  the list of "defines" to update.
- _scene: Scene
  defines the scene to the material belongs to.
- _mesh: AbstractMesh
  the mesh being rendered
Returns void
Inherited from MaterialPluginBase.prepareDefinesBeforeAttributes
- Defined in .temp/typedoc/docdirectory/doc.d.ts:71727

serialize

serialize(): any
Serializes this plugin configuration.

Returns any
- An object with the serialized config.
Inherited from MaterialPluginBase.serialize
- Defined in .temp/typedoc/docdirectory/doc.d.ts:71810

Class PBRBRDFConfiguration

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PBRBRDFConfiguration

Properties

doNotSerialize

ReadonlymarkAllDefinesAsDirty

mixIblRadianceWithIrradiance

name

priority

registerForExtraEvents

resolveIncludes

useEnergyConservation

useSmithVisibilityHeightCorrelated

useSpecularGlossinessInputEnergyConservation

useSphericalHarmonics

StaticDEFAULT_MIX_IBL_RADIANCE_WITH_IRRADIANCE

StaticDEFAULT_USE_ENERGY_CONSERVATION

StaticDEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED

StaticDEFAULT_USE_SPECULAR_GLOSSINESS_INPUT_ENERGY_CONSERVATION

StaticDEFAULT_USE_SPHERICAL_HARMONICS

Methods

addFallbacks

Parameters

Returns number

bindForSubMesh

Parameters

Returns void

collectDefines

Parameters

Returns void

copyTo

Parameters

Returns void

dispose

Parameters

Returns void

fillRenderTargetTextures

Parameters

Returns void

getActiveTextures

Parameters

Returns void

getAnimatables

Parameters

Returns void

getAttributes

Parameters

Returns void

getClassName

Returns string

getCustomCode

Parameters

Returns Nullable<{ [pointName: string]: string }>

getSamplers

Parameters

Returns void

getUniformBuffersNames

Parameters

Returns void

getUniforms

Parameters

Returns { fragment?: string; ubo?: { arraySize?: number; name: string; size?: number; type?: string }[]; vertex?: string;}

hardBindForSubMesh

Parameters

Returns void

hasRenderTargetTextures

Returns boolean

hasTexture

Parameters

Returns boolean

isCompatible

Returns boolean

isReadyForSubMesh

`Readonly`markAllDefinesAsDirty

`Static`DEFAULT_MIX_IBL_RADIANCE_WITH_IRRADIANCE

`Static`DEFAULT_USE_ENERGY_CONSERVATION

`Static`DEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED

`Static`DEFAULT_USE_SPECULAR_GLOSSINESS_INPUT_ENERGY_CONSERVATION

`Static`DEFAULT_USE_SPHERICAL_HARMONICS

Returns {
fragment?: string;
ubo?: { arraySize?: number; name: string; size?: number; type?: string }[];
vertex?: string;
}