Class DecalMapConfiguration
Hierarchy
- MaterialPluginBase
- DecalMapConfiguration
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 DecalMapConfiguration
Parameters
material: StandardMaterial | PBRBaseMaterial
The material to attach the decal map plugin to
Optional addToPluginList: boolean
If the plugin should be added to the material plugin list
Returns DecalMapConfiguration
Properties
is
Enables or disables the decal map on this material
Readonly mark
Helper function to mark defines as being dirty.
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.
smooth
Enables or disables the smooth alpha mode on this material. Default: false. When enabled, the alpha value used to blend the decal map will be the squared value and will produce a smoother result.
Methods
add
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.
bind
Binds the material data.
Parameters
uniformBuffer: UniformBuffer
defines the Uniform buffer to fill in.
scene: Scene
defines the scene the material belongs to.
engine: Engine
the engine this scene belongs to.
subMesh: SubMesh
the submesh to bind data for
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
Forces the disposal of all textures.
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[]
Array of BaseTextures
Returns void
get
Returns the animatable textures.
Parameters
animatables: IAnimatable[]
Array of animatable textures.
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
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 }
Optional fragment?: string
Optional ubo?: { name: string; size: number; type: string }[]
Optional vertex?: string
hard
Note that we override hardBindForSubMesh and not bindForSubMesh because the material can be shared by multiple meshes, in which case mustRebind could return false even though the decal map is different for each mesh: that's because the decal map is not part of the material but hosted by the decalMap of the mesh instead.
Parameters
uniformBuffer: UniformBuffer
scene: Scene
_engine: Engine
subMesh: SubMesh
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
Base texture to use.
Returns boolean
- Boolean specifying if a texture is used in the material.
is
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: DecalMapDefines
scene: Scene
mesh: AbstractMesh
Returns void
prepare
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 plugin configuration.
Returns any
- An object with the serialized config.
Plugin that implements the decal map component of a material
5.49.1