UIImage
Defined in: ui/src/UIImage.ts:16
Displays a texture as a UI element, scaling to fit Yoga-computed dimensions.
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new UIImage(
props):UIImage
Defined in: ui/src/UIImage.ts:28
Parameters
Section titled “Parameters”Returns
Section titled “Returns”UIImage
Properties
Section titled “Properties”container
Section titled “container”
readonlycontainer:Sprite
Defined in: ui/src/UIImage.ts:17
yogaNode
Section titled “yogaNode”
readonlyyogaNode:Node
Defined in: ui/src/UIImage.ts:18
Implementation of
Section titled “Implementation of”Accessors
Section titled “Accessors”displayObject
Section titled “displayObject”Get Signature
Section titled “Get Signature”get displayObject():
DisplayContainer
Defined in: ui/src/UIImage.ts:20
Returns
Section titled “Returns”DisplayContainer
Implementation of
Section titled “Implementation of”visible
Section titled “visible”Get Signature
Section titled “Get Signature”get visible():
boolean
Defined in: ui/src/UIImage.ts:83
Returns
Section titled “Returns”boolean
Set Signature
Section titled “Set Signature”set visible(
v):void
Defined in: ui/src/UIImage.ts:87
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”Methods
Section titled “Methods”applyLayout()
Section titled “applyLayout()”applyLayout():
void
Defined in: ui/src/UIImage.ts:76
Scale sprite to match Yoga computed size.
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”destroy()
Section titled “destroy()”destroy():
void
Defined in: ui/src/UIImage.ts:112
Idempotent — a second call is a no-op.
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”update()
Section titled “update()”update(
p):void
Defined in: ui/src/UIImage.ts:92
Parameters
Section titled “Parameters”Partial<UIImageProps>
Returns
Section titled “Returns”void