Class MRDLBackplateMaterial
Hierarchy
- PushMaterial
- MRDLBackplateMaterial
Index
Constructors
Properties
- absolute
Sizes - allow
Shader Hot Swapping - animations
- base
Color - bottom
Left Gradient Color - bottom
Right Gradient Color - check
Ready On Every Call - check
Ready Only Once - custom
Shader Name Resolve - depth
Function - disable
Color Write - disable
Depth Write - do
Not Serialize - edge
Line Gradient Blend - edge
Power - edge
Width - fade
Out - force
Depth Write - get
Render Target Textures - gradient
Color - highlight
Color - highlight
Width - id
- inspectable
Custom Properties - iridescence
Edge Intensity - iridescence
Intensity - iridescence
Tint - line
Color - line
Width - metadata
- name
- on
Compiled - on
Dispose Observable - on
Error - plugin
Manager - point
Size - radius
- radius
Bottom Left - radius
Bottom Right - radius
Top Left - radius
Top Right - reserved
Data Store - separate
Culling Pass - shadow
Depth Wrapper - side
Orientation - state
- stencil
- top
Left Gradient Color - top
Right Gradient Color - unique
Id - z
Offset - z
Offset Units - All
Dirty Flag - Attributes
Dirty Flag - Clock
Wise Side Orientation - Counter
Clock Wise Side Orientation - Fresnel
Dirty Flag - IRIDESCENT_
MAP_ TEXTURE_ URL - Light
Dirty Flag - Line
List Draw Mode - Line
Loop Draw Mode - Line
Strip Draw Mode - MATERIAL_
ALPHABLEND - MATERIAL_
ALPHATEST - MATERIAL_
ALPHATESTANDBLEND - MATERIAL_
NORMALBLENDMETHOD_ RNM - MATERIAL_
NORMALBLENDMETHOD_ WHITEOUT - MATERIAL_
OPAQUE - Misc
Dirty Flag - On
Event Observable - Point
Fill Mode - Point
List Draw Mode - Pre
Pass Dirty Flag - Texture
Dirty Flag - Triangle
Fan Draw Mode - Triangle
Fill Mode - Triangle
Strip Draw Mode - Wire
Frame Fill Mode
Accessors
Methods
- atomic
Materials Update - bind
- bind
Eye Position - bind
For Sub Mesh - bind
Only Normal Matrix - bind
Only World Matrix - bind
View - bind
View Projection - build
Uniform Layout - clone
- dispose
- force
Compilation - force
Compilation Async - freeze
- get
Active Textures - get
Alpha Test Texture - get
Animatables - get
Binded Meshes - get
Class Name - get
Effect - get
Scene - has
Texture - is
Ready - is
Ready For Sub Mesh - mark
As Dirty - mark
Dirty - need
Alpha Blending - need
Alpha Blending For Mesh - need
Alpha Testing - reset
Draw Cache - serialize
- set
Pre Pass Renderer - to
String - unbind
- unfreeze
- Parse
Constructors
constructor
Parameters
name: string
Optional scene: Scene
Returns MRDLBackplateMaterial
Properties
absolute SizesSearch playground for absoluteSizes
Gets or sets whether to use absolute sizes when calculating effects on the backplate. Since desktop and VR/AR have different relative sizes, it's usually best to keep this false.
allow Shader Hot SwappingSearch playground for allowShaderHotSwapping
Gets or sets a boolean indicating that the material is allowed (if supported) to do shader hot swapping. This means that the material can keep using a previous shader while a new one is being compiled. This is mostly used when shader parallel compilation is supported (true by default)
animationsSearch playground for animations
Stores the animations for the material
base ColorSearch playground for baseColor
Gets or sets the base color of the backplate.
bottom Left Gradient ColorSearch playground for bottomLeftGradientColor
Gets or sets the bottom left gradient color effect on the backplate.
bottom Right Gradient ColorSearch playground for bottomRightGradientColor
Gets or sets the bottom right gradient color effect on the backplate.
check Ready On Every CallSearch playground for checkReadyOnEveryCall
Specifies if the ready state should be checked on each call
check Ready Only OnceSearch playground for checkReadyOnlyOnce
Specifies if the ready state should be checked once
custom Shader Name ResolveSearch playground for customShaderNameResolve
Type declaration
Custom callback helping to override the default shader used in the material.
Parameters
shaderName: string
uniforms: string[]
uniformBuffers: string[]
samplers: string[]
defines: string[] | MaterialDefines
Optional attributes: string[]
Optional options: ICustomShaderNameResolveOptions
Returns string
depth FunctionSearch playground for depthFunction
Specifies the depth function that should be used. 0 means the default engine function
disable Color WriteSearch playground for disableColorWrite
Specifies if color writing should be disabled
disable Depth WriteSearch playground for disableDepthWrite
Specifies if depth writing should be disabled
do Not SerializeSearch playground for doNotSerialize
Specifies if the material should be serialized
edge Line Gradient BlendSearch playground for edgeLineGradientBlend
Gets or sets the edge width of the backplate.
edge PowerSearch playground for edgePower
Gets or sets the edge width of the backplate.
edge WidthSearch playground for edgeWidth
Gets or sets the edge width of the backplate.
fade OutSearch playground for fadeOut
Gets or sets the opacity of the backplate (0.0 - 1.0).
force Depth WriteSearch playground for forceDepthWrite
Specifies if depth writing should be forced
get Render Target TexturesSearch playground for getRenderTargetTextures
Callback triggered to get the render target textures
gradient ColorSearch playground for gradientColor
Gets or sets the gradient color effect on the backplate.
highlight ColorSearch playground for highlightColor
Gets or sets the color of the highlights on the backplate line.
highlight WidthSearch playground for highlightWidth
Gets or sets the width of the highlights on the backplate line.
idSearch playground for id
The ID of the material
inspectable Custom PropertiesSearch playground for inspectableCustomProperties
List of inspectable custom properties (used by the Inspector)
iridescence Edge IntensitySearch playground for iridescenceEdgeIntensity
Gets or sets the intensity of the iridescence effect on the backplate edges.
iridescence IntensitySearch playground for iridescenceIntensity
Gets or sets the intensity of the iridescence effect.
iridescence TintSearch playground for iridescenceTint
Gets or sets the Tint of the iridescence effect on the backplate.
line ColorSearch playground for lineColor
Gets or sets the line color of the backplate.
line WidthSearch playground for lineWidth
Gets or sets the line width of the backplate.
metadataSearch playground for metadata
Gets or sets user defined metadata
nameSearch playground for name
The name of the material
on CompiledSearch playground for onCompiled
Callback triggered when the material is compiled
on Dispose ObservableSearch playground for onDisposeObservable
An event triggered when the material is disposed
on ErrorSearch playground for onError
Callback triggered when an error occurs
Optional plugin ManagerSearch playground for pluginManager
Plugin manager for this material
point SizeSearch playground for pointSize
Stores the size of points
radiusSearch playground for radius
Gets or sets the corner radius on the backplate. If this value is changed, update the lineWidth to match.
radius Bottom LeftSearch playground for radiusBottomLeft
Gets or sets the top left Radii Multiplier.
radius Bottom RightSearch playground for radiusBottomRight
Gets or sets the top left Radii Multiplier.
radius Top LeftSearch playground for radiusTopLeft
Gets or sets the top left Radii Multiplier.
radius Top RightSearch playground for radiusTopRight
Gets or sets the top left Radii Multiplier.
reserved Data StoreSearch playground for reservedDataStore
For internal use only. Please do not use.
separate Culling PassSearch playground for separateCullingPass
Specifies if there should be a separate pass for culling
shadow Depth WrapperSearch playground for shadowDepthWrapper
Custom shadow depth material to use for shadow rendering instead of the in-built one
side OrientationSearch playground for sideOrientation
Stores the value for side orientation
stateSearch playground for state
The state of the material
Readonly stencilSearch playground for stencil
Gives access to the stencil properties of the material
top Left Gradient ColorSearch playground for topLeftGradientColor
Gets or sets the top left gradient color effect on the backplate.
top Right Gradient ColorSearch playground for topRightGradientColor
Gets or sets the top right gradient color effect on the backplate.
unique IdSearch playground for uniqueId
Gets or sets the unique id of the material
z OffsetSearch playground for zOffset
Stores the z offset Factor value
z Offset UnitsSearch playground for zOffsetUnits
Stores the z offset Units value
Static Readonly All Dirty FlagSearch playground for AllDirtyFlag
The all dirty flag value
Static Readonly Attributes Dirty FlagSearch playground for AttributesDirtyFlag
The dirty attribute flag value
Static Readonly Clock Wise Side OrientationSearch playground for ClockWiseSideOrientation
Stores the clock-wise side orientation
Static Readonly Counter Clock Wise Side OrientationSearch playground for CounterClockWiseSideOrientation
Stores the counter clock-wise side orientation
Static Readonly Fresnel Dirty FlagSearch playground for FresnelDirtyFlag
The dirty fresnel flag value
Static IRIDESCENT_ MAP_ TEXTURE_ URLSearch playground for IRIDESCENT_MAP_TEXTURE_URL
URL pointing to the texture used to define the coloring for the Iridescent Map effect.
Static Readonly Light Dirty FlagSearch playground for LightDirtyFlag
The dirty light flag value
Static Readonly Line List Draw ModeSearch playground for LineListDrawMode
Returns the line list draw mode
Static Readonly Line Loop Draw ModeSearch playground for LineLoopDrawMode
Returns the line loop draw mode
Static Readonly Line Strip Draw ModeSearch playground for LineStripDrawMode
Returns the line strip draw mode
Static Readonly MATERIAL_ ALPHABLENDSearch playground for MATERIAL_ALPHABLEND
MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
Static Readonly MATERIAL_ ALPHATESTSearch playground for MATERIAL_ALPHATEST
MaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
Static Readonly MATERIAL_ ALPHATESTANDBLENDSearch playground for MATERIAL_ALPHATESTANDBLEND
MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer. They are also discarded below the alpha cutoff threshold to improve performances.
Static Readonly MATERIAL_ NORMALBLENDMETHOD_ RNMSearch playground for MATERIAL_NORMALBLENDMETHOD_RNM
The Reoriented Normal Mapping method is used to blend normals. Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
Static Readonly MATERIAL_ NORMALBLENDMETHOD_ WHITEOUTSearch playground for MATERIAL_NORMALBLENDMETHOD_WHITEOUT
The Whiteout method is used to blend normals. Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
Static Readonly MATERIAL_ OPAQUESearch playground for MATERIAL_OPAQUE
MaterialTransparencyMode: No transparency mode, Alpha channel is not use.
Static Readonly Misc Dirty FlagSearch playground for MiscDirtyFlag
The dirty misc flag value
Static On Event ObservableSearch playground for OnEventObservable
Event observable which raises global events common to all materials (like MaterialPluginEvent.Created)
Static Readonly Point Fill ModeSearch playground for PointFillMode
Returns the point fill mode
Static Readonly Point List Draw ModeSearch playground for PointListDrawMode
Returns the point list draw mode
Static Readonly Pre Pass Dirty FlagSearch playground for PrePassDirtyFlag
The dirty prepass flag value
Static Readonly Texture Dirty FlagSearch playground for TextureDirtyFlag
The dirty texture flag value
Static Readonly Triangle Fan Draw ModeSearch playground for TriangleFanDrawMode
Returns the triangle fan draw mode
Static Readonly Triangle Fill ModeSearch playground for TriangleFillMode
Returns the triangle fill mode
Static Readonly Triangle Strip Draw ModeSearch playground for TriangleStripDrawMode
Returns the triangle strip draw mode
Static Readonly Wire Frame Fill ModeSearch playground for WireFrameFillMode
Returns the wireframe mode
Accessors
alpha
Gets the alpha value of the material
Returns number
Sets the alpha value of the material
Parameters
value: number
Returns void
alpha Mode
Gets the value of the alpha mode
Value Type Description 0 ALPHA_DISABLE 1 ALPHA_ADD 2 ALPHA_COMBINE 3 ALPHA_SUBTRACT 4 ALPHA_MULTIPLY 5 ALPHA_MAXIMIZED 6 ALPHA_ONEONE 7 ALPHA_PREMULTIPLIED 8 ALPHA_PREMULTIPLIED_PORTERDUFF 9 ALPHA_INTERPOLATE 10 ALPHA_SCREENMODE Returns number
Sets the value of the alpha mode.
Value Type Description 0 ALPHA_DISABLE 1 ALPHA_ADD 2 ALPHA_COMBINE 3 ALPHA_SUBTRACT 4 ALPHA_MULTIPLY 5 ALPHA_MAXIMIZED 6 ALPHA_ONEONE 7 ALPHA_PREMULTIPLIED 8 ALPHA_PREMULTIPLIED_PORTERDUFF 9 ALPHA_INTERPOLATE 10 ALPHA_SCREENMODE Parameters
value: number
Returns void
back Face Culling
Gets the culling state
Returns boolean
Sets the culling state (true to enable culling, false to disable)
Parameters
value: boolean
Returns void
block Dirty Mechanism
Block the dirty-mechanism for this specific material When set to false after being true the material will be marked as dirty.
Returns boolean
Block the dirty-mechanism for this specific material When set to false after being true the material will be marked as dirty.
Parameters
value: boolean
Returns void
can Render ToMRT
If the material can be rendered to several textures with MRT extension
Returns boolean
cull Back Faces
Gets the type of faces that should be culled
Returns boolean
Sets the type of faces that should be culled (true for back faces, false for front faces)
Parameters
value: boolean
Returns void
fill Mode
Gets the material fill mode
Returns number
Sets the material fill mode
Parameters
value: number
Returns void
fog Enabled
Gets the value of the fog enabled state
Returns boolean
Sets the state for enabling fog
Parameters
value: boolean
Returns void
has Render Target Textures
Gets a boolean indicating that current material needs to register RTT
Returns boolean
is Frozen
Specifies if updates for the material been locked
Returns boolean
is Pre Pass Capable
Can this material render to prepass
Returns boolean
need Depth Pre Pass
Gets the depth pre-pass value
Returns boolean
Sets the need depth pre-pass value
Parameters
value: boolean
Returns void
on Bind
Called during a bind event
Parameters
callback: ((Mesh: AbstractMesh) => void)
Parameters
Mesh: AbstractMesh
Returns void
Returns void
on Bind Observable
An event triggered when the material is bound
Returns Observable<AbstractMesh>
on Dispose
Called during a dispose event
Parameters
callback: (() => void)
Returns void
Returns void
on Effect Created Observable
An event triggered when the effect is (re)created
Returns Observable<{ effect: Effect; subMesh: Nullable<SubMesh> }>
on Un Bind Observable
An event triggered when the material is unbound
Returns Observable<Material>
points Cloud
Gets the value specifying if point clouds are enabled
Returns boolean
Sets the state of point cloud mode
Parameters
value: boolean
Returns void
transparency Mode
wireframe
Returns boolean
Sets the state of wireframe mode
Parameters
value: boolean
Returns void
Methods
atomic Materials UpdateSearch playground for atomicMaterialsUpdate
This allows you to modify the material without marking it as dirty after every change. This function should be used if you need to make more than one dirty-enabling change to the material - adding a texture, setting a new fill mode and so on. The callback will pass the material as an argument, so you can make your changes to it.
Parameters
callback: ((material: MRDLBackplateMaterial) => void)
the callback to be executed that will update the material
Parameters
material: MRDLBackplateMaterial
Returns void
Returns void
bindSearch playground for bind
bind Eye PositionSearch playground for bindEyePosition
Binds the view matrix to the effect
Parameters
effect: Effect
defines the effect to bind the view matrix to
Optional variableName: string
name of the shader variable that will hold the eye position
Returns void
bind For Sub MeshSearch playground for bindForSubMesh
bind Only Normal MatrixSearch playground for bindOnlyNormalMatrix
Binds the given normal matrix to the active effect
Parameters
normalMatrix: Matrix
the matrix to bind
Returns void
bind Only World MatrixSearch playground for bindOnlyWorldMatrix
Binds the given world matrix to the active effect
Parameters
world: Matrix
the matrix to bind
Returns void
bind ViewSearch playground for bindView
Binds the view matrix to the effect
Parameters
effect: Effect
defines the effect to bind the view matrix to
Returns void
bind View ProjectionSearch playground for bindViewProjection
Binds the view projection and projection matrices to the effect
Parameters
effect: Effect
defines the effect to bind the view projection and projection matrices to
Returns void
build Uniform LayoutSearch playground for buildUniformLayout
Initializes the uniform buffer layout for the shader.
Returns void
cloneSearch playground for clone
Parameters
name: string
Returns MRDLBackplateMaterial
disposeSearch playground for dispose
Parameters
Optional forceDisposeEffect: boolean
Returns void
force CompilationSearch playground for forceCompilation
Force shader compilation
Parameters
mesh: AbstractMesh
defines the mesh associated with this material
Optional onCompiled: ((material: Material) => void)
defines a function to execute once the material is compiled
Parameters
material: Material
Returns void
Optional options: Partial<IMaterialCompilationOptions>
defines the options to configure the compilation
Optional onError: ((reason: string) => void)
defines a function to execute if the material fails compiling
Parameters
reason: string
Returns void
Returns void
force Compilation AsyncSearch playground for forceCompilationAsync
Force shader compilation
Parameters
mesh: AbstractMesh
defines the mesh that will use this material
Optional options: Partial<IMaterialCompilationOptions>
defines additional options for compiling the shaders
Returns Promise<void>
a promise that resolves when the compilation completes
freezeSearch playground for freeze
Locks updates for the material
Returns void
get Active TexturesSearch playground for getActiveTextures
Gets the active textures from the material
Returns BaseTexture[]
an array of textures
get Alpha Test TextureSearch playground for getAlphaTestTexture
Returns Nullable<BaseTexture>
get AnimatablesSearch playground for getAnimatables
Get the list of animatables in the material.
Returns IAnimatable[]
the list of animatables object used in the material
get Binded MeshesSearch playground for getBindedMeshes
Gets the meshes bound to the material
Returns AbstractMesh[]
an array of meshes bound to the material
get Class NameSearch playground for getClassName
Returns string
get EffectSearch playground for getEffect
Returns Effect
get SceneSearch playground for getScene
Returns the current scene
Returns Scene
a Scene
has TextureSearch playground for hasTexture
Specifies if the material uses a texture
Parameters
texture: BaseTexture
defines the texture to check against the material
Returns boolean
a boolean specifying if the material uses the texture
is ReadySearch playground for isReady
Parameters
Optional mesh: AbstractMesh
Optional useInstances: boolean
Returns boolean
is Ready For Sub MeshSearch playground for isReadyForSubMesh
Parameters
mesh: AbstractMesh
subMesh: SubMesh
Returns boolean
mark As DirtySearch playground for markAsDirty
Marks a define in the material to indicate that it needs to be re-computed
Parameters
flag: number
defines a flag used to determine which parts of the material have to be marked as dirty
Returns void
mark DirtySearch playground for markDirty
Marks the material to indicate that it needs to be re-calculated
Returns void
need Alpha BlendingSearch playground for needAlphaBlending
Returns boolean
need Alpha Blending For MeshSearch playground for needAlphaBlendingForMesh
Specifies if the mesh will require alpha blending
Parameters
mesh: AbstractMesh
defines the mesh to check
Returns boolean
a boolean specifying if alpha blending is needed for the mesh
need Alpha TestingSearch playground for needAlphaTesting
Returns boolean
reset Draw CacheSearch playground for resetDrawCache
Resets the draw wrappers cache for all submeshes that are using this material
Returns void
serializeSearch playground for serialize
Returns any
set Pre Pass RendererSearch playground for setPrePassRenderer
Sets the required values to the prepass renderer.
Parameters
prePassRenderer: PrePassRenderer
defines the prepass renderer to setup.
Returns boolean
true if the pre pass is needed.
to StringSearch playground for toString
Returns a string representation of the current material
Parameters
Optional fullDetails: boolean
defines a boolean indicating which levels of logging is desired
Returns string
a string with material information
unbindSearch playground for unbind
Unbinds the material from the mesh
Returns void
unfreezeSearch playground for unfreeze
Unlocks updates for the material
Returns void
Static ParseSearch playground for Parse
Parameters
source: any
scene: Scene
rootUrl: string
Returns MRDLBackplateMaterial
Class used to render backplate material with MRDL