PostProcessSequentialGroup class
A special type of PostProcess that is used to group multiple post processes together. This is useful for applying multiple post processes at once, but in a sequential manner.
This means that each post process will be considered part of the subtree of the next one. This is useful for post processes that need to be rendered in a specific order, or that need to share the same subtree.
In other words, the subtree of the group post process will be the subtree of the first post process in the group, and all the other post processes will be rendered with the same subtree.
See also:
- PostProcess for a single post process and more information on what is the "subtree" of a post process.
- PostProcessGroup for a group of post processes that will be applied in parallel where all the post processes will be rendered with the same subtree.
- Inheritance
-
- Object
- PostProcess
- PostProcessGroup
- PostProcessSequentialGroup
Constructors
-
PostProcessSequentialGroup.new({required List<
PostProcess> postProcesses})
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- pixelRatio ↔ double
-
The pixel ratio of the screen. This is used to scale the image generated
by rasterizeSubtree to the correct size.
getter/setter pairinherited
-
postProcesses
→ List<
PostProcess> -
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
onLoad(
) → Future< void> -
Similarly to components, post processes can be loaded asynchronously.
inherited
-
postProcess(
Vector2 size, Canvas canvas) → void -
There the effects of the post process are applied. This is where you
should implement the logic of the post process. Including eventual calls
to rasterizeSubtree and renderSubtree.
inherited
-
rasterizeSubtree(
) → Image -
One of the two methods that subclasses should invoke to render the
what is considered the "subtree" of the post process.
inherited
-
render(
Canvas canvas, Vector2 size, ValueSetter< Canvas> renderTree, ValueSetter<PostProcess?> updateContext) → void -
This method is called to render the post process, to be called by the
"owner" of
the post process, like a CameraComponent or a PostProcessComponent.
override
-
renderSubtree(
Canvas canvas) → void -
One of the two methods that subclasses should invoke to render the
what is considered the "subtree" of the post process.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
update(
double dt) → void -
This method is called every frame to update the post process.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited