PcoWSkbVqDnWTu_dm2ix
Collapse Sidebar
  1. API Reference
  2. ImageLabel

ImageLabel

Show deprecated
Hide content
  1. apireference
  2. imagelabel

ImageLabel

Show deprecated

An ImageLabel renders a rectangle, like a Frame does, with an image. The image must be a decal uploaded to the Roblox website. The display of the image can be manipulated through the ImageLabel/ImageColor3 and ImageLable/ImageTransparency properties. To display only the image and hide the rectangle, set GuiObject/BackgroundTransparency to 1.

The image is scaled to fit the entirety of the rectangle, but remember that images look best when displayed at their native resolution. Before uploading your image asset, you may want to apply alpha bleeding and take a few more steps when building UI for high-DPI devices (like phones).

Advanced ImageLabel usage

  • Spritesheets can be used with ImageLabel through the use of ImageLabel/ImageRectOffset and ImageLabel/ImageRectSize. Packing multiple images into one and using this property can make your game’s image assets load much quicker, especially if you use many small icons in your GUIs.
  • Nine-slice images can be created by setting ImageLabel/ScaleType to Enum.ScaleType.Slice, then ImageLabel/SliceCenter to the center area of the nine-slice image.
  • Tiled images can be created by setting ImageLabel/ScaleType to Enum.ScaleType.Tiled, then ImageLabel/TileSize to be the size of rendered tiles.

Properties

Content

Image

The image content displayed by the UI element.
Color3

ImageColor3

Determines how a rendered image will be colorized.
Vector2

ImageRectOffset

The offset in pixels of the sub-area of an image to be displayed
Vector2

ImageRectSize

Determines the size in pixels of the sub-area of an image to be displayed.
float

ImageTransparency

Determines the transparency of the rendered image
bool

IsLoaded

[ReadOnly] [NotReplicated]

Indicates whether the Image has finished loading from the Roblox website.
ScaleType

ScaleType

Determines how an image will scale if displayed in a UI element whose size differs from the source image.
Rect

SliceCenter

Determines the center of a nine-slice image.
float

SliceScale

Scales the 9slice edges by the specified ratio
UDim2

TileSize

Sets the tiling size of the ImageLabel.

Inherited from GuiObject: Show Hide

bool

Active

Determines whether a UI element sinks input
Vector2

AnchorPoint

Determines the origin point of a GuiObject|GUI, relative to its absolute size
AutomaticSize

AutomaticSize

Determines whether resizing occurs based on child content
BrickColor

BackgroundColor

[Hidden] [NotReplicated] [Deprecated]

Determines the color of a GuiObject|GUI's background
Color3

BackgroundColor3

Determines aGuiObject|GUI's background color
float

BackgroundTransparency

Determines the transparency of the GuiObject|GUI's background and border
BrickColor

BorderColor

[Hidden] [NotReplicated] [Deprecated]

Determines the color of a GuiObject|GUI's border
Color3

BorderColor3

Determines the color of a GuiObject|GUI's border
BorderMode

BorderMode

Determines in what manner a GuiObject’s border is laid out relative to its dimensions.
int

BorderSizePixel

Determines the pixel width of a GuiObject|GUI's border
bool

ClipsDescendants

Determines if descendant GuiObject|GUIs outside of the bounds of a parent GUI element should render
bool

Draggable

[Deprecated]

Determines whether a GuiObject|GUI (and its descendants) can be dragged around the screen
int

LayoutOrder

Controls the sort order of a GuiObject|GUI when used with a UIGridStyleLayout
GuiObject

NextSelectionDown

Sets the GuiObject which will be selected when the Gamepad selector is moved in this direction
GuiObject

NextSelectionLeft

Sets the GuiObject which will be selected when the Gamepad selector is moved in this direction
GuiObject

NextSelectionRight

Sets the GuiObject|GUI which will be selected when the `Enum/Gamepad selector is moved in this direction
GuiObject

NextSelectionUp

Sets the GuiObject which will be selected when the Gamepad selector is moved in this direction
UDim2

Position

Determines the pixel and scalar position of a GUI
float

Rotation

Determines the number of degrees by which a UI element is rotated
bool

Selectable

Determine whether the GuiObject|GUI can be selected by a gamepad
GuiObject

SelectionImageObject

Overrides the default selection adornment (used for gamepads)
UDim2

Size

Determine the pixel and scalar size of a GuiObject|GUI
SizeConstraint

SizeConstraint

Selects the GuiObject/Size axes that a GuiObject|GUI will be based relative to the size of its parent
float

Transparency

[Hidden] [NotReplicated]

A mixed property of BackgroundTransparency and TextTransparency
bool

Visible

Determines whether a GuiObject/GUI and its descendants will be rendered
int

ZIndex

Determines the order in which a GuiObject|GUI renders relative to other GUIs

Inherited from GuiBase2d: Show Hide

Vector2

AbsolutePosition

[ReadOnly] [NotReplicated]

Describes the actual screen position of a UI element, in pixels.
float

AbsoluteRotation

[ReadOnly] [NotReplicated]

Describes the actual screen rotation of a UI element, in degrees.
Vector2

AbsoluteSize

[ReadOnly] [NotReplicated]

Describes the actual screen size of a UI element, in pixels.
bool

AutoLocalize

When set to true, localization will be applied to this GuiBase2d and its descendants based on the GuiBase2d/RootLocalizationTable specified for this GuiBase2d.
bool

Localize

[Hidden] [NotReplicated] [Deprecated]

Automatically set to true when a LocalizationTable’s Root targets this object, or an ancestor of this object.
LocalizationTable

RootLocalizationTable

A reference to a LocalizationTable to be used to apply automated localization to this GuiBase2d and its descendants.

Inherited from Instance: Show Hide

bool

Archivable

Determines if an Instance can be cloned using /Instance/Clone or saved to file.
string

ClassName

[ReadOnly] [NotReplicated]

A read-only string representing the class this Instance belongs to
int

DataCost

[Hidden] [ReadOnly] [NotReplicated] [Deprecated]

The cost of saving the instance using data persistence.
string

Name

A non-unique identifier of the Instance
Instance

Parent

[NotReplicated]

Determines the hierarchical parent of the Instance
bool

RobloxLocked

[Hidden]

A deprecated property that used to protect CoreGui objects
bool

archivable

[Hidden] [NotReplicated] [Deprecated]
string

className

[ReadOnly] [NotReplicated] [Deprecated]

Functions

Inherited from GuiObject: Show Hide

bool

TweenPosition ( UDim2 endPosition , EasingDirection easingDirection , EasingStyle easingStyle , float time , bool override , Function callback )

Smoothly moves a GUI to a new DataType/UDim2
bool

TweenSize ( UDim2 endSize , EasingDirection easingDirection , EasingStyle easingStyle , float time , bool override , Function callback )

Smoothly resizes a GUI to a new DataType/UDim2
bool

TweenSizeAndPosition ( UDim2 endSize , UDim2 endPosition , EasingDirection easingDirection , EasingStyle easingStyle , float time , bool override , Function callback )

Smoothly moves a GUI to a new size and position

Inherited from Instance: Show Hide

void

ClearAllChildren ( )

This function destroys all of an Instance’s children.
Instance

Clone ( )

Create a copy of an object and all its descendants, ignoring objects that are not Instance/Archivable|Archivable
void

Destroy ( )

Sets the Instance/Parent property to nil, locks the Instance/Parent property, disconnects all connections and calls Destroy on all children.
Instance

FindFirstAncestor ( string name )

Returns the first ancestor of the Instance whose Instance/Name is equal to the given name.
Instance

FindFirstAncestorOfClass ( string className )

Returns the first ancestor of the Instance whose Instance/ClassName is equal to the given className.
Instance

FindFirstAncestorWhichIsA ( string className )

Returns the first ancestor of the Instance for whom Instance/IsA returns true for the given className.
Instance

FindFirstChild ( string name , bool recursive )

Returns the first child of the Instance found with the given name.
Instance

FindFirstChildOfClass ( string className )

Returns the first child of the Instance whose Instance/ClassName|ClassName is equal to the given className.
Instance

FindFirstChildWhichIsA ( string className , bool recursive )

Returns the first child of the Instance for whom Instance/IsA returns true for the given className.
Instance

FindFirstDescendant ( string name )

Actor

GetActor ( )

Variant

GetAttribute ( string attribute )

Returns the attribute which has been assigned to the given name
RBXScriptSignal

GetAttributeChangedSignal ( string attribute )

Returns an event that fires when the given attribute changes
Dictionary

GetAttributes ( )

Returns a dictionary of string → variant pairs for each of the Instance|Instance’s attributes
Objects

GetChildren ( )

Returns an array containing all of the Instance’s children.
string

GetDebugId ( int scopeLength )

[NotBrowsable]

Returns a coded string of the Instances DebugId used internally by Roblox.
Array

GetDescendants ( )

[CustomLuaState]

Returns an array containing all of the descendants of the instance
string

GetFullName ( )

Returns a string describing the Instance’s ancestry.
RBXScriptSignal

GetPropertyChangedSignal ( string property )

Get an event that fires when a given property of an object changes.
bool

IsA ( string className )

[CustomLuaState]

Returns true if an Instance’s class matches or inherits from a given class
bool

IsAncestorOf ( Instance descendant )

Returns true if an Instance is an ancestor of the given descendant.
bool

IsDescendantOf ( Instance ancestor )

Returns true if an Instance is a descendant of the given ancestor.
void

Remove ( )

[Deprecated]

Sets the object’s Parent to nil, and does the same for all its descendants.
void

SetAttribute ( string attribute , Variant value )

Sets the attribute with the given name to the given value
Instance

WaitForChild ( string childName , double timeOut )

[CustomLuaState] [CanYield]

Returns the child of the Instance with the given name. If the child does not exist, it will yield the current thread until it does.
Objects

children ( )

[Deprecated]

Returns an array of the object’s children.
Instance

clone ( )

[Deprecated]
void

destroy ( )

[Deprecated]
Instance

findFirstChild ( string name , bool recursive )

[Deprecated]
Objects

getChildren ( )

[Deprecated]
bool

isA ( string className )

[Deprecated] [CustomLuaState]
bool

isDescendantOf ( Instance ancestor )

[Deprecated]
void

remove ( )

[Deprecated]

Events

Inherited from GuiObject: Show Hide

RBXScriptSignal

DragBegin ( UDim2 initialPosition )

[Deprecated]

Fired when a player begins dragging the object
RBXScriptSignal

DragStopped ( int x , int y )

[Deprecated]

Fired when a player stops dragging the object
RBXScriptSignal

InputBegan ( InputObject input )

Fired when a user begins interacting via a Human-Computer Interface device (Mouse button down, touch begin, keyboard button down, etc)
RBXScriptSignal

InputChanged ( InputObject input )

Fired when a user changes how they’re interacting via a Human-Computer Interface device (Mouse button down, touch begin, keyboard button down, etc)
RBXScriptSignal

InputEnded ( InputObject input )

Fired when a user stops interacting via a Human-Computer Interface device (Mouse button down, touch begin, keyboard button down, etc)
RBXScriptSignal

MouseEnter ( int x , int y )

Fires when a user moves their mouse into a GUI element
RBXScriptSignal

MouseLeave ( int x , int y )

Fires when a user moves their mouse out of a GUI element
RBXScriptSignal

MouseMoved ( int x , int y )

Fires whenever a user moves their mouse while it is inside a GUI element
RBXScriptSignal

MouseWheelBackward ( int x , int y )

Fires when a user scrolls their mouse wheel back when the mouse is over a GUI element
RBXScriptSignal

MouseWheelForward ( int x , int y )

Fires when a user scrolls their mouse wheel forward when the mouse is over a GUI element
RBXScriptSignal

SelectionGained ( )

Fired when the GuiObject is being focused on with the Gamepad selector
RBXScriptSignal

SelectionLost ( )

Fired when the Gamepad selector stops focusing on the GuiObject
RBXScriptSignal

TouchLongPress ( Array touchPositions , UserInputState state )

Fires when the player starts, continues and stops long-pressing the UI element
RBXScriptSignal

TouchPan ( Array touchPositions , Vector2 totalTranslation , Vector2 velocity , UserInputState state )

Fires when the player moves their finger on the UI element
RBXScriptSignal

TouchPinch ( Array touchPositions , float scale , float velocity , UserInputState state )

Fires when the player performs a pinch or pull gesture using two fingers on the UI element
RBXScriptSignal

TouchRotate ( Array touchPositions , float rotation , float velocity , UserInputState state )

Fires when the player performs a rotation gesture using two fingers on the UI element
RBXScriptSignal

TouchSwipe ( SwipeDirection swipeDirection , int numberOfTouches )

Fires when the player performs a swipe gesture on the UI element
RBXScriptSignal

TouchTap ( Array touchPositions )

Fires when the player performs a tap gesture on the UI element

Inherited from Instance: Show Hide

RBXScriptSignal

AncestryChanged ( Instance child , Instance parent )

Fires when the Instance/Parent property of the object or one of its ancestors is changed.
RBXScriptSignal

AttributeChanged ( string attribute )

Fires whenever an attribute is changed on the Instance
RBXScriptSignal

Changed ( string property )

Fired immediately after a property of an object changes.
RBXScriptSignal

ChildAdded ( Instance child )

Fires when an object is parented to this Instance.
RBXScriptSignal

ChildRemoved ( Instance child )

Fires when a child is removed from this Instance.
RBXScriptSignal

DescendantAdded ( Instance descendant )

Fires when a descendant is added to the Instance
RBXScriptSignal

DescendantRemoving ( Instance descendant )

Fires immediately before a descendant of the Instance is removed.
RBXScriptSignal

childAdded ( Instance child )

[Deprecated]

Code Samples

Image Animation using Spritesheet

This code sample uses ImageRectOffset/ImageRectSize in order to play an animation of a man throwing a punch

-- Place this in an ImageLabel/ImageButton with size 256x256
local imageLabel = script.Parent

-- The following image is 1024x1024 with 12 frames (256x256)
-- The frames play an animation of a man throwing a punch
imageLabel.Image = "rbxassetid://848623155"
imageLabel.ImageRectSize = Vector2.new(256, 256)

-- The order of the frames to be displayed (left-to-right, then top-to-bottom)
local frames = {
	Vector2.new(0, 0); Vector2.new(1, 0); Vector2.new(2, 0); Vector2.new(3, 0);
	Vector2.new(0, 1); Vector2.new(1, 1); Vector2.new(2, 1); Vector2.new(3, 1);
	Vector2.new(0, 2); Vector2.new(1, 2); Vector2.new(2, 2); Vector2.new(3, 2);
}

-- Animate the frames one at a time in a loop
while true do
	for i = 1, #frames do
		imageLabel.ImageRectOffset = frames[i] * imageLabel.ImageRectSize
		wait(.1)
	end
end
ImageButton PlayerGui