Class PBRSheenConfiguration
Hierarchy
- MaterialPluginBase
- PBRSheenConfiguration
Index
Constructors
Properties
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 PBRSheenConfiguration
Properties
albedo
If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique. It allows the strength of the sheen effect to not depend on the base color of the material, making it easier to setup and tweak the effect
colorSearch playground for color
Defines the sheen color.
intensitySearch playground for intensity
Defines the sheen intensity.
is
Defines if the material uses sheen.
link
Defines if the sheen is linked to the sheen color.
Readonly mark
Type declaration
Helper function to mark defines as being dirty.
Returns void
nameSearch playground for name
Defines the name of the plugin
prioritySearch playground for priority
Defines the priority of the plugin. Lower numbers run first.
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.
roughnessSearch playground for roughness
Defines the sheen roughness. It is not taken into account if linkSheenWithAlbedo is true. To stay backward compatible, material roughness is used instead if sheen roughness = null
textureSearch playground for texture
Stores the sheen tint values in a texture. rgb is tint a is a intensity or roughness if the roughness property has been defined and useRoughnessFromTexture is true (in that case, textureRoughness won't be used) If the roughness property has been defined and useRoughnessFromTexture is false then the alpha channel is not used to modulate roughness
texture
Stores the sheen roughness in a texture. alpha channel is the roughness. This texture won't be used if the texture property is not empty and useRoughnessFromTexture is true
use
Indicates that the alpha channel of the texture property will be used for roughness. Has no effect if the roughness (and texture!) property is not defined
Methods
add
Add fallbacks to the effect fallbacks list.
Parameters
defines: MaterialSheenDefines
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: MaterialSheenDefines
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: MaterialSheenDefines
scene: Scene
Returns void
serializeSearch playground for serialize
Serializes this plugin configuration.
Returns any
- An object with the serialized config.
Plugin that implements the sheen component of the PBR material.