Class PBRSubSurfaceConfiguration
Hierarchy
- MaterialPluginBase
- PBRSubSurfaceConfiguration
Index
Constructors
Properties
- diffusion
Distance - index
Of Refraction - invert
RefractionY - is
Refraction Enabled - is
Scattering Enabled - is
Translucency Enabled - link
Refraction With Transparency - mark
All Defines As Dirty - maximum
Thickness - minimum
Thickness - name
- priority
- refraction
Intensity - refraction
Intensity Texture - refraction
Texture - register
For Extra Events - resolve
Includes - thickness
Texture - tint
Color - tint
Color At Distance - translucency
Intensity - translucency
Intensity Texture - use
Albedo To Tint Refraction - use
Albedo To Tint Translucency - use
Gltf Style Textures - use
Mask From Thickness Texture - use
Thickness As Depth
Accessors
Methods
- add
Fallbacks - bind
For Sub Mesh - collect
Defines - copy
To - dispose
- fill
Render Target Textures - get
Active Textures - get
Animatables - get
Attributes - get
Class Name - get
Custom Code - get
Samplers - get
Uniform Buffers Names - get
Uniforms - hard
Bind For Sub Mesh - has
Render Target Textures - has
Texture - is
Ready For Sub Mesh - parse
- prepare
Defines - prepare
Defines Before Attributes - serialize
Constructors
constructor
Creates a new material plugin
Parameters
material: PBRBaseMaterial
Optional addToPluginList: boolean
Returns PBRSubSurfaceConfiguration
Properties
diffusion
Defines how far each channel transmit through the media. It is defined as a color to simplify it selection.
index
Index of refraction of the material base layer. https://en.wikipedia.org/wiki/List_of_refractive_indices
This does not only impact refraction but also the Base F0 of Dielectric Materials.
From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
invert
Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
is
Defines if the refraction is enabled in the material.
is
Defines if the sub surface scattering is enabled in the material.
is
Defines if the translucency is enabled in the material.
link
This parameters will make the material used its opacity to control how much it is refracting against not. Materials half opaque for instance using refraction could benefit from this control.
Readonly mark
Type declaration
Helper function to mark defines as being dirty.
Returns void
maximum
Defines the maximum thickness stored in the thickness map.
minimum
Defines the minimum thickness stored in the thickness map. If no thickness map is defined, this value will be used to simulate thickness.
nameSearch playground for name
Defines the name of the plugin
prioritySearch playground for priority
Defines the priority of the plugin. Lower numbers run first.
refraction
Defines the refraction intensity of the material. The refraction when enabled replaces the Diffuse part of the material. The intensity helps transitioning between diffuse and refraction.
refraction
Stores the intensity of the refraction. If provided, it takes precedence over thicknessTexture + useMaskFromThicknessTexture
- the green (red if useGltfStyleTextures = true) channel is the refraction intensity.
refraction
Defines the texture to use for refraction.
register
Indicates that this plugin should be notified for the extra events (HasRenderTargetTextures / FillRenderTargetTextures / HardBindForSubMesh)
resolve
Indicates that any #include directive in the plugin code must be replaced by the corresponding code.
thickness
Stores the average thickness of a mesh in a texture (The texture is holding the values linearly). The red (or green if useGltfStyleTextures=true) channel of the texture should contain the thickness remapped between 0 and 1. 0 would mean minimumThickness 1 would mean maximumThickness The other channels might be use as a mask to vary the different effects intensity.
tint
Defines the volume tint of the material. This is used for both translucency and scattering.
tint
Defines the distance at which the tint color should be found in the media. This is used for refraction only.
translucency
Defines the translucency intensity of the material. When translucency has been enabled, this defines how much of the "translucency" is added to the diffuse part of the material.
translucency
Stores the intensity of the translucency. If provided, it takes precedence over thicknessTexture + useMaskFromThicknessTexture
- the blue channel is the translucency intensity.
use
When enabled, transparent surfaces will be tinted with the albedo colour (independent of thickness)
use
When enabled, translucent surfaces will be tinted with the albedo colour (independent of thickness)
use
Use channels layout used by glTF:
- thicknessTexture: the green (instead of red) channel is the thickness
- thicknessTexture/refractionIntensityTexture: the red (instead of green) channel is the refraction intensity
- thicknessTexture/translucencyIntensityTexture: no change, use the blue channel for the translucency intensity
use
Stores the intensity of the different subsurface effects in the thickness texture. Note that if refractionIntensityTexture and/or translucencyIntensityTexture is provided it takes precedence over thicknessTexture + useMaskFromThicknessTexture
- the green (red if useGltfStyleTextures = true) channel is the refraction intensity.
- the blue channel is the translucency intensity.
use
Defines that the thickness should be used as a measure of the depth volume.
Accessors
disable
Returns true if alpha blending should be disabled.
Returns boolean
scattering
volume
Index of refraction of the material's volume. https://en.wikipedia.org/wiki/List_of_refractive_indices
This ONLY impacts refraction. If not provided or given a non-valid value, the volume will use the same IOR as the surface.
Returns number
Index of refraction of the material's volume. https://en.wikipedia.org/wiki/List_of_refractive_indices
This ONLY impacts refraction. If not provided or given a non-valid value, the volume will use the same IOR as the surface.
Parameters
value: number
Returns void
Methods
add
Add fallbacks to the effect fallbacks list.
Parameters
defines: MaterialSubSurfaceDefines
fallbacks: EffectFallbacks
currentRank: number
Returns number
the new fallback rank.
bind
Binds the material data.
Parameters
uniformBuffer: UniformBuffer
scene: Scene
engine: Engine
subMesh: SubMesh
Returns void
collect
Collects all defines.
Parameters
defines: {}
The object to append to.
[name: string]: { default: any; type: string }
default: any
type: string
Returns void
copy
Makes a duplicate of the current configuration into another one.
Parameters
plugin: MaterialPluginBase
define the config where to copy the info
Returns void
disposeSearch playground for dispose
Disposes the resources of the material.
Parameters
Optional forceDisposeTextures: boolean
Returns void
fill
Fills the list of render target textures.
Parameters
renderTargets: SmartArray<RenderTargetTexture>
the list of render targets to update
Returns void
get
Returns an array of the actively used textures.
Parameters
activeTextures: BaseTexture[]
Returns void
get
Returns the animatable textures.
Parameters
animatables: IAnimatable[]
Returns void
get
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
get
Gets the current class name useful for serialization or dynamic coding.
Returns string
The class name.
get
Returns a list of custom shader code fragments to customize the shader.
Parameters
shaderType: string
"vertex" or "fragment"
Returns Nullable<{}>
null if no code to be added, or a list of pointName => code. Note that
pointNamecan 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.
get
Gets the samplers used by the plugin.
Parameters
samplers: string[]
Returns void
get
Gets the uniform buffers names added by the plugin.
Parameters
ubos: string[]
list that the ubo names should be added to.
Returns void
get
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)
Returns { fragment?: string; ubo?: { name: string; size: number; type: string }[]; vertex?: string }
the description of the uniforms
Optional fragment?: string
Optional ubo?: { name: string; size: number; type: string }[]
Optional vertex?: string
hard
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: Engine
defines the engine the material belongs to.
subMesh: SubMesh
the submesh to bind data for
Returns void
has
Gets a boolean indicating that current material needs to register RTT
Returns boolean
true if this uses a render target otherwise false.
has
Checks to see if a texture is used in the material.
Parameters
texture: BaseTexture
Returns boolean
- Boolean specifying if a texture is used in the material.
is
Specifies that the submesh is ready to be used.
Parameters
defines: MaterialSubSurfaceDefines
scene: Scene
Returns boolean
- boolean indicating that the submesh is ready or not.
parseSearch playground for parse
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
prepare
Sets the defines for the next rendering
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
prepare
Sets the defines for the next rendering. Called before MaterialHelper.PrepareDefinesForAttributes is called.
Parameters
defines: MaterialSubSurfaceDefines
scene: Scene
Returns void
serializeSearch playground for serialize
Serializes this plugin configuration.
Returns any
- An object with the serialized config.
Plugin that implements the sub surface component of the PBR material