Class PBRIridescenceConfiguration
Hierarchy
-
MaterialPluginBase
- PBRIridescenceConfiguration
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
-
Parameters
-
material: PBRBaseMaterial
-
Optional addToPluginList: boolean
Returns PBRIridescenceConfiguration
-
Properties
index OfRefractionSearch playground for indexOfRefraction
Defines the maximum thickness of the thin-film layer given in nanometers (nm).
intensitySearch playground for intensity
Defines the iridescence layer strength (between 0 and 1) it defaults to 1.
is EnabledSearch playground for isEnabled
Defines if the iridescence is enabled in the material.
Readonly mark All Defines AsDirtySearch playground for markAllDefinesAsDirty
Helper function to mark defines as being dirty.
Type declaration
-
-
Returns void
-
maximum ThicknessSearch playground for maximumThickness
Defines the maximum thickness of the thin-film layer given in nanometers (nm). This will be the thickness used if not thickness texture has been set.
minimum ThicknessSearch playground for minimumThickness
Defines the minimum thickness of the thin-film layer given in nanometers (nm).
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 For Extra EventsSearch playground for registerForExtraEvents
Indicates that this plugin should be notified for the extra events (HasRenderTargetTextures / FillRenderTargetTextures / HardBindForSubMesh)
textureSearch playground for texture
Stores the iridescence intensity in a texture (red channel)
thickness TextureSearch playground for thicknessTexture
Stores the iridescence thickness in a texture (green channel)
Methods
add FallbacksSearch playground for addFallbacks
-
Parameters
-
defines: MaterialIridescenceDefines
-
fallbacks: EffectFallbacks
-
currentRank: number
Returns number
-
bind For Sub MeshSearch playground for bindForSubMesh
-
Parameters
-
uniformBuffer: UniformBuffer
-
scene: Scene
-
engine: Engine
-
subMesh: SubMesh
Returns void
-
collect DefinesSearch playground for collectDefines
-
Collects all defines.
Parameters
-
defines: {}
The object to append to.
-
[name: string]: { default: any; type: string }
-
default: any
-
type: string
-
-
Returns void
-
copy ToSearch playground for copyTo
-
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
-
Parameters
-
Optional forceDisposeTextures: boolean
Returns void
-
fill Render Target TexturesSearch playground for fillRenderTargetTextures
-
Fills the list of render target textures.
Parameters
-
renderTargets: SmartArray<RenderTargetTexture>
the list of render targets to update
Returns void
-
get Active TexturesSearch playground for getActiveTextures
-
Parameters
-
activeTextures: BaseTexture[]
Returns void
-
get AnimatablesSearch playground for getAnimatables
-
Parameters
-
animatables: IAnimatable[]
Returns void
-
get AttributesSearch playground for getAttributes
-
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 Class NameSearch playground for getClassName
-
Returns string
get Custom CodeSearch playground for getCustomCode
-
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
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. -
get SamplersSearch playground for getSamplers
-
Parameters
-
samplers: string[]
Returns void
-
get Uniform Buffers NamesSearch playground for getUniformBuffersNames
-
Gets the uniform buffers names added by the plugin.
Parameters
-
ubos: string[]
list that the ubo names should be added to.
Returns void
-
get UniformsSearch playground for getUniforms
-
Returns { fragment?: string; ubo?: Array<{ name: string; size: number; type: string }>; vertex?: string }
-
Optional fragment?: string
-
Optional ubo?: Array<{ name: string; size: number; type: string }>
-
Optional vertex?: string
-
hard Bind For Sub MeshSearch playground for hardBindForSubMesh
-
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 Render Target TexturesSearch playground for hasRenderTargetTextures
-
Gets a boolean indicating that current material needs to register RTT
Returns boolean
true if this uses a render target otherwise false.
has TextureSearch playground for hasTexture
-
Parameters
-
texture: BaseTexture
Returns boolean
-
is Ready For Sub MeshSearch playground for isReadyForSubMesh
-
Parameters
-
defines: MaterialIridescenceDefines
-
scene: Scene
Returns boolean
-
parseSearch playground for parse
-
Parses a anisotropy 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 DefinesSearch playground for prepareDefines
-
Parameters
-
defines: MaterialIridescenceDefines
-
scene: Scene
Returns void
-
prepare Defines Before AttributesSearch playground for prepareDefinesBeforeAttributes
-
Sets the defines for the next rendering. Called before MaterialHelper.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
-
serializeSearch playground for serialize
-
Serializes this clear coat configuration.
Returns any
- An object with the serialized config.
Plugin that implements the iridescence (thin film) component of the PBR material