Class PBRMetallicRoughnessBlock
Hierarchy
- NodeMaterialBlock
- PBRMetallicRoughnessBlock
Index
Constructors
Properties
- alpha
Test Cutoff - comments
- debug
Factor - debug
Limit - debug
Mode - direct
Intensity - enable
Specular Anti Aliasing - environment
Intensity - force
Normal Forward - generate
Only Fragment Code - inputs
Are Exclusive - light
- light
Falloff - real
Time Filtering - real
Time Filtering Quality - specular
Intensity - unique
Id - unlit
- use
Alpha Blending - use
Alpha Test - use
Energy Conservation - use
Horizon Occlusion - use
Radiance Occlusion - use
Radiance Over Alpha - use
Specular Over Alpha - visible
In Inspector - visible
On Frame
Accessors
- alpha
- ambient
Clr - ambient
Color - ambient
Occ - anisotropy
- base
Color - build
Id - camera
Position - clearcoat
- clearcoat
Dir - clearcoat
Ind - diffuse
Dir - diffuse
Ind - index
Of Refraction - inputs
- iridescence
- is
Final Merger - is
Input - is
Teleport In - is
Teleport Out - is
Unique - lighting
- metallic
- name
- opacity
- outputs
- perturbed
Normal - reflection
- refraction
- roughness
- shadow
- sheen
- sheen
Dir - sheen
Ind - specular
Dir - specular
Ind - subsurface
- target
- view
- will
Be Generated Into Vertex Shader From Fragment Shader - world
Normal - world
Position
Methods
- _deserialize
- auto
Configure - bind
- build
- clone
- connect
To - dispose
- get
Class Name - get
First Available Input - get
First Available Output - get
Input By Name - get
Output By Name - get
Sibling Output - initialize
- initialize
Defines - is
An Ancestor Of - is
Connected In Fragment Shader - is
Ready - prepare
Defines - provide
Fallbacks - register
Input - register
Output - replace
Repeatable Content - serialize
- update
Uniforms And Samples - validate
Block Name
Constructors
constructor
Create a new ReflectionBlock
Parameters
name: string
defines the block name
Returns PBRMetallicRoughnessBlock
Properties
alpha
Defines the alpha limits in alpha test mode.
commentsSearch playground for comments
Gets or sets the comments associated with this block
debug
As the default viewing range might not be enough (if the ambient is really small for instance) You can use the factor to better multiply the final value.
debug
Specify from where on screen the debug mode should start. The value goes from -1 (full screen) to 1 (not visible) It helps with side by side comparison against the final render This defaults to 0
debug
Defines the material debug mode. It helps seeing only some components of the material while troubleshooting.
direct
Intensity of the direct lights e.g. the four lights available in your scene. This impacts both the direct diffuse and specular highlights.
enable
Enables specular anti aliasing in the PBR shader. It will both interacts on the Geometry for analytical and IBL lighting. It also prefilter the roughness map based on the bump values.
environment
Intensity of the environment e.g. how much the environment will light the object either through harmonics for rough material or through the reflection for shiny ones.
force
Force normal to face away from face.
generate
Indicates that no code should be generated in the vertex shader. Can be useful in some specific circumstances (like when doing ray marching for eg)
inputs
Gets or sets a boolean indicating that only one input can be connected at a time
lightSearch playground for light
Gets or sets the light associated with this block
light
Defines the falloff type used in this material. It by default is Physical.
real
Enables realtime filtering on the texture.
real
Quality switch for realtime filtering
specular
This is a special control allowing the reduction of the specular highlights coming from the four lights of the scene. Those highlights may not be needed in full environment lighting.
unique
Gets or sets the unique id of the node
unlitSearch playground for unlit
If set to true, no lighting calculations will be applied.
use
Specifies that alpha blending should be used
use
Specifies that alpha test should be used
use
Defines if the material uses energy conservation.
use
This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal makes the reflect vector face the model (under horizon).
use
This parameters will enable/disable radiance occlusion by preventing the radiance to lit too much the area relying on ambient texture to define their ambient occlusion.
use
Specifies that the material will keeps the reflection highlights over a transparent surface (only the most luminous ones). A car glass is a good example of that. When the street lights reflects on it you can not see what is behind.
use
Specifies that the material will keeps the specular highlights over a transparent surface (only the most luminous ones). A car glass is a good example of that. When sun reflects on it you can not see what is behind.
visible
Gets or sets a boolean indicating that this input can be edited in the Inspector (false by default)
visible
Gets or sets a boolean indicating that this input can be edited from a collapsed frame
Accessors
alpha
Gets the alpha output component
Returns NodeMaterialConnectionPoint
ambient
Gets the ambient output component
Returns NodeMaterialConnectionPoint
ambient
Gets the ambient color input component
Returns NodeMaterialConnectionPoint
ambient
Gets the ambient occlusion input component
Returns NodeMaterialConnectionPoint
anisotropy
Gets the anisotropy object parameters
Returns NodeMaterialConnectionPoint
base
Gets the base color input component
Returns NodeMaterialConnectionPoint
build
Gets or sets the build Id
Returns number
Gets or sets the build Id
Parameters
value: number
Returns void
camera
Gets the camera position input component
Returns NodeMaterialConnectionPoint
clearcoat
Gets the clear coat object parameters
Returns NodeMaterialConnectionPoint
clearcoat
Gets the clear coat output component
Returns NodeMaterialConnectionPoint
clearcoat
Gets the indirect clear coat output component
Returns NodeMaterialConnectionPoint
diffuse
Gets the diffuse output component
Returns NodeMaterialConnectionPoint
diffuse
Gets the indirect diffuse output component
Returns NodeMaterialConnectionPoint
index
Gets the index of refraction input component
Returns NodeMaterialConnectionPoint
inputs
Gets the list of input points
Returns NodeMaterialConnectionPoint[]
iridescence
Gets the iridescence object parameters
Returns NodeMaterialConnectionPoint
is
Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)
Returns boolean
is
Gets a boolean indicating that this block is an input (e.g. it sends data to the shader)
Returns boolean
is
Gets a boolean indicating if this block is a teleport in
Returns boolean
is
Gets a boolean indicating if this block is a teleport out
Returns boolean
is
Gets a boolean indicating that this block can only be used once per NodeMaterial
Returns boolean
lighting
Gets the global lighting output component
Returns NodeMaterialConnectionPoint
metallic
Gets the metallic input component
Returns NodeMaterialConnectionPoint
name
Gets the name of the block
Returns string
Sets the name of the block. Will check if the name is valid.
Parameters
newName: string
Returns void
opacity
Gets the opacity input component
Returns NodeMaterialConnectionPoint
outputs
Gets the list of output points
Returns NodeMaterialConnectionPoint[]
perturbed
Gets the perturbed normal input component
Returns NodeMaterialConnectionPoint
reflection
Gets the reflection object parameters
Returns NodeMaterialConnectionPoint
refraction
Gets the refraction output component
Returns NodeMaterialConnectionPoint
roughness
Gets the roughness input component
Returns NodeMaterialConnectionPoint
shadow
Gets the shadow output component
Returns NodeMaterialConnectionPoint
sheen
Gets the sheen object parameters
Returns NodeMaterialConnectionPoint
sheen
Gets the sheen output component
Returns NodeMaterialConnectionPoint
sheen
Gets the indirect sheen output component
Returns NodeMaterialConnectionPoint
specular
Gets the specular output component
Returns NodeMaterialConnectionPoint
specular
Gets the indirect specular output component
Returns NodeMaterialConnectionPoint
subsurface
Gets the sub surface object parameters
Returns NodeMaterialConnectionPoint
target
Gets or sets the target of the block
Returns NodeMaterialBlockTargets
Gets or sets the target of the block
Parameters
value: NodeMaterialBlockTargets
Returns void
view
Gets the view matrix parameter
Returns NodeMaterialConnectionPoint
will
Gets a boolean indicating that the code of this block will be promoted to vertex shader even if connected to fragment output
Returns boolean
world
Gets the world normal input component
Returns NodeMaterialConnectionPoint
world
Gets the world position input component
Returns NodeMaterialConnectionPoint
Methods
_deserializeSearch playground for _deserialize
Parameters
serializationObject: any
scene: Scene
rootUrl: string
Returns void
auto
Lets the block try to connect some inputs automatically
Parameters
material: NodeMaterial
Optional additionalFilteringInfo: ((node: NodeMaterialBlock) => boolean)
Parameters
node: NodeMaterialBlock
Returns boolean
Returns void
bindSearch playground for bind
Bind data to effect. Will only be called for blocks with isBindable === true
Parameters
effect: Effect
nodeMaterial: NodeMaterial
Optional mesh: Mesh
Returns void
buildSearch playground for build
Compile the current node and generate the shader code
Parameters
state: NodeMaterialBuildState
defines the current compilation state (uniforms, samplers, current string)
activeBlocks: NodeMaterialBlock[]
defines the list of active blocks (i.e. blocks to compile)
Returns boolean
true if already built
cloneSearch playground for clone
Clone the current block to a new identical block
Parameters
scene: Scene
defines the hosting scene
Optional rootUrl: string
defines the root URL to use to load textures and relative dependencies
Returns null | NodeMaterialBlock
a copy of the current block
connect
Connect current block with another block
Parameters
other: NodeMaterialBlock
defines the block to connect with
Optional options: { input?: string; output?: string; outputSwizzle?: string }
define the various options to help pick the right connections
Optional input?: string
Optional output?: string
Optional output
Swizzle?: string
Returns undefined | PBRMetallicRoughnessBlock
the current block
disposeSearch playground for dispose
Release resources
Returns void
get
Gets the current class name
Returns string
the class name
get
Will return the first available input e.g. the first one which is not an uniform or an attribute
Parameters
Optional forOutput: Nullable<NodeMaterialConnectionPoint>
defines an optional connection point to check compatibility with
Returns null | NodeMaterialConnectionPoint
the first available input or null
get
Will return the first available output e.g. the first one which is not yet connected and not a varying
Parameters
Optional forBlock: Nullable<NodeMaterialBlock>
defines an optional block to check compatibility with
Returns null | NodeMaterialConnectionPoint
the first available input or null
get
Find an input by its name
Parameters
name: string
defines the name of the input to look for
Returns null | NodeMaterialConnectionPoint
the input or null if not found
get
Find an output by its name
Parameters
name: string
defines the name of the output to look for
Returns null | NodeMaterialConnectionPoint
the output or null if not found
get
Gets the sibling of the given output
Parameters
current: NodeMaterialConnectionPoint
defines the current output
Returns null | NodeMaterialConnectionPoint
the next output in the list or null
initializeSearch playground for initialize
Initialize the block and prepare the context for build
Parameters
state: NodeMaterialBuildState
defines the state that will be used for the build
Returns void
initialize
Initialize defines for shader compilation
Parameters
mesh: AbstractMesh
defines the mesh to be rendered
nodeMaterial: NodeMaterial
defines the node material requesting the update
defines: NodeMaterialDefines
defines the material defines to update
Optional useInstances: boolean
specifies that instances should be used
Returns void
is
Checks if the current block is an ancestor of a given block
Parameters
block: NodeMaterialBlock
defines the potential descendant block to check
Returns boolean
true if block is a descendant
is
Gets a boolean indicating that this connection will be used in the fragment shader
Returns boolean
is
Checks if the block is ready
Parameters
mesh: AbstractMesh
nodeMaterial: NodeMaterial
defines: NodeMaterialDefines
Returns boolean
prepare
Update defines for shader compilation
Parameters
mesh: AbstractMesh
nodeMaterial: NodeMaterial
defines: NodeMaterialDefines
Returns void
provide
Add potential fallbacks if shader compilation fails
Parameters
mesh: AbstractMesh
defines the mesh to be rendered
fallbacks: EffectFallbacks
defines the current prioritized list of fallbacks
Returns void
register
Register a new input. Must be called inside a block constructor
Parameters
name: string
defines the connection point name
type: NodeMaterialBlockConnectionPointTypes
defines the connection point type
Optional isOptional: boolean
defines a boolean indicating that this input can be omitted
Optional target: NodeMaterialBlockTargets
defines the target to use to limit the connection point (will be VertexAndFragment by default)
Optional point: NodeMaterialConnectionPoint
an already created connection point. If not provided, create a new one
Returns PBRMetallicRoughnessBlock
the current block
register
Register a new output. Must be called inside a block constructor
Parameters
name: string
defines the connection point name
type: NodeMaterialBlockConnectionPointTypes
defines the connection point type
Optional target: NodeMaterialBlockTargets
defines the target to use to limit the connection point (will be VertexAndFragment by default)
Optional point: NodeMaterialConnectionPoint
an already created connection point. If not provided, create a new one
Returns PBRMetallicRoughnessBlock
the current block
replace
Function called when a block is declared as repeatable content generator
Parameters
vertexShaderState: NodeMaterialBuildState
defines the current compilation state for the vertex shader
fragmentShaderState: NodeMaterialBuildState
defines the current compilation state for the fragment shader
mesh: AbstractMesh
defines the mesh to be rendered
defines: NodeMaterialDefines
defines the material defines to update
Returns void
serializeSearch playground for serialize
Serializes this block in a JSON representation
Returns any
update
Add uniforms, samplers and uniform buffers at compilation time
Parameters
state: NodeMaterialBuildState
nodeMaterial: NodeMaterial
defines: NodeMaterialDefines
uniformBuffers: string[]
Returns void
validate
Validates the new name for the block node.
Parameters
newName: string
the new name to be given to the node.
Returns boolean
false if the name is a reserve word, else true.
Block used to implement the PBR metallic/roughness model