Class NodeRenderGraphGeometryRendererBlock
Hierarchy
- NodeRenderGraphBaseObjectRendererBlock
- NodeRenderGraphGeometryRendererBlock
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
-
new NodeRenderGraphGeometryRendererBlock(
name: string,
frameGraph: FrameGraph,
scene: Scene,
doNotChangeAspectRatio?: boolean,
enableClusteredLights?: boolean,
): NodeRenderGraphGeometryRendererBlockCreate a new NodeRenderGraphGeometryRendererBlock
Parameters
- name: string
defines the block name
- frameGraph: FrameGraph
defines the hosting frame graph
- scene: Scene
defines the hosting scene
- doNotChangeAspectRatio: boolean = true
True (default) to not change the aspect ratio of the scene in the RTT
- enableClusteredLights: boolean = true
True (default) to enable clustered lights
Returns NodeRenderGraphGeometryRendererBlock
- name: string
Properties
albedo Format
The format of the albedo output texture
albedo Type
The type of the albedo output texture
comments
A free comment about the block
irradiance Format
The format of the irradiance output texture
irradiance Type
The type of the irradiance output texture
linear Velocity Format
The format of the linear velocity output texture
linear Velocity Type
The type of the linear velocity output texture
local Position Format
The format of the local position output texture
local Position Type
The type of the local position output texture
normalized View Depth Format
The format of the normalized view depth output texture
normalized View Depth Type
The type of the normalized view depth output texture
on Build Observable
Gets an observable raised when the block is built
reflectivity Format
The format of the reflectivity output texture
reflectivity Type
The type of the reflectivity output texture
screen Depth Format
The format of the screen depth output texture
screen Depth Type
The type of the screen depth output texture
unique Id
Gets or sets the unique id of the node
velocity Format
The format of the velocity output texture
velocity Type
The type of the velocity output texture
view Depth Format
The format of the view depth output texture
view Depth Type
The type of the view depth output texture
view Normal Format
The format of the view normal output texture
view Normal Type
The type of the view normal output texture
visible On Frame
Gets or sets a boolean indicating that this input can be edited from a collapsed frame
world Normal Format
The format of the world normal output texture
world Normal Type
The type of the world normal output texture
world Position Format
The format of the world position output texture
world Position Type
The type of the world position output texture
Accessors
camera
-
Gets the camera input component
Returns NodeRenderGraphConnectionPoint
dependencies
-
Gets the dependencies input component
Returns NodeRenderGraphConnectionPoint
depth
-
Gets the depth texture input component
Returns NodeRenderGraphConnectionPoint
depth Test
-
get depthTest(): boolean
Indicates if depth testing must be enabled or disabled
Returns boolean
-
set depthTest(value: boolean): void
Parameters
- value: boolean
Returns void
depth Write
-
get depthWrite(): boolean
Indicates if depth writing must be enabled or disabled
Returns boolean
-
set depthWrite(value: boolean): void
Parameters
- value: boolean
Returns void
disabled
-
get disabled(): boolean
Gets or sets the disable flag of the task associated with this block
Returns boolean
-
set disabled(value: boolean): void
Parameters
- value: boolean
Returns void
disable Depth Pre Pass
-
get disableDepthPrePass(): boolean
Indicates if depth pre-pass must be disabled
Returns boolean
-
set disableDepthPrePass(value: boolean): void
Parameters
- value: boolean
Returns void
disable Shadows
-
get disableShadows(): boolean
Indicates if shadows must be enabled or disabled
Returns boolean
-
set disableShadows(value: boolean): void
Parameters
- value: boolean
Returns void
do Not Change Aspect Ratio
-
get doNotChangeAspectRatio(): boolean
True (default) to not change the aspect ratio of the scene in the RTT
Returns boolean
-
set doNotChangeAspectRatio(value: boolean): void
Parameters
- value: boolean
Returns void
dont Render When Material Depth Write Is Disabled
-
get dontRenderWhenMaterialDepthWriteIsDisabled(): boolean
Indicates if a mesh shouldn't be rendered when its material has depth write disabled
Returns boolean
-
set dontRenderWhenMaterialDepthWriteIsDisabled(value: boolean): void
Parameters
- value: boolean
Returns void
enable Bounding Box Rendering
-
get enableBoundingBoxRendering(): boolean
Indicates if bounding boxes should be rendered
Returns boolean
-
set enableBoundingBoxRendering(value: boolean): void
Parameters
- value: boolean
Returns void
enable Clustered Lights
-
get enableClusteredLights(): boolean
True (default) to enable clustered lights
Returns boolean
-
set enableClusteredLights(value: boolean): void
Parameters
- value: boolean
Returns void
enable Outline Rendering
-
get enableOutlineRendering(): boolean
Indicates if outlines/overlays should be rendered
Returns boolean
-
set enableOutlineRendering(value: boolean): void
Parameters
- value: boolean
Returns void
force Layer Mask Check
-
get forceLayerMaskCheck(): boolean
Indicates if layer mask check must be forced
Returns boolean
-
set forceLayerMaskCheck(value: boolean): void
Parameters
- value: boolean
Returns void
geom Albedo
-
get geomAlbedo(): NodeRenderGraphConnectionPoint
Gets the geometry albedo component
Returns NodeRenderGraphConnectionPoint
geom Irradiance
-
get geomIrradiance(): NodeRenderGraphConnectionPoint
Gets the geometry irradiance component
Returns NodeRenderGraphConnectionPoint
geom Linear Velocity
-
get geomLinearVelocity(): NodeRenderGraphConnectionPoint
Gets the geometry linear velocity component
Returns NodeRenderGraphConnectionPoint
geom Local Position
-
get geomLocalPosition(): NodeRenderGraphConnectionPoint
Gets the geometry local position component
Returns NodeRenderGraphConnectionPoint
geom Mesh Blend Tag
-
get geomMeshBlendTag(): NodeRenderGraphConnectionPoint
Gets the packed mesh-blending tag component.
Returns NodeRenderGraphConnectionPoint
geom Norm View Depth
-
get geomNormViewDepth(): NodeRenderGraphConnectionPoint
Gets the geometry normalized view depth component
Returns NodeRenderGraphConnectionPoint
geom Object Id
-
get geomObjectId(): NodeRenderGraphConnectionPoint
Gets the geometry object ID component
Returns NodeRenderGraphConnectionPoint
geom Reflectivity
-
get geomReflectivity(): NodeRenderGraphConnectionPoint
Gets the geometry reflectivity component
Returns NodeRenderGraphConnectionPoint
geom Screen Depth
-
get geomScreenDepth(): NodeRenderGraphConnectionPoint
Gets the geometry screen depth component
Returns NodeRenderGraphConnectionPoint
geom Velocity
-
get geomVelocity(): NodeRenderGraphConnectionPoint
Gets the geometry velocity component
Returns NodeRenderGraphConnectionPoint
geom View Depth
-
get geomViewDepth(): NodeRenderGraphConnectionPoint
Gets the geometry view depth component
Returns NodeRenderGraphConnectionPoint
geom View Normal
-
get geomViewNormal(): NodeRenderGraphConnectionPoint
Gets the geometry view normal component
Returns NodeRenderGraphConnectionPoint
geom World Normal
-
get geomWorldNormal(): NodeRenderGraphConnectionPoint
Gets the world geometry normal component, encoded from [-1, 1] to [0, 1]
Returns NodeRenderGraphConnectionPoint
geom World Position
-
get geomWorldPosition(): NodeRenderGraphConnectionPoint
Gets the geometry world position component
Returns NodeRenderGraphConnectionPoint
height
-
get height(): number
Height of the geometry texture
Returns number
-
set height(value: number): void
Parameters
- value: number
Returns void
inputs
-
Gets the list of input points
Returns NodeRenderGraphConnectionPoint[]
is Debug
-
get isDebug(): boolean
Gets a boolean indicating if this block is a debug block
Returns boolean
is Input
-
get isInput(): boolean
Gets a boolean indicating if this block is an input
Returns boolean
is Main Object Renderer
-
get isMainObjectRenderer(): boolean
Indicates that this object renderer is the main object renderer of the frame graph.
Returns boolean
-
set isMainObjectRenderer(value: boolean): void
Parameters
- value: boolean
Returns void
is Teleport In
-
get isTeleportIn(): boolean
Gets a boolean indicating if this block is a teleport in
Returns boolean
is Teleport Out
-
get isTeleportOut(): boolean
Gets a boolean indicating if this block is a teleport out
Returns boolean
is Unique
-
get isUnique(): boolean
Gets a boolean indicating that this block can only be used once per node render graph
Returns boolean
name
-
get name(): string
Gets or set the name of the block
Returns string
-
set name(value: string): void
Parameters
- value: string
Returns void
object Renderer
-
Gets the objectRenderer component
Returns NodeRenderGraphConnectionPoint
objects
-
Gets the objects input component
Returns NodeRenderGraphConnectionPoint
oit Pass Count
-
get oitPassCount(): number
Defines the number of passes to use for Order Independent Transparency
Returns number
-
set oitPassCount(value: number): void
Parameters
- value: number
Returns void
output
-
Gets the output component
Returns NodeRenderGraphConnectionPoint
output Depth
-
Gets the output depth component
Returns NodeRenderGraphConnectionPoint
outputs
-
Gets the list of output points
Returns NodeRenderGraphConnectionPoint[]
render Alpha Test Meshes
-
get renderAlphaTestMeshes(): boolean
Indicates if alpha tested meshes should be rendered
Returns boolean
-
set renderAlphaTestMeshes(value: boolean): void
Parameters
- value: boolean
Returns void
render Depth Only Meshes
-
get renderDepthOnlyMeshes(): boolean
Indicates if depth-only meshes should be rendered
Returns boolean
-
set renderDepthOnlyMeshes(value: boolean): void
Parameters
- value: boolean
Returns void
render In Linear Space
-
get renderInLinearSpace(): boolean
If image processing should be disabled
Returns boolean
-
set renderInLinearSpace(value: boolean): void
Parameters
- value: boolean
Returns void
render Meshes
-
get renderMeshes(): boolean
Indicates if meshes should be rendered
Returns boolean
-
set renderMeshes(value: boolean): void
Parameters
- value: boolean
Returns void
render Opaque Meshes
-
get renderOpaqueMeshes(): boolean
Indicates if opaque meshes should be rendered
Returns boolean
-
set renderOpaqueMeshes(value: boolean): void
Parameters
- value: boolean
Returns void
render Particles
-
get renderParticles(): boolean
Indicates if particles should be rendered
Returns boolean
-
set renderParticles(value: boolean): void
Parameters
- value: boolean
Returns void
render Sprites
-
get renderSprites(): boolean
Indicates if sprites should be rendered
Returns boolean
-
set renderSprites(value: boolean): void
Parameters
- value: boolean
Returns void
render Transparent Meshes
-
get renderTransparentMeshes(): boolean
Indicates if transparent meshes should be rendered
Returns boolean
-
set renderTransparentMeshes(value: boolean): void
Parameters
- value: boolean
Returns void
resolve MSAA Colors
-
get resolveMSAAColors(): boolean
If true, MSAA color textures will be resolved at the end of the render pass (default: true)
Returns boolean
-
set resolveMSAAColors(value: boolean): void
Parameters
- value: boolean
Returns void
resolve MSAA Depth
-
get resolveMSAADepth(): boolean
If true, MSAA depth texture will be resolved at the end of the render pass (default: false)
Returns boolean
-
set resolveMSAADepth(value: boolean): void
Parameters
- value: boolean
Returns void
reverse Culling
-
get reverseCulling(): boolean
Indicates if culling must be reversed
Returns boolean
-
set reverseCulling(value: boolean): void
Parameters
- value: boolean
Returns void
samples
-
get samples(): number
Number of samples of the geometry texture
Returns number
-
set samples(value: number): void
Parameters
- value: number
Returns void
shadow Generators
-
Gets the shadowGenerators input component
Returns NodeRenderGraphConnectionPoint
size In Percentage
-
get sizeInPercentage(): boolean
Indicates if the geometry texture width and height are percentages or absolute values
Returns boolean
-
set sizeInPercentage(value: boolean): void
Parameters
- value: boolean
Returns void
target
-
Gets the target texture input component
Returns NodeRenderGraphConnectionPoint
task
-
Gets the frame graph task associated with this block
Returns FrameGraphGeometryRendererTask
use OIT For Transparent Meshes
-
get useOITForTransparentMeshes(): boolean
Indicates if use of Order Independent Transparency (OIT) for transparent meshes should be enabled
Returns boolean
-
set useOITForTransparentMeshes(value: boolean): void
Parameters
- value: boolean
Returns void
width
-
get width(): number
Width of the geometry texture
Returns number
-
set width(value: number): void
Parameters
- value: number
Returns void
Methods
_ deserialize
-
Parameters
- serializationObject: any
Returns void
auto Configure
-
Lets the block try to connect some inputs automatically
Returns void
build
-
Build the current node and generate the vertex data
Parameters
- state: NodeRenderGraphBuildState
defines the current generation state
Returns boolean
true if already built
- state: NodeRenderGraphBuildState
clone
-
Clone the current block to a new identical block
Returns NodeRenderGraphBlock | null
a copy of the current block
dispose
-
Release resources
Returns void
get Class Name
-
Gets the current class name
Returns string
the class name
get Descendant Of Predicate
-
getDescendantOfPredicate(
predicate: (block: NodeRenderGraphBlock) => boolean,
): Nullable<NodeRenderGraphBlock>Get the first descendant using a predicate
Parameters
- predicate: (block: NodeRenderGraphBlock) => boolean
defines the predicate to check
Returns Nullable<NodeRenderGraphBlock>
descendant or null if none found
- predicate: (block: NodeRenderGraphBlock) => boolean
get Input By Name
-
Find an input by its name
Parameters
- name: string
defines the name of the input to look for
Returns NodeRenderGraphConnectionPoint | null
the input or null if not found
- name: string
get Output By Name
-
Find an output by its name
Parameters
- name: string
defines the name of the output to look for
Returns NodeRenderGraphConnectionPoint | null
the output or null if not found
- name: string
initialize
-
Initialize the block and prepare the context for build
Returns void
is An Ancestor Of
-
Checks if the current block is an ancestor of a given block
Parameters
- block: NodeRenderGraphBlock
defines the potential descendant block to check
Returns boolean
true if block is a descendant
- block: NodeRenderGraphBlock
is An Ancestor Of Type
-
Checks if the current block is an ancestor of a given type
Parameters
- type: string
defines the potential type to check
Returns boolean
true if block is a descendant
- type: string
register Input
-
registerInput(
name: string,
type: NodeRenderGraphBlockConnectionPointTypes,
isOptional?: boolean,
point?: NodeRenderGraphConnectionPoint,
): NodeRenderGraphGeometryRendererBlockRegister a new input. Must be called inside a block constructor
Parameters
- name: string
defines the connection point name
- type: NodeRenderGraphBlockConnectionPointTypes
defines the connection point type
- isOptional: boolean = false
defines a boolean indicating that this input can be omitted
Optionalpoint: NodeRenderGraphConnectionPointan already created connection point. If not provided, create a new one
Returns NodeRenderGraphGeometryRendererBlock
the current block
- name: string
register Output
-
registerOutput(
name: string,
type: NodeRenderGraphBlockConnectionPointTypes,
point?: NodeRenderGraphConnectionPoint,
): NodeRenderGraphGeometryRendererBlockRegister a new output. Must be called inside a block constructor
Parameters
- name: string
defines the connection point name
- type: NodeRenderGraphBlockConnectionPointTypes
defines the connection point type
Optionalpoint: NodeRenderGraphConnectionPointan already created connection point. If not provided, create a new one
Returns NodeRenderGraphGeometryRendererBlock
the current block
- name: string
serialize
-
Serializes this block
Returns any
the serialized object
Block that render geometry of objects to a multi render target