PictureLayer class - rendering library

Constructors

PictureLayer(Rect canvasBounds): Creates a leaf layer for the layer tree.

Properties

alwaysNeedsAddToScene → bool: Subclasses may override this to true to disable retained rendering.
protected">@protectedread-onlyinherited
attached → bool: Whether this node is in a tree whose root is attached to something.
read-onlyinherited
canvasBounds → Rect: The bounds that were used for the canvas that drew this layer's picture.
final
debugCreator ↔ Object?: The object responsible for creating this layer.
read / writeinherited
debugDisposed → bool: If asserts are enabled, returns whether dispose has been called since the last time any retained resources were created.
read-onlyinherited
debugHandleCount → int: Returns the number of objects holding a LayerHandle to this layer.
read-onlyinherited
debugSubtreeNeedsAddToScene → bool?: Whether this or any descendant layer in the subtree needs addToScene.
visibleForTesting">@visibleForTestingread-onlyinherited
depth → int: The depth of this node in the tree.
read-onlyinherited
engineLayer ↔ EngineLayer?: Stores the engine layer created for this layer in order to reuse engine resources across frames for better app performance.
protected">@protectedprotected">@protectedvisibleForTesting">@visibleForTestingvisibleForTesting">@visibleForTestingread / writeinherited
hashCode → int: The hash code for this object.
read-onlyinherited
isComplexHint ↔ bool: Hints that the painting in this layer is complex and would benefit from caching.
read / write
nextSibling → Layer?: This layer's next sibling in the parent layer's child list.
read-onlyinherited
owner → Object?: The owner for this node (null if unattached).
read-onlyinherited
parent → ContainerLayer?: This layer's parent in the layer tree.
read-onlyinherited
picture ↔ Picture?: The picture recorded for this layer.
read / write
previousSibling → Layer?: This layer's previous sibling in the parent layer's child list.
read-onlyinherited
runtimeType → Type: A representation of the runtime type of the object.
read-onlyinherited
subtreeHasCompositionCallbacks → bool: Whether the subtree rooted at this layer has any composition callback observers.
read-onlyinherited
willChangeHint ↔ bool: Hints that the painting in this layer is likely to change next frame.
read / write

Methods

addCompositionCallback(CompositionCallback callback) → VoidCallback: Adds a callback for when the layer tree that this layer is part of gets composited, or when it is detached and will not be rendered again.
inherited
addToScene(SceneBuilder builder) → void: Override this method to upload this layer to the engine.
override
adoptChild(covariant Layer child) → void: Mark the given node as being a child of this node.
inherited
attach(covariant Object owner) → void: Mark this node as attached to the given owner.
mustCallSuper">@mustCallSuperinherited
debugDescribeChildren() → List<DiagnosticsNode>: Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void: Add additional properties associated with the node.
override
debugMarkClean() → void: Mark that this layer is in sync with engine.
visibleForTesting">@visibleForTestinginherited
describeClipBounds() → Rect?: Describes the clip that would be applied to contents of this layer, if any.
inherited
detach() → void: Mark this node as detached.
mustCallSuper">@mustCallSuperinherited
dispose() → void: Clears any retained resources that this layer holds.
override
dropChild(covariant Layer child) → void: Disconnect the given node from this node.
inherited
find<S extends Object>(Offset localPosition) → S?: Search this layer and its subtree for the first annotation of type S under the point described by localPosition.
inherited
findAllAnnotations<S extends Object>(Offset localPosition) → AnnotationResult<S>: Search this layer and its subtree for all annotations of type S under the point described by localPosition.
inherited
findAnnotations<S extends Object>(AnnotationResult<S> result, Offset localPosition, {required bool onlyFirst}) → bool: Search this layer and its subtree for annotations of type S at the location described by localPosition.
override
markNeedsAddToScene() → void: Mark that this layer has changed and addToScene needs to be called.
protected">@protectedvisibleForTesting">@visibleForTestinginherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a non-existent method or property is accessed.
inherited
redepthChild(AbstractNode child) → void: Adjust the depth of the given child to be greater than this node's own depth.
protected">@protectedinherited
redepthChildren() → void: Adjust the depth of this node's children, if any.
inherited
remove() → void: Removes this layer from its parent layer's child list.
mustCallSuper">@mustCallSuperinherited
supportsRasterization() → bool: Whether or not this layer, or any child layers, can be rasterized with Scene.toImage or Scene.toImageSync.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode: Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String: A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String: Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String: Returns a one-line detailed description of the object.
inherited
toStringShort() → String: A brief description of this object, usually just the runtimeType and the hashCode.
inherited
updateSubtreeNeedsAddToScene() → void: Traverses the layer subtree starting from this layer and determines whether it needs addToScene.
protected">@protectedvisibleForTesting">@visibleForTestinginherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

PictureLayer class Null safety

Constructors

Properties

Methods

Operators

rendering library