Skip to main content

UIImage

Renders a texture or sprite within its rectangle, with color tint support.

Create in the Editor​

  1. Ensure there is a UIController in the scene.
  2. Create a GameObject and add UIRect.
  3. Add the UIImage component.

How to Use​

  1. Get the component with myObject.findComponent(UIImage.class).
  2. Read and write the component properties to control behavior.
  3. Test input or layout in Play mode.

Java Example​

SpatialObject myObject = /* your object */;
UIImage comp = myObject.findComponent(UIImage.class);
if (comp != null) {
Texture tex = /* load texture */ null;
// set the border value:
comp.border = 1f;
// read the border value:
float borderValue = comp.border;

// set the color value:
comp.color = new Color(255, 255, 255, 255);
// read the color value:
Color colorValue = comp.color;

// set the texture value:
comp.texture = tex;
// read the texture value:
Texture textureValue = comp.texture;

}