Class PBRSpecularGlossinessMaterial
Hierarchy
- PBRBaseSimpleMaterial
- PBRSpecularGlossinessMaterial
Index
Constructors
Properties
- allow
Shader Hot Swapping - alpha
Cut Off - animations
- anisotropy
- brdf
- check
Ready On Every Call - check
Ready Only Once - clear
Coat - clip
Plane - clip
Plane2 - clip
Plane3 - clip
Plane4 - clip
Plane5 - clip
Plane6 - custom
Shader Name Resolve - decal
Map - depth
Function - detail
Map - diffuse
Color - diffuse
Texture - disable
Color Write - disable
Depth Write - disable
Lighting - do
Not Serialize - emissive
Color - emissive
Texture - environment
Texture - force
Depth Write - get
Render Target Textures - glossiness
- id
- inspectable
Custom Properties - invert
Normal MapX - invert
Normal MapY - iridescence
- lightmap
Texture - max
Simultaneous Lights - metadata
- name
- normal
Texture - occlusion
Strength - occlusion
Texture - on
Compiled - on
Dispose Observable - on
Error - plugin
Manager - point
Size - pre
Pass Configuration - reserved
Data Store - separate
Culling Pass - shadow
Depth Wrapper - sheen
- side
Orientation - specular
Color - specular
Glossiness Texture - state
- stencil
- sub
Surface - unique
Id - use
Lightmap As Shadowmap - z
Offset - z
Offset Units - All
Dirty Flag - Attributes
Dirty Flag - Clock
Wise Side Orientation - Counter
Clock Wise Side Orientation - DEFAULT_
AO_ ON_ ANALYTICAL_ LIGHTS - Fresnel
Dirty Flag - LIGHTFALLOFF_
GLTF - LIGHTFALLOFF_
PHYSICAL - LIGHTFALLOFF_
STANDARD - 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 - PBRMATERIAL_
ALPHABLEND - PBRMATERIAL_
ALPHATEST - PBRMATERIAL_
ALPHATESTANDBLEND - PBRMATERIAL_
OPAQUE - 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
- alpha
- alpha
Mode - back
Face Culling - block
Dirty Mechanism - can
Render ToMRT - cull
Back Faces - double
Sided - fill
Mode - fog
Enabled - has
Render Target Textures - is
Frozen - is
Pre Pass Capable - need
Depth Pre Pass - on
Bind - on
Bind Observable - on
Dispose - on
Effect Created Observable - on
Un Bind Observable - points
Cloud - real
Time Filtering - real
Time Filtering Quality - transparency
Mode - use
Logarithmic Depth - use
Micro Surface From Reflectivity Map Alpha - wireframe
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
Metallic Workflow - 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
Instantiates a new PBRSpecularGlossinessMaterial instance.
Parameters
name: string
The material name
Optional scene: Scene
The scene the material will be use in.
Returns PBRSpecularGlossinessMaterial
Properties
allow
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)
alpha
Defines the alpha limits in alpha test mode.
animationsSearch playground for animations
Stores the animations for the material
Readonly anisotropySearch playground for anisotropy
Defines the anisotropic parameters for the material.
Readonly brdfSearch playground for brdf
Defines the BRDF parameters for the material.
check
Specifies if the ready state should be checked on each call
check
Specifies if the ready state should be checked once
Readonly clear
Defines the clear coat layer parameters for the material.
clip
Gets or sets the active clipplane 1
clip
Gets or sets the active clipplane 2
clip
Gets or sets the active clipplane 3
clip
Gets or sets the active clipplane 4
clip
Gets or sets the active clipplane 5
clip
Gets or sets the active clipplane 6
custom
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
decal
Defines the decal map parameters for the material.
depth
Specifies the depth function that should be used. 0 means the default engine function
Readonly detail
Defines the detail map parameters for the material.
diffuse
Specifies the diffuse color of the material.
diffuse
Specifies the diffuse texture of the material. This can also contains the opacity value in its alpha channel.
disable
Specifies if color writing should be disabled
disable
Specifies if depth writing should be disabled
disable
If sets to true, disables all the lights affecting the material.
do
Specifies if the material should be serialized
emissive
Emissivie color used to self-illuminate the model.
emissive
Emissivie texture used to self-illuminate the model.
environment
Environment Texture used in the material (this is use for both reflection and environment lighting).
force
Specifies if depth writing should be forced
get
Callback triggered to get the render target textures
glossinessSearch playground for glossiness
Specifies the glossiness of the material. This indicates "how sharp is the reflection".
idSearch playground for id
The ID of the material
inspectable
List of inspectable custom properties (used by the Inspector)
invert
If sets to true, x component of normal map value will invert (x = 1.0 - x).
invert
If sets to true, y component of normal map value will invert (y = 1.0 - y).
Readonly iridescenceSearch playground for iridescence
Defines the iridescence layer parameters for the material.
lightmap
Stores the pre-calculated light information of a mesh in a texture.
max
Number of Simultaneous lights allowed on the material.
metadataSearch playground for metadata
Gets or sets user defined metadata
nameSearch playground for name
The name of the material
normal
Normal map used in the model.
occlusion
Occlusion Channel Strength.
occlusion
Occlusion Texture of the material (adding extra occlusion effects).
on
Callback triggered when the material is compiled
on
An event triggered when the material is disposed
on
Callback triggered when an error occurs
Optional plugin
Plugin manager for this material
point
Stores the size of points
Readonly pre
Defines additional PrePass parameters for the material.
reserved
For internal use only. Please do not use.
separate
Specifies if there should be a separate pass for culling
shadow
Custom shadow depth material to use for shadow rendering instead of the in-built one
Readonly sheenSearch playground for sheen
Defines the Sheen parameters for the material.
side
Stores the value for side orientation
specular
Specifies the specular color of the material. This indicates how reflective is the material (none to mirror).
specular
Specifies both the specular color RGB and the glossiness A of the material per pixels.
stateSearch playground for state
The state of the material
Readonly stencilSearch playground for stencil
Gives access to the stencil properties of the material
Readonly sub
Defines the SubSurface parameters for the material.
unique
Gets or sets the unique id of the material
use
If true, the light map contains occlusion information instead of lighting info.
z
Stores the z offset Factor value
z
Stores the z offset Units value
Static Readonly All
The all dirty flag value
Static Readonly Attributes
The dirty attribute flag value
Static Readonly Clock
Stores the clock-wise side orientation
Static Readonly Counter
Stores the counter clock-wise side orientation
Static DEFAULT_
Defines the default value of how much AO map is occluding the analytical lights (point spot...).
Static Readonly Fresnel
The dirty fresnel flag value
Static Readonly LIGHTFALLOFF_
PBRMaterialLightFalloff gltf: light is falling off as described in the gltf moving to PBR document to enhance interoperability with other engines.
Static Readonly LIGHTFALLOFF_
PBRMaterialLightFalloff Physical: light is falling off following the inverse squared distance law.
Static Readonly LIGHTFALLOFF_
PBRMaterialLightFalloff Standard: light is falling off like in the standard material to enhance interoperability with other materials.
Static Readonly Light
The dirty light flag value
Static Readonly Line
Returns the line list draw mode
Static Readonly Line
Returns the line loop draw mode
Static Readonly Line
Returns the line strip draw mode
Static Readonly MATERIAL_
MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
Static Readonly MATERIAL_
MaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
Static Readonly MATERIAL_
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_
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_
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_
MaterialTransparencyMode: No transparency mode, Alpha channel is not use.
Static Readonly Misc
The dirty misc flag value
Static On
Event observable which raises global events common to all materials (like MaterialPluginEvent.Created)
Static Readonly PBRMATERIAL_
PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
Static Readonly PBRMATERIAL_
PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
Static Readonly PBRMATERIAL_
PBRMaterialTransparencyMode: 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 PBRMATERIAL_
PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
Static Readonly Point
Returns the point fill mode
Static Readonly Point
Returns the point list draw mode
Static Readonly Pre
The dirty prepass flag value
Static Readonly Texture
The dirty texture flag value
Static Readonly Triangle
Returns the triangle fan draw mode
Static Readonly Triangle
Returns the triangle fill mode
Static Readonly Triangle
Returns the triangle strip draw mode
Static Readonly Wire
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
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
Gets the culling state
Returns boolean
Sets the culling state (true to enable culling, false to disable)
Parameters
value: boolean
Returns void
block
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
Can this material render to several textures at once
Returns boolean
cull
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
double
Gets the current double sided mode.
Returns boolean
If sets to true and backfaceCulling is false, normals will be flipped on the backside.
Parameters
value: boolean
Returns void
fill
Gets the material fill mode
Returns number
Sets the material fill mode
Parameters
value: number
Returns void
fog
Gets the value of the fog enabled state
Returns boolean
Sets the state for enabling fog
Parameters
value: boolean
Returns void
has
Gets a boolean indicating that current material needs to register RTT
Returns boolean
is
Specifies if updates for the material been locked
Returns boolean
is
Can this material render to prepass
Returns boolean
need
Gets the depth pre-pass value
Returns boolean
Sets the need depth pre-pass value
Parameters
value: boolean
Returns void
on
Called during a bind event
Parameters
callback: ((Mesh: AbstractMesh) => void)
Parameters
Mesh: AbstractMesh
Returns void
Returns void
on
An event triggered when the material is bound
Returns Observable<AbstractMesh>
on
Called during a dispose event
Parameters
callback: (() => void)
Returns void
Returns void
on
An event triggered when the effect is (re)created
Returns Observable<{ effect: Effect; subMesh: Nullable<SubMesh> }>
on
An event triggered when the material is unbound
Returns Observable<Material>
points
Gets the value specifying if point clouds are enabled
Returns boolean
Sets the state of point cloud mode
Parameters
value: boolean
Returns void
real
Enables realtime filtering on the texture.
Returns boolean
Enables realtime filtering on the texture.
Parameters
b: boolean
Returns void
real
Quality switch for realtime filtering
Returns number
Quality switch for realtime filtering
Parameters
n: number
Returns void
transparency
use
Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
Returns boolean
Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
Parameters
value: boolean
Returns void
use
Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
Returns boolean
wireframe
Returns boolean
Sets the state of wireframe mode
Parameters
value: boolean
Returns void
Methods
atomic
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: PBRSpecularGlossinessMaterial) => void)
the callback to be executed that will update the material
Parameters
material: PBRSpecularGlossinessMaterial
Returns void
Returns void
bindSearch playground for bind
bind
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
bind
Binds the given normal matrix to the active effect
Parameters
normalMatrix: Matrix
the matrix to bind
Returns void
bind
Binds the given world matrix to the active effect
Parameters
world: Matrix
the matrix to bind
Returns void
bind
Binds the view matrix to the effect
Parameters
effect: Effect
defines the effect to bind the view matrix to
Returns void
bind
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
Initializes the uniform buffer layout for the shader.
Returns void
cloneSearch playground for clone
Makes a duplicate of the current material.
Parameters
name: string
name to use for the new material.
Returns PBRSpecularGlossinessMaterial
disposeSearch playground for dispose
Disposes the resources of the material.
Parameters
Optional forceDisposeEffect: boolean
Forces the disposal of effects.
Optional forceDisposeTextures: boolean
Forces the disposal of all textures.
Returns void
force
Force shader compilation
Parameters
mesh: AbstractMesh
Optional onCompiled: ((material: Material) => void)
Parameters
material: Material
Returns void
Optional options: Partial<IMaterialCompilationOptions>
Returns void
force
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
Returns an array of the actively used textures.
Returns BaseTexture[]
- Array of BaseTextures
get
Gets the texture used for the alpha test.
Returns Nullable<BaseTexture>
get
Returns the animatable textures. If material have animatable metallic texture, then reflectivity texture will not be returned, even if it has animations.
Returns IAnimatable[]
- Array of animatable textures.
get
Gets the meshes bound to the material
Returns AbstractMesh[]
an array of meshes bound to the material
get
Return the current class name of the material.
Returns string
get
Returns Effect
get
Returns the current scene
Returns Scene
a Scene
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
Specifies if the material uses metallic roughness workflow.
Returns boolean
boolean specifying if the material uses metallic roughness workflow.
is
Parameters
Optional mesh: AbstractMesh
Optional useInstances: boolean
Returns boolean
is
Specifies that the submesh is ready to be used.
Parameters
mesh: AbstractMesh
BJS mesh.
subMesh: SubMesh
A submesh of the BJS mesh. Used to check if it is ready.
Optional useInstances: boolean
Specifies that instances should be used.
Returns boolean
- boolean indicating that the submesh is ready or not.
mark
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
Marks the material to indicate that it needs to be re-calculated
Parameters
Optional forceMaterialDirty: boolean
Forces the material to be marked as dirty for all components (same as this.markAsDirty(Material.AllDirtyFlag)). You should use this flag if the material is frozen and you want to force a recompilation.
Returns void
need
Specifies whether or not this material should be rendered in alpha blend mode.
Returns boolean
need
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
Specifies whether or not this material should be rendered in alpha test mode.
Returns boolean
reset
Resets the draw wrappers cache for all submeshes that are using this material
Returns void
serializeSearch playground for serialize
Serialize the material to a parsable JSON object.
Returns any
set
Sets the required values to the prepass renderer. It can't be sets when subsurface scattering of this material is disabled. When scene have ability to enable subsurface prepass effect, it will enable.
Returns boolean
to
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
Parses a JSON object corresponding to the serialize function.
Parameters
source: any
scene: Scene
rootUrl: string
Returns PBRSpecularGlossinessMaterial
The PBR material of BJS following the specular glossiness convention.
This fits to the PBR convention in the GLTF definition: https://github.com/KhronosGroup/glTF/tree/2.0/extensions/Khronos/KHR_materials_pbrSpecularGlossiness