class Img extends Rect
A node for displaying images.
import ...
export default makeScene2D(function* (view) {
const ref = createRef<Img>();
yield view.add(
<Img
ref={ref}
src="https://images.unsplash.com/photo-1679218407381-a6f1660d60e9"
width={300}
radius={20}
/>,
);
// set the background using the color sampled from the image:
ref().fill(ref().getColorAtPoint(0));
yield* all(
ref().size([100, 100], 1).to([300, null], 1),
ref().radius(50, 1).to(20, 1),
ref().alpha(0, 1).to(1, 1),
);
yield* waitFor(0.5);
});
Extended by
Icon
Constructors
constructor
Parameters
props: ImgProps
Rect.constructorProperties
absolutePosition
readonly public absolutePosition: SimpleVector2SignalImg
A helper signal for operating on the position in world space.
Retrieving the position using this signal returns the position in world space. Similarly, setting the position using this signal transforms the new value to local space.
If the new value is a function, the position of this node will be continuously updated to always match the position returned by the function. This can be useful to "pin" the node in a specific place or to make it follow another node's position.
Unlike position, this signal is not compound - it doesn't contain
separate signals for the x and y components.
Rect.absolutePositionabsoluteRotation
readonly public absoluteRotation: SimpleSignalnumberImg
A helper signal for operating on the rotation in world space.
Retrieving the rotation using this signal returns the rotation in world space. Similarly, setting the rotation using this signal transforms the new value to local space.
If the new value is a function, the rotation of this node will be continuously updated to always match the rotation returned by the function.
Inherited fromRect.absoluteRotationabsoluteScale
readonly public absoluteScale: SimpleVector2SignalImg
A helper signal for operating on the scale in world space.
Retrieving the scale using this signal returns the scale in world space. Similarly, setting the scale using this signal transforms the new value to local space.
If the new value is a function, the scale of this node will be continuously updated to always match the position returned by the function.
Unlike scale, this signal is not compound - it doesn't contain
separate signals for the x and y components.
Rect.absoluteScalealignContent
readonly public alignContent: SimpleSignalFlexContentImg
Rect.alignContentalignItems
readonly public alignItems: SimpleSignalFlexItemsImg
Rect.alignItemsalignSelf
readonly public alignSelf: SimpleSignalFlexItemsImg
Rect.alignSelfalpha
readonly public alpha: SimpleSignalnumberImg
The alpha value of this image.
Unlike opacity, the alpha value affects only the image itself, leaving the fill, stroke, and children intact.
antialiased
readonly public antialiased: SimpleSignalbooleanImg
Rect.antialiasedarrowSize
readonly public arrowSize: SimpleSignalnumberImg
Controls the size of the end and start arrows.
To make the arrows visible make sure to enable startArrow and/or
endArrow.
Rect.arrowSizebasis
readonly public basis: SimpleSignalFlexBasisImg
Rect.basisbottom
readonly public bottom: SimpleVector2SignalImg
The position of the bottom edge of this node.
When set, this shortcut property will modify the node's position so that the bottom edge ends up in the given place.
When retrieved, it will return the position of the bottom edge in the parent space.
Inherited fromRect.bottombottomLeft
readonly public bottomLeft: SimpleVector2SignalImg
The position of the bottom left corner of this node.
When set, this shortcut property will modify the node's position so that the bottom left corner ends up in the given place.
When retrieved, it will return the position of the bottom left corner in the parent space.
Inherited fromRect.bottomLeftbottomRight
readonly public bottomRight: SimpleVector2SignalImg
The position of the bottom right corner of this node.
When set, this shortcut property will modify the node's position so that the bottom right corner ends up in the given place.
When retrieved, it will return the position of the bottom right corner in the parent space.
Inherited fromRect.bottomRightcache
readonly public cache: SimpleSignalbooleanImg
Rect.cachecachePadding
readonly public cachePadding: SpacingSignalImg
Controls the padding of the cached canvas used by this node.
By default, the size of the cache is determined based on the bounding box
of the node and its children. That includes effects such as stroke or
shadow. This property can be used to expand the cache area further.
Usually used to account for custom effects created by shaders.
Rect.cachePaddingchildren
readonly public children: SignalComponentChildrenNode[]ImgSignalContextComponentChildrenNode[]Img
Rect.childrenclip
readonly public clip: SimpleSignalbooleanImg
Rect.clipclosed
readonly public closed: SimpleSignalbooleanImg
Whether the curve should be closed.
Closed curves have their start and end points connected.
Inherited fromRect.closedcomposite
readonly public composite: SimpleSignalbooleanImg
Rect.compositecompositeOperation
readonly public compositeOperation: SimpleSignalGlobalCompositeOperationImg
Rect.compositeOperation