The '''Image''' component takes in a [[Component:SpriteProvider|SpriteProvider]] or [[Material]] and renders it onto the [[UIX]]. This can be used to display graphics and produce backgrounds.
An Image component renders a [[Sprite]] using a [[Material]]. This can be used to display graphics and produce backgrounds.
<!--T:3-->
<!--T:3-->
== Usage ==
{{Table ComponentFields
{{Table ComponentFields
|Sprite|Sprite|The sprite to render
|Sprite|{{RootFieldType|AssetRef`1|[[Type:Sprite|Sprite]]}}|TypeAdv0=true|The sprite to render
|Material|Material|The material to render with
|Material|{{RootFieldType|AssetRef`1|[[Type:Material|Material]]}}|TypeAdv1=true|The material to render with
|Tint|Color|A color that is multiplied with the material's color
|PreserveAspect|Bool|Preserves the aspect ratio of this image provided.
|PreserveAspect|Bool|FIXME
|NineSliceSizing|NineSliceSizing|Tells how the image gets 9-sliced on this UIX.
|NineSliceSizing|NineSliceSizing|FIXME
|FlipHorizontally|Bool|Flips the image horizontally.
|InteractionTarget|Bool|FIXME
|FlipVertically|Bool|Flips the image vertically.
|__legacyZWrite|Bool|Internal
|InteractionTarget|Bool|Makes this image as the interaction target for this UIX.
|FillRect|Rect|The filling rect for this image.
|__legacyZWrite|Bool|Internal - The legacy Z writing for this image.
|Tint|ColorX|A color that is multiplied with the material's color.
}}
}}
<!--T:4-->
<!--T:4-->
== Behavior ==
== Usage ==
A user can use this to just display an image with an optional tint color, or have this as a background image for other images to be on top of.
<!--T:5-->
<!--T:5-->
== Examples ==
== Examples ==
Here is [[User:ProbablePrime|ProbablePrime]]'s tutorial on images:
