ImageButton
A 2D user interface element that displays an interactive image.
Memory category | Gui |
---|
Member index 16
Description
An ImageButton behaves similarly to an ImageLabel in regards to rendering, with the additional behaviors of a GuiButton.
History 74
- 649 Change CanSave of from false to true
- 649 Change CanLoad of from false to true
- 648 Change Tags of from [Hidden, NotReplicated] to [Hidden]
- 647 Add
- 645 Change ValueType of PressedImage from Content to ContentId
- 645 Change ValueType of Image from Content to ContentId
- 645 Change ValueType of HoverImage from Content to ContentId
- 573 Change ReturnType of SetEnableContentImageSizeChangedEvents from void to null
- 553 Change Default of TileSize from to UDim2({1, 0}, {1, 0})
- 553 Change Default of SliceScale from to 1
- 553 Change Default of SliceCenter from to Rect(0, 0, 0, 0)
- 553 Change Default of ScaleType from to Stretch
- 553 Change Default of ResampleMode from to Default
- 553 Change Default of IsLoaded from to false
- 553 Change Default of ImageTransparency from to 0
- 553 Change Default of ImageRectSize from to Vector2(0, 0)
- 553 Change Default of ImageRectOffset from to Vector2(0, 0)
- 553 Change Default of ImageColor3 from to Color3(1, 1, 1)
- 553 Change Default of from to Vector2(0, 0)
- 496 Add SetEnableContentImageSizeChangedEvents
- 496 Add
- 490 Add ResampleMode
- 486 Change ThreadSafety of TileSize from ReadOnly to ReadSafe
- 486 Change ThreadSafety of SliceScale from ReadOnly to ReadSafe
- 486 Change ThreadSafety of SliceCenter from ReadOnly to ReadSafe
- 486 Change ThreadSafety of ScaleType from ReadOnly to ReadSafe
- 486 Change ThreadSafety of PressedImage from ReadOnly to ReadSafe
- 486 Change ThreadSafety of IsLoaded from ReadOnly to ReadSafe
- 486 Change ThreadSafety of ImageTransparency from ReadOnly to ReadSafe
- 486 Change ThreadSafety of ImageRectSize from ReadOnly to ReadSafe
- 486 Change ThreadSafety of ImageRectOffset from ReadOnly to ReadSafe
- 486 Change ThreadSafety of ImageColor3 from ReadOnly to ReadSafe
- 486 Change ThreadSafety of Image from ReadOnly to ReadSafe
- 486 Change ThreadSafety of HoverImage from ReadOnly to ReadSafe
- 462 Change ThreadSafety of TileSize from to ReadOnly
- 462 Change ThreadSafety of SliceScale from to ReadOnly
- 462 Change ThreadSafety of SliceCenter from to ReadOnly
- 462 Change ThreadSafety of ScaleType from to ReadOnly
- 462 Change ThreadSafety of PressedImage from to ReadOnly
- 462 Change ThreadSafety of IsLoaded from to ReadOnly
- 462 Change ThreadSafety of ImageTransparency from to ReadOnly
- 462 Change ThreadSafety of ImageRectSize from to ReadOnly
- 462 Change ThreadSafety of ImageRectOffset from to ReadOnly
- 462 Change ThreadSafety of ImageColor3 from to ReadOnly
- 462 Change ThreadSafety of Image from to ReadOnly
- 462 Change ThreadSafety of HoverImage from to ReadOnly
- 368 Change WriteSecurity of SliceScale from RobloxScriptSecurity to None
- 368 Change Tags of SliceScale from [Hidden, NotReplicated] to []
- 368 Change ReadSecurity of SliceScale from RobloxScriptSecurity to None
- 368 Change CanSave of SliceScale from false to true
- 368 Change CanLoad of SliceScale from false to true
- 359 Change CanLoad of SliceScale from true to false
- 359 Change CanSave of SliceScale from true to false
- 359 Change Tags of SliceScale from [] to [Hidden, NotReplicated]
- 359 Change ReadSecurity of SliceScale from None to RobloxScriptSecurity
- 359 Change WriteSecurity of SliceScale from None to RobloxScriptSecurity
- 356 Add SliceScale
- 350 Add PressedImage
- 350 Add HoverImage
- 290 Add TileSize
- 290 Add IsLoaded
- 207 Add SliceCenter
- 207 Add ScaleType
- 202 Remove SliceCenter
- 202 Remove ScaleType
- 203 Add SliceCenter
- 203 Add ScaleType
- 163 Add ImageColor3
- 148 Add ImageTransparency
- 131 Add ImageRectSize
- 131 Add ImageRectOffset
- 55 Change Tags of ImageButton from [preliminary] to []
- 47 Add Image
- 47 Add ImageButton
Members 16
HoverImage
Type | Default | |
---|---|---|
ContentId |
A texture ID that will be used when the ImageButton is being hovered.
Thread safety | ReadSafe |
---|---|
Category | Image |
Loaded/Saved | true |
History 4
- 645 Change ValueType of HoverImage from Content to ContentId
- 486 Change ThreadSafety of HoverImage from ReadOnly to ReadSafe
- 462 Change ThreadSafety of HoverImage from to ReadOnly
- 350 Add HoverImage
Image
Type | Default | |
---|---|---|
ContentId |
This property is a content-type property that should hold the asset ID of a decal or image uploaded to Roblox. It functions identically to Decal.Texture with regards to loading the image from Roblox. The rendered image will be colorized using ImageColor3.
Note that it is possible to make the image render as tiled, scaled to fit, or 9-sliced by adjusting the ScaleType property.
Thread safety | ReadSafe |
---|---|
Category | Image |
Loaded/Saved | true |
ImageColor3
Type | Default | |
---|---|---|
Color3 | 1, 1, 1 |
This property determines how an image is colorized. When set to white, no colorization occurs. This property is very useful for reusing image assets: If the source image is completely white with transparency, you can set the entire color of the image at once with this property.
Thread safety | ReadSafe |
---|---|
Category | Image |
Loaded/Saved | true |
History 4
- 553 Change Default of ImageColor3 from to Color3(1, 1, 1)
- 486 Change ThreadSafety of ImageColor3 from ReadOnly to ReadSafe
- 462 Change ThreadSafety of ImageColor3 from to ReadOnly
- 163 Add ImageColor3
ImageRectOffset
Type | Default | |
---|---|---|
Vector2 | 0, 0 |
This property determines the pixel offset (from the top-left) of the image area to be displayed, allowing for the partial display of an image in conjunction with ImageRectSize.
Thread safety | ReadSafe |
---|---|
Category | Image |
Loaded/Saved | true |
History 4
- 553 Change Default of ImageRectOffset from to Vector2(0, 0)
- 486 Change ThreadSafety of ImageRectOffset from ReadOnly to ReadSafe
- 462 Change ThreadSafety of ImageRectOffset from to ReadOnly
- 131 Add ImageRectOffset
ImageRectSize
Type | Default | |
---|---|---|
Vector2 | 0, 0 |
This property determines the pixel size of the image area to be displayed,
allowing for the partial display of an image in conjunction with
ImageRectOffset. If either dimension
is set to 0
, the entire image is displayed instead.
Thread safety | ReadSafe |
---|---|
Category | Image |
Loaded/Saved | true |
History 4
- 553 Change Default of ImageRectSize from to Vector2(0, 0)
- 486 Change ThreadSafety of ImageRectSize from ReadOnly to ReadSafe
- 462 Change ThreadSafety of ImageRectSize from to ReadOnly
- 131 Add ImageRectSize
ImageTransparency
Type | Default | |
---|---|---|
float | 0 |
This property determines the alpha of the element's rendered image. A
value of 0
is completely opaque and a value of 1
is completely
transparent (invisible). This property behaves similarly to
GuiObject.BackgroundTransparency or BasePart.Transparency.
If you disable image rendering by setting
ImageTransparency to 1
, it will
result in a plain rectangle that can be used as a button. However, it may
be better to use a blank TextButton instead.
Thread safety | ReadSafe |
---|---|
Category | Image |
Loaded/Saved | true |
History 4
- 553 Change Default of ImageTransparency from to 0
- 486 Change ThreadSafety of ImageTransparency from ReadOnly to ReadSafe
- 462 Change ThreadSafety of ImageTransparency from to ReadOnly
- 148 Add ImageTransparency
IsLoaded
Type | Default | |
---|---|---|
bool | false |
This property indicates if the Image property has finished loading from Roblox. Images declined by moderation will never load.
Thread safety | ReadSafe |
---|---|
Category | Image |
Loaded/Saved | false |
PressedImage
Type | Default | |
---|---|---|
ContentId |
A texture ID that can be set as an ImageButton property. When the button is pressed, it will render this image.
Thread safety | ReadSafe |
---|---|
Category | Image |
Loaded/Saved | true |
History 4
- 645 Change ValueType of PressedImage from Content to ContentId
- 486 Change ThreadSafety of PressedImage from ReadOnly to ReadSafe
- 462 Change ThreadSafety of PressedImage from to ReadOnly
- 350 Add PressedImage
ResampleMode
Type | Default | |
---|---|---|
ResamplerMode | Default |
Determines how the image looks when it is scaled. By default, the image smooths out the texture when displayed either larger or smaller than its size in texture memory. In contrast, Enum.ResamplerMode.Pixelated preserves the sharp edges of the image pixels.
Thread safety | ReadSafe |
---|---|
Category | Image |
Loaded/Saved | true |
History 2
- 553 Change Default of ResampleMode from to Default
- 490 Add ResampleMode
ScaleType
Type | Default | |
---|---|---|
ScaleType | Stretch |
This property determines in what way the Image property is rendered when the UI element's absolute size differs from the source image's size.
By default, this property is Enum.ScaleType.Stretch which will simply stretch/compact the image dimensions so it fits the UI element's space exactly. Since transparent pixels are set to black when uploading to Roblox, transparent images should apply alpha blending to avoid a blackish outline around scaled images.
For ScaleType.Slice, when scaling up, the corners will remain the source image size. The edges of the image will stretch to the width/height of the image. Finally, the center of the image will stretch to fill the center area of the image. To learn more about 9‑sliced images, see UI 9‑Slice Design.
For ScaleType.Tile, the size of each image tile is determined by the TileSize property.
Thread safety | ReadSafe |
---|---|
Category | Image |
Loaded/Saved | true |
SetEnableContentImageSizeChangedEvents
Parameters (1) | ||
---|---|---|
enabled | bool | |
Returns (1) | ||
null |
Security | RobloxScriptSecurity |
---|---|
Thread safety | Unsafe |
History 2
- 573 Change ReturnType of SetEnableContentImageSizeChangedEvents from void to null
- 496 Add SetEnableContentImageSizeChangedEvents
SliceCenter
Type | Default | |
---|---|---|
Rect | 0, 0, 0, 0 |
This property sets the slice boundaries of a 9-sliced image when ScaleType is set to Enum.ScaleType.Slice.
To learn more about 9‑sliced images, see UI 9‑Slice Design.
Thread safety | ReadSafe |
---|---|
Category | Image |
Loaded/Saved | true |
History 6
- 553 Change Default of SliceCenter from to Rect(0, 0, 0, 0)
- 486 Change ThreadSafety of SliceCenter from ReadOnly to ReadSafe
- 462 Change ThreadSafety of SliceCenter from to ReadOnly
- 207 Add SliceCenter
- 202 Remove SliceCenter
- 203 Add SliceCenter
SliceScale
Type | Default | |
---|---|---|
float | 1 |
Scales the 9-slice edges by the specified ratio. This means that the edges
around the 9‑slice will grow as if you'd uploaded a new version of the
texture upscaled. Defaults to 1.0
.
As a multiplier for the borders of a 9-slice, it is useful for reusing one rounded corner image for multiple radii.
See also ScaleType which determines how an image will scale if displayed in a UI element whose size differs from the source image.
Thread safety | ReadSafe |
---|---|
Category | Image |
Loaded/Saved | true |
History 14
- 553 Change Default of SliceScale from to 1
- 486 Change ThreadSafety of SliceScale from ReadOnly to ReadSafe
- 462 Change ThreadSafety of SliceScale from to ReadOnly
- 368 Change WriteSecurity of SliceScale from RobloxScriptSecurity to None
- 368 Change Tags of SliceScale from [Hidden, NotReplicated] to []
- 368 Change ReadSecurity of SliceScale from RobloxScriptSecurity to None
- 368 Change CanSave of SliceScale from false to true
- 368 Change CanLoad of SliceScale from false to true
- 359 Change CanLoad of SliceScale from true to false
- 359 Change CanSave of SliceScale from true to false
- 359 Change Tags of SliceScale from [] to [Hidden, NotReplicated]
- 359 Change ReadSecurity of SliceScale from None to RobloxScriptSecurity
- 359 Change WriteSecurity of SliceScale from None to RobloxScriptSecurity
- 356 Add SliceScale
TileSize
Type | Default | |
---|---|---|
UDim2 | {1, 0}, {1, 0} |
Sets the tiling size of the ImageButton starting at the upper-left
corner of the image. The default UDim2 values are 1, 0, 1, 0
0.5
means the tile will be half the size of the
ImageButton in the corresponding axis.
This property is only active if the ScaleType property is set to ScaleType.Tile.
Thread safety | ReadSafe |
---|---|
Category | Image |
Loaded/Saved | true |