Layer class

A composited layer.

During painting, the render tree generates a tree of composited layers that are uploaded into the engine and displayed by the compositor. This class is the base class for all composited layers.

Most layers can have their properties mutated, and layers can be moved to different parents. The scene must be explicitly recomposited after such changes are made; the layer tree does not maintain its own dirty state.

To composite the tree, create a SceneBuilder object, pass it to the root Layer object's addToScene method, and then call to obtain a Scene. A Scene can then be painted using Window.render.

See also:

Implemented by




debugCreator ↔ dynamic
The object responsible for creating this layer. [...]
read / write
nextSibling Layer
This layer's next sibling in the parent layer's child list.
parent ContainerLayer
This layer's parent in the layer tree. [...]
previousSibling Layer
This layer's previous sibling in the parent layer's child list.
attached → bool
Whether this node is in a tree whose root is attached to something. [...]
read-only, inherited
depth → int
The depth of this node in the tree. [...]
read-only, inherited
hashCode → int
The hash code for this object. [...]
read-only, inherited
owner → Object
The owner for this node (null if unattached). [...]
read-only, inherited
runtimeType → Type
A representation of the runtime type of the object.
read-only, inherited


addToScene(SceneBuilder builder, Offset layerOffset) → void
Override this method to upload this layer to the engine. [...]
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
find<S>(Offset regionOffset) → S
Returns the value of S that corresponds to the point described by regionOffset. [...]
remove() → void
Removes this layer from its parent layer's child list. [...]
replaceWith(Layer newLayer) → void
Replaces this layer with the given layer in the parent layer's child list.
toStringShort() → String
adoptChild(AbstractNode child) → void
Mark the given node as being a child of this node. [...]
@mustCallSuper, @protected, inherited
attach(Object owner) → void
Mark this node as attached to the given owner. [...]
@mustCallSuper, inherited
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children. [...]
detach() → void
Mark this node as detached. [...]
@mustCallSuper, inherited
dropChild(AbstractNode child) → void
Disconnect the given node from this node. [...]
@mustCallSuper, @protected, inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
redepthChild(AbstractNode child) → void
Adjust the depth of the given child to be greater than this node's own depth. [...]
@protected, inherited
redepthChildren() → void
Adjust the depth of this node's children, if any. [...]
toDiagnosticsNode({String name, DiagnosticsTreeStyle style }) DiagnosticsNode
toString({DiagnosticLevel minLevel: DiagnosticLevel.debug }) → String
Returns a string representation of this object.
toStringDeep({String prefixLineOne: '', String prefixOtherLines, DiagnosticLevel minLevel: DiagnosticLevel.debug }) → String
Returns a string representation of this node and its descendants. [...]
toStringShallow({String joiner: ', ', DiagnosticLevel minLevel: DiagnosticLevel.debug }) → String
Returns a one-line detailed description of the object. [...]


operator ==(dynamic other) → bool
The equality operator. [...]