Class UIDrawImageElement

Defines an image element within UIDrawContent.

Index

Constructors

Properties

_border _clipPath _depth? _image _preserveAspect _rect _tint

Accessors

border clipPath depth image preserveAspect rect tint

Methods

assign clone isEqual isEqual

Constructors

constructor

new UIDrawImageElement(
    image?: Image,
    rect?: Immutable<rsx.UIRectPoint>,
    tint?: Immutable<SRGBColor>,
    border?: Immutable<rsx.UIRectOffsetPixel>,
    preserveAspect?: boolean,
    clipPath?: Path,
    depth?: number,
): UIDrawImageElement
Parameters
- Optionalimage: Image
- Optionalrect: Immutable<rsx.UIRectPoint>
- Optionaltint: Immutable<SRGBColor>
- Optionalborder: Immutable<rsx.UIRectOffsetPixel>
- OptionalpreserveAspect: boolean
- OptionalclipPath: Path
- Optionaldepth: number
Returns UIDrawImageElement

Properties

`Protected`_border

_border: RectOffset

`Protected`_clipPath

_clipPath: Path

`Protected` `Optional`_depth

_depth?: number

`Protected`_image

_image: Image

`Protected`_preserveAspect

_preserveAspect: boolean

`Protected`_rect

_rect: Rect2

`Protected`_tint

_tint: SRGBColor

Accessors

border

get border(): RectOffset

Scale9Grid borders in pixels (0 = no 9-slice).

Returns RectOffset
set border(value: Immutable<rsx.UIRectOffsetPixel>): void
Parameters
- value: Immutable<rsx.UIRectOffsetPixel>
Returns void

clipPath

get clipPath(): Path

Clip path in local point coordinates. If set, the image is clipped to this path shape.

Returns Path
set clipPath(value: Path): void
Parameters
- value: Path
Returns void

depth

get depth(): number

Optional depth layer override. If unset, the default insertion-order depth is used.

Returns number
set depth(value: number): void
Parameters
- value: number
Returns void

image

get image(): Image

The image resource to display.

Returns Image
set image(value: Image): void
Parameters
- value: Image
Returns void

preserveAspect

get preserveAspect(): boolean

Whether to preserve the image's aspect ratio when scaling.

Returns boolean
set preserveAspect(value: boolean): void
Parameters
- value: boolean
Returns void

rect

get rect(): Rect2

Position and size in points.

Returns Rect2
set rect(value: Immutable<rsx.UIRectPoint>): void
Parameters
- value: Immutable<rsx.UIRectPoint>
Returns void

tint

get tint(): SRGBColor

Color tint applied to the image. White = no tint.

Returns SRGBColor
set tint(value: Immutable<SRGBColor>): void
Parameters
- value: Immutable<SRGBColor>
Returns void

Methods

assign

assign(other: Immutable<UIDrawImageElement>): UIDrawImageElement
Copies all properties defined by the prototype of UIDrawImageElement from other to this instance.
Parameters
- other: Immutable<UIDrawImageElement>
Returns UIDrawImageElement

clone

clone(): UIDrawImageElement

Clones this instance and returns a new UIDrawImageElement with identical values.

Returns UIDrawImageElement

isEqual

isEqual(
this: Immutable<UIDrawImageElement>,
other: Immutable<UIDrawImageElement>,
): boolean
Determines if this UIDrawImageElement instance is equal to the other instance.
Parameters
- this: Immutable<UIDrawImageElement>
- other: Immutable<UIDrawImageElement>
Returns boolean

`Static`isEqual

isEqual(
lhs: Immutable<UIDrawImageElement>,
rhs: Immutable<UIDrawImageElement>,
): boolean
Determines if both UIDrawImageElement instances are equal.
Parameters
- lhs: Immutable<UIDrawImageElement>
- rhs: Immutable<UIDrawImageElement>
Returns boolean