Class NodeRenderGraphCircleOfConfusionPostProcessBlock
Hierarchy (View Summary)
- NodeRenderGraphBaseWithPropertiesPostProcessBlock
- NodeRenderGraphCircleOfConfusionPostProcessBlock
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
-
new NodeRenderGraphCircleOfConfusionPostProcessBlock(
name: string,
frameGraph: FrameGraph,
scene: Scene,
): NodeRenderGraphCircleOfConfusionPostProcessBlockCreate a new NodeRenderGraphCircleOfConfusionPostProcessBlock
Parameters
- name: string
defines the block name
- frameGraph: FrameGraph
defines the hosting frame graph
- scene: Scene
defines the hosting scene
Returns NodeRenderGraphCircleOfConfusionPostProcessBlock
- name: string
Properties
comments
A free comment about the block
on
Gets an observable raised when the block is built
unique
Gets or sets the unique id of the node
visible
Gets or sets a boolean indicating that this input can be edited from a collapsed frame
Accessors
alpha
-
get alphaMode(): number
The alpha mode to use when applying the post process.
Returns number
-
set alphaMode(value: number): void
Parameters
- value: number
Returns void
camera
-
get camera(): NodeRenderGraphConnectionPoint
Gets the camera input component
Returns NodeRenderGraphConnectionPoint
depth
-
get depthReadOnly(): boolean
If true, the depth attachment will be read-only.
Returns boolean
-
set depthReadOnly(value: boolean): void
Parameters
- value: boolean
Returns void
depth
-
get depthSamplingMode(): number
Sampling mode used to sample from the depth texture
Returns number
-
set depthSamplingMode(value: number): void
Parameters
- value: number
Returns void
depth
-
get depthTest(): boolean
If depth testing should be enabled (default is true).
Returns boolean
-
set depthTest(value: boolean): void
Parameters
- value: boolean
Returns void
disable
-
get disableColorWrite(): boolean
If true, color write will be disabled when applying the post process.
Returns boolean
-
set disableColorWrite(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
draw
-
get drawBackFace(): boolean
If true, the post process will be generated by a back face full-screen quad (CW order).
Returns boolean
-
set drawBackFace(value: boolean): void
Parameters
- value: boolean
Returns void
focal
-
get focalLength(): number
Focal length of the effect's camera in scene units/1000 (eg. millimeter)
Returns number
-
set focalLength(value: number): void
Parameters
- value: number
Returns void
focus
-
get focusDistance(): number
Distance away from the camera to focus on in scene units/1000 (eg. millimeter)
Returns number
-
set focusDistance(value: number): void
Parameters
- value: number
Returns void
f
-
get fStop(): number
F-Stop of the effect's camera. The diameter of the resulting aperture can be computed by lensSize/fStop
Returns number
-
set fStop(value: number): void
Parameters
- value: number
Returns void
geom
-
get geomViewDepth(): NodeRenderGraphConnectionPoint
Gets the geometry view depth input component
Returns NodeRenderGraphConnectionPoint
inputs
-
Gets the list of input points
Returns NodeRenderGraphConnectionPoint[]
is
-
get isDebug(): boolean
Gets a boolean indicating if this block is a debug block
Returns boolean
is
-
get isInput(): boolean
Gets a boolean indicating if this block is an input
Returns boolean
is
-
get isTeleportIn(): boolean
Gets a boolean indicating if this block is a teleport in
Returns boolean
is
-
get isTeleportOut(): boolean
Gets a boolean indicating if this block is a teleport out
Returns boolean
is
-
get isUnique(): boolean
Gets a boolean indicating that this block can only be used once per node render graph
Returns boolean
lens
-
get lensSize(): number
Max lens size in scene units/1000 (eg. millimeter). Standard cameras are 50mm. The diameter of the resulting aperture can be computed by lensSize/fStop.
Returns number
-
set lensSize(value: number): void
Parameters
- value: number
Returns void
name
-
get name(): string
Gets or set the name of the block
Returns string
-
set name(value: string): void
Parameters
- value: string
Returns void
output
-
get output(): NodeRenderGraphConnectionPoint
Gets the output component
Returns NodeRenderGraphConnectionPoint
outputs
-
Gets the list of output points
Returns NodeRenderGraphConnectionPoint[]
source
-
get source(): NodeRenderGraphConnectionPoint
Gets the source input component
Returns NodeRenderGraphConnectionPoint
source
-
get sourceSamplingMode(): number
Sampling mode used to sample from the source texture
Returns number
-
set sourceSamplingMode(value: number): void
Parameters
- value: number
Returns void
stencil
-
get stencilReadOnly(): boolean
If true, the stencil attachment will be read-only.
Returns boolean
-
set stencilReadOnly(value: boolean): void
Parameters
- value: boolean
Returns void
target
-
get target(): NodeRenderGraphConnectionPoint
Gets the target input component
Returns NodeRenderGraphConnectionPoint
task
-
get task(): FrameGraphCircleOfConfusionTask
Gets the frame graph task associated with this block
Returns FrameGraphCircleOfConfusionTask
use
-
get useCurrentViewport(): boolean
If true, the current viewport will be left unchanged.
Returns boolean
-
set useCurrentViewport(value: boolean): void
Parameters
- value: boolean
Returns void
use
-
get useFullScreenViewport(): boolean
If true, a full screen viewport will be used.
Returns boolean
-
set useFullScreenViewport(value: boolean): void
Parameters
- value: boolean
Returns void
viewport
-
get viewport(): IViewportLike
The viewport to use.
Returns IViewportLike
-
set viewport(value: IViewportLike): void
Parameters
- value: IViewportLike
Returns void
Methods
_
-
Parameters
- serializationObject: any
Returns void
auto
-
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
-
Gets the current class name
Returns string
the class name
get
-
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
-
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
-
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
-
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
-
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
-
registerInput(
name: string,
type: NodeRenderGraphBlockConnectionPointTypes,
isOptional?: boolean,
point?: NodeRenderGraphConnectionPoint,
): NodeRenderGraphCircleOfConfusionPostProcessBlockRegister 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 NodeRenderGraphCircleOfConfusionPostProcessBlock
the current block
- name: string
register
-
registerOutput(
name: string,
type: NodeRenderGraphBlockConnectionPointTypes,
point?: NodeRenderGraphConnectionPoint,
): NodeRenderGraphCircleOfConfusionPostProcessBlockRegister 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 NodeRenderGraphCircleOfConfusionPostProcessBlock
the current block
- name: string
serialize
-
Serializes this block in a JSON representation
Returns any
the serialized block object
Block that implements the circle of confusion post process