Applies a mask generated by a Shader to its child.
For example, RenderShaderMask can be used to gradually fade out the edge
of a child by using a ui.Gradient.linear
mask.
- Inheritance
- Object
- AbstractNode
- RenderObject
- RenderBox
- RenderProxyBox
- RenderShaderMask
Constructors
- RenderShaderMask({ShaderCallback shaderCallback, TransferMode transferMode: TransferMode.modulate, RenderBox child })
-
Creates a render object that applies a mask generated by a Shader to its child.
Properties
- alwaysNeedsCompositing → bool
-
read-only
- shaderCallback → ShaderCallback
-
Called to creates the
Shader
that generates the mask.read / write - transferMode → TransferMode
-
The
TransferMode
to use when applying the shader to the child.read / write - attached → bool
-
Whether this node is in a tree whose root is attached to something.
read-only, inherited - child → RenderBox
-
The render object's unique child
read / write, inherited - constraints → BoxConstraints
-
The box constraints most recently received from the parent.
read-only, inherited - debugCanParentUseSize → bool
-
Whether the parent render object is permitted to use this render object's size.
read-only, inherited - debugCreator → dynamic
-
The object responsible for creating this render object.
read / write, inherited - debugDoingThisLayout → bool
-
Whether
performLayout
for this render object is currently running.read-only, inherited - debugDoingThisPaint → bool
-
Whether
paint
for this render object is currently running.read-only, inherited - debugDoingThisResize → bool
-
Whether
performResize
for this render object is currently running.read-only, inherited - debugSemantics → SemanticsNode
-
The semantics of this render object.
read-only, inherited - depth → int
-
The depth of this node in the tree.
read-only, inherited - hashCode → int
-
Get a hash code for this object.
read-only, inherited - hasSize → bool
-
Whether this render object has undergone layout and has a
size
.read-only, inherited - isRepaintBoundary → bool
-
Whether this render object repaints separately from its parent.
read-only, inherited - isSemanticBoundary → bool
-
Whether this RenderObject introduces a new box for accessibility purposes.
read-only, inherited - layer → OffsetLayer
-
The compositing layer that this render object uses to repaint.
read-only, inherited - needsCompositing → bool
-
Whether we or one of our descendants has a compositing layer.
read-only, inherited - needsLayout → bool
-
Whether this render object's layout information is dirty.
read-only, inherited - owner → PipelineOwner
-
read-only, inherited
- paintBounds → Rect
-
Returns a rectangle that contains all the pixels painted by this box.
read-only, inherited - parent → AbstractNode
-
The parent of this node in the tree.
read-only, inherited - parentData → ParentData
-
Data for use by the parent render object.
read / write, inherited - runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited - semanticBounds → Rect
-
read-only, inherited
- semanticsAnnotator → SemanticsAnnotator
-
Returns a function that will annotate a
SemanticsNode
with the semantics of thisRenderObject
.read-only, inherited - size → Size
-
The size of this render box computed during layout.
read / write, inherited - sizedByParent → bool
-
Whether the constraints are the only input to the sizing algorithm (in particular, child nodes have no impact).
read-only, inherited
Operators
-
operator ==(
other) → bool -
The equality operator.
inherited
Methods
-
paint(
PaintingContext context, Offset offset) → void -
Paint this render object into the given context at the given offset.
-
adoptChild(
RenderObject child) → void -
Called by subclasses when they decide a render object is a child.
inherited -
applyPaintTransform(
RenderObject child, Matrix4 transform) → void -
Multiply the transform from the parent's coordinate system to this box's coordinate system into the given transform.
inherited -
attach(
PipelineOwner owner) → void -
Mark this node as attached to the given owner.
inherited -
clearSemantics(
) → void -
Removes all semantics from this render object and its descendants.
inherited -
computeDistanceToActualBaseline(
TextBaseline baseline) → double -
Returns the distance from the y-coordinate of the position of the box to the y-coordinate of the first given baseline in the box's contents, if any, or null otherwise.
inherited -
computeMaxIntrinsicHeight(
double width) → double -
Computes the value returned by
getMaxIntrinsicHeight
. Do not call this function directly, instead, callgetMaxIntrinsicHeight
.inherited -
computeMaxIntrinsicWidth(
double height) → double -
Computes the value returned by
getMaxIntrinsicWidth
. Do not call this function directly, instead, callgetMaxIntrinsicWidth
.inherited -
computeMinIntrinsicHeight(
double width) → double -
Computes the value returned by
getMinIntrinsicHeight
. Do not call this function directly, instead, callgetMinIntrinsicHeight
.inherited -
computeMinIntrinsicWidth(
double height) → double -
Computes the value returned by
getMinIntrinsicWidth
. Do not call this function directly, instead, callgetMinIntrinsicWidth
.inherited -
debugAssertDoesMeetConstraints(
) → void -
Verify that the object's constraints are being met. Override this function in a subclass to verify that your state matches the constraints object. This function is only called in checked mode and only when needsLayout is false. If the constraints are not met, it should assert or throw an exception.
inherited -
debugDescribeChildren(
String prefix) → String -
Returns a string describing the current node's descendants. Each line of the subtree in the output should be indented by the prefix argument.
inherited -
debugFillDescription(
List<String> description) → void -
Accumulates a list of strings describing the current node's fields, one field per string. Subclasses should override this to have their information included in
toStringDeep
.inherited -
debugHandleEvent(
PointerEvent event, HitTestEntry entry) → bool -
Implements the debugPaintPointersEnabled debugging feature.
inherited -
debugPaint(
PaintingContext context, Offset offset) → void -
Override this method to paint debugging information.
inherited -
debugPaintBaselines(
PaintingContext context, Offset offset) → void -
In debug mode, paints a line for each baseline.
inherited -
debugPaintPointers(
PaintingContext context, Offset offset) → void -
In debug mode, paints a rectangle if this render box has counted more pointer downs than pointer up events.
inherited -
debugPaintSize(
PaintingContext context, Offset offset) → void -
In debug mode, paints a border around this render box.
inherited -
debugRegisterRepaintBoundaryPaint(
{bool includedParent: true, bool includedChild: false }) → void -
Called, in checked mode, if isRepaintBoundary is true, when either the this render object or its parent attempt to paint.
inherited -
debugResetSize(
) → void -
If a subclass has a "size" (the state controlled by
parentUsesSize
, whatever it is in the subclass, e.g. the actualsize
property ofRenderBox
), and the subclass verifies that in checked mode this "size" property isn't used whendebugCanParentUseSize
isn't set, then that subclass should overridedebugResetSize
to reapply the current values ofdebugCanParentUseSize
to that state.inherited -
describeApproximatePaintClip(
RenderObject child) → Rect -
Returns a rect in this object's coordinate system that describes the approximate bounding box of the clip rect that would be applied to the given child during the paint phase, if any.
inherited -
detach(
) → void -
Mark this node as detached.
inherited -
dropChild(
RenderObject child) → void -
Called by subclasses when they decide a render object is no longer a child.
inherited -
getDistanceToActualBaseline(
TextBaseline baseline) → double -
Calls computeDistanceToActualBaseline and caches the result.
inherited -
getDistanceToBaseline(
TextBaseline baseline, { bool onlyReal: false }) → double -
Returns the distance from the y-coordinate of the position of the box to the y-coordinate of the first given baseline in the box's contents.
inherited -
getMaxIntrinsicHeight(
double width) → double -
Returns the smallest height beyond which increasing the height never decreases the preferred width. The preferred width is the value that would be returned by getMinIntrinsicWidth for that height.
inherited -
getMaxIntrinsicWidth(
double height) → double -
Returns the smallest width beyond which increasing the width never decreases the preferred height. The preferred height is the value that would be returned by getMinIntrinsicHeight for that width.
inherited -
getMinIntrinsicHeight(
double width) → double -
Returns the minimum height that this box could be without failing to correctly paint its contents within itself, without clipping.
inherited -
getMinIntrinsicWidth(
double height) → double -
Returns the minimum width that this box could be without failing to correctly paint its contents within itself, without clipping.
inherited -
globalToLocal(
Point point) → Point -
Convert the given point from the global coodinate system to the local coordinate system for this box.
inherited -
handleEvent(
PointerEvent event, HitTestEntry entry) → void -
Override this method to handle pointer events that hit this render object.
inherited -
hitTest(
HitTestResult result, { Point position }) → bool -
Determines the set of render objects located at the given position.
inherited -
hitTestChildren(
HitTestResult result, { Point position }) → bool -
Override this method to check whether any children are located at the given position.
inherited -
hitTestSelf(
Point position) → bool -
Override this method if this render object can be hit even if its children were not hit.
inherited -
invokeLayoutCallback(
LayoutCallback callback) → void -
Allows mutations to be made to this object's child list (and any descendants) as well as to any other dirty nodes in the render tree owned by the same PipelineOwner as this object. The
callback
argument is invoked synchronously, and the mutations are allowed only during that callback's execution.inherited -
layout(
Constraints constraints, { bool parentUsesSize: false }) → void -
Compute the layout for this render object.
inherited -
localToGlobal(
Point point) → Point -
Convert the given point from the local coordinate system for this box to the global coordinate system.
inherited -
markNeedsCompositingBitsUpdate(
) → void -
Mark the compositing state for this render object as dirty.
inherited -
markNeedsLayout(
) → void -
Mark this render object's layout information as dirty, and either register this object with its
PipelineOwner
, or defer to the parent, depending on whether this object is a relayout boundary or not respectively.inherited -
markNeedsPaint(
) → void -
Mark this render object as having changed its visual appearance.
inherited -
markNeedsSemanticsUpdate(
{bool onlyChanges: false, bool noGeometry: false }) → void -
Mark this node as needing an update to its semantics description.
inherited -
markParentNeedsLayout(
) → void -
Mark this render object's layout information as dirty, and then defer to the parent.
inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed.
inherited -
performLayout(
) → void -
Do the work of computing the layout for this render object.
inherited -
performResize(
) → void -
Updates the render objects size using only the constraints.
inherited -
reassemble(
) → void -
Cause the entire subtree rooted at the given RenderObject to be marked dirty for layout, paint, etc. This is called by the RendererBinding in response to the
ext.flutter.reassemble
hook, which is used by development tools when the application code has changed, to cause the widget tree to pick up any changed implementations.inherited -
redepthChild(
AbstractNode child) → void -
Adjust the depth of the given
child
to be greated than this node's own depth.inherited -
redepthChildren(
) → void -
Adjust the
depth
of this node's children, if any.inherited -
replaceRootLayer(
OffsetLayer rootLayer) → void -
Replace the layer. This is only valid for the root of a render object subtree (whatever object scheduleInitialPaint was called on).
inherited -
rotate(
{int oldAngle, int newAngle, Duration time }) → void -
Rotate this render object (not yet implemented).
inherited -
scheduleInitialLayout(
) → void -
Bootstrap the rendering pipeline by scheduling the very first layout.
inherited -
scheduleInitialPaint(
ContainerLayer rootLayer) → void -
Bootstrap the rendering pipeline by scheduling the very first paint.
inherited -
scheduleInitialSemantics(
) → void -
Bootstrap the semantics reporting mechanism by marking this node as needing a semantics update.
inherited -
setupParentData(
RenderObject child) → void -
Override to setup parent data correctly for your children.
inherited -
toString(
) → String -
Returns a human understandable name.
inherited -
toStringDeep(
[String prefixLineOne = '', String prefixOtherLines = '' ]) → String -
Returns a description of the tree rooted at this node. If the prefix argument is provided, then every line in the output will be prefixed by that string.
inherited -
toStringShallow(
) → String -
Returns a one-line detailed description of the render object. This description is often somewhat long.
inherited -
visitChildren(
RenderObjectVisitor visitor) → void -
Calls visitor for each immediate child of this render object.
inherited -
visitChildrenForSemantics(
RenderObjectVisitor visitor) → void -
Called when collecting the semantics of this node. Subclasses that have children that are not semantically relevant (e.g. because they are invisible) should skip those children here.
inherited