# ImageButton

Roblox Engine API class from Roblox Studio 0.744.0.7441077 (version-7aaa6838d36c4448).

- Inherits from, nearest first: [GuiButton](https://rapi.sleaze.dev/classes/GuiButton.md), [GuiObject](https://rapi.sleaze.dev/classes/GuiObject.md), [GuiBase2d](https://rapi.sleaze.dev/classes/GuiBase2d.md), [GuiBase](https://rapi.sleaze.dev/classes/GuiBase.md), [Instance](https://rapi.sleaze.dev/classes/Instance.md), [Object](https://rapi.sleaze.dev/classes/Object.md)
- Memory category: Gui
- HTML page: https://rapi.sleaze.dev/classes/ImageButton/
- Roblox documentation: https://create.roblox.com/docs/reference/engine/classes/ImageButton

A 2D user interface element that displays an interactive image.

## Properties

### ContentImageSize

```luau
ImageButton.ContentImageSize: Vector2 = Vector2.zero
```

- Tags: Hidden, Read only, Roblox script security, Read capabilities: UI

### HoverImage

```luau
ImageButton.HoverImage: string = ""
```

- Tags: Read capabilities: UI

A texture ID that will be used when the [`ImageButton`](https://rapi.sleaze.dev/classes/ImageButton.md) is being hovered.

### HoverImageContent

```luau
ImageButton.HoverImageContent: Content
```

- Tags: Read capabilities: UI

The image content that will be used when the [`ImageButton`](https://rapi.sleaze.dev/classes/ImageButton.md) is being hovered. Only supports asset URIs.

### Image

```luau
ImageButton.Image: string = ""
```

- Tags: Read capabilities: UI

The image content displayed by the [`ImageButton`](https://rapi.sleaze.dev/classes/ImageButton.md) element. Reads and writes to [`ImageContent`](https://rapi.sleaze.dev/classes/ImageButton.md).

### ImageColor3

```luau
ImageButton.ImageColor3: Color3 = Color3.new(1, 1, 1)
```

- Tags: Read capabilities: UI

Determines how a rendered image will be colorized.

### ImageContent

```luau
ImageButton.ImageContent: Content
```

- Tags: Read capabilities: UI

The image content displayed by the UI element. Supports asset URIs and [`EditableImage`](https://rapi.sleaze.dev/classes/EditableImage.md) objects.

### ImageRectOffset

```luau
ImageButton.ImageRectOffset: Vector2 = Vector2.zero
```

- Tags: Read capabilities: UI

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

### ImageRectSize

```luau
ImageButton.ImageRectSize: Vector2 = Vector2.zero
```

- Tags: Read capabilities: UI

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

### ImageTransparency

```luau
ImageButton.ImageTransparency: number = 0
```

- Tags: Read capabilities: UI

Determines the transparency of the rendered image.

### IsLoaded

```luau
ImageButton.IsLoaded: boolean = false
```

- Tags: Read only, Read capabilities: UI

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

### LocalizedImageContent

```luau
ImageButton.LocalizedImageContent: Content
```

- Tags: Not replicated, Read: Roblox script security, Write: Not accessible, Read capabilities: UI, Load only

### PressedImage

```luau
ImageButton.PressedImage: string = ""
```

- Tags: Read capabilities: UI

A texture ID that will be used when an [`ImageButton`](https://rapi.sleaze.dev/classes/ImageButton.md) is being pressed.

### PressedImageContent

```luau
ImageButton.PressedImageContent: Content
```

- Tags: Read capabilities: UI

The image content that will be used when an [`ImageButton`](https://rapi.sleaze.dev/classes/ImageButton.md) is being pressed. Only supports asset URIs.

### ResampleMode

```luau
ImageButton.ResampleMode: Enum.ResamplerMode = Enum.ResamplerMode.Default
```

- Tags: Read capabilities: UI

Selects the image resampling mode for the button.

### ScaleType

```luau
ImageButton.ScaleType: Enum.ScaleType = Enum.ScaleType.Stretch
```

- Tags: Read capabilities: UI

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

### SliceCenter

```luau
ImageButton.SliceCenter: Rect = Rect.new(0, 0, 0, 0)
```

- Tags: Read capabilities: UI

Sets the slice boundaries of a 9-sliced image.

### SliceScale

```luau
ImageButton.SliceScale: number = 1
```

- Tags: Read capabilities: UI

Scales the 9-slice edges by the specified ratio.

### TileSize

```luau
ImageButton.TileSize: UDim2 = UDim2.new(1, 0, 1, 0)
```

- Tags: Read capabilities: UI

Sets the tiling scale of the ImageButton.

## Methods

### SetEnableContentImageSizeChangedEvents

```luau
ImageButton:SetEnableContentImageSizeChangedEvents(enabled: boolean)
```

- Tags: Roblox script security, Capabilities: UI

## Inherited members

- From [GuiButton](https://rapi.sleaze.dev/classes/GuiButton.md): `AutoButtonColor`, `Modal`, `Style`, `MouseButton1ClickConnectionCount`, `MouseButton1DownConnectionCount`, `MouseButton1UpConnectionCount`, `MouseButton2ClickConnectionCount`, `MouseButton2DownConnectionCount`, `MouseButton2UpConnectionCount`, `HoverHapticEffect`, `PressHapticEffect`, `Selected`, `Activated`, `MouseButton1Click`, `MouseButton1Down`, `MouseButton1Up`, `MouseButton2Click`, `MouseButton2Down`, `MouseButton2Up`, `SecondaryActivated`
- From [GuiObject](https://rapi.sleaze.dev/classes/GuiObject.md): `SelectionImageObject`, `ClipsDescendants`, `Draggable`, `Active`, `AnchorPoint`, `AutomaticSize`, `BackgroundColor3`, `BackgroundTransparency`, `BorderColor3`, `BorderMode`, `BorderSizePixel`, `InputSink`, `Interactable`, `LayoutOrder`, `Position`, `Rotation`, `SelectionRect2D`, `Sink`, `Size`, `SizeConstraint`, `Visible`, `ZIndex`, `BackgroundColor`, `BorderColor`, `Transparency`, `DragBeginConnectionCount`, `DragStoppedConnectionCount`, `MouseEnterConnectionCount`, `MouseLeaveConnectionCount`, `MouseMovedConnectionCount`, `MouseWheelBackwardConnectionCount`, `MouseWheelForwardConnectionCount`, `NextSelectionDown`, `NextSelectionLeft`, `NextSelectionRight`, `NextSelectionUp`, `Selectable`, `SelectionOrder`, `GuiState`, `TweenPositionInternal`, `TweenSizeAndPositionInternal`, `TweenSizeInternal`, `TweenPosition`, `TweenSize`, `TweenSizeAndPosition`, `InputBegan`, `InputChanged`, `InputEnded`, `MouseEnter`, `MouseLeave`, `MouseMoved`, `MouseWheelBackward`, `MouseWheelForward`, `SelectionGained`, `SelectionLost`, `TouchLongPress`, `TouchPan`, `TouchPinch`, `TouchRotate`, `TouchSwipe`, `TouchTap`, `DragBegin`, `DragStopped`
- From [GuiBase2d](https://rapi.sleaze.dev/classes/GuiBase2d.md): `AbsolutePosition`, `AbsoluteRotation`, `AbsoluteSize`, `ActiveQueryNames`, `ReplicatedInsertionOrder`, `ClippedRect`, `IsNotOccluded`, `RawRect2D`, `TotalGroupScale`, `AutoLocalize`, `RootLocalizationTable`, `Localize`, `SelectionBehaviorDown`, `SelectionBehaviorLeft`, `SelectionBehaviorRight`, `SelectionBehaviorUp`, `SelectionGroup`, `SelectionChanged`
- From [Instance](https://rapi.sleaze.dev/classes/Instance.md): `Archivable`, `archivable`, `Attributes`, `AttributesReplicate`, `AttributesSerialize`, `HistoryId`, `Name`, `Parent`, `PredictionMode`, `PropertyStatusStudio`, `RobloxLocked`, `SerializedOverrides`, `SourceAssetId`, `Tags`, `UniqueId`, `numExpectedDirectChildren`, `DataCost`, `Capabilities`, `DefinesCapabilities`, `IsInSandbox`, `Sandboxed`, `AddTag`, `ClearAllChildren`, `Clone`, `Destroy`, `FindFirstAncestor`, `FindFirstAncestorOfClass`, `FindFirstAncestorWhichIsA`, `FindFirstChild`, `FindFirstChildOfClass`, `FindFirstChildWhichIsA`, `FindFirstDescendant`, `GetActor`, `GetAttribute`, `GetAttributeChangedSignal`, `GetAttributes`, `GetChildren`, `GetDebugId`, `GetDescendants`, `GetFullName`, `GetStyled`, `GetStyledPropertyChangedSignal`, `GetTags`, `HasTag`, `IsAncestorOf`, `IsDescendantOf`, `IsPropertyModified`, `QueryDescendants`, `RemoveTag`, `ResetPropertyToDefault`, `SetAttribute`, `WaitForChild`, `Remove`, `children`, `clone`, `destroy`, `findFirstChild`, `getChildren`, `isDescendantOf`, `remove`, `AncestryChanged`, `AttributeChanged`, `ChildAdded`, `ChildRemoved`, `DescendantAdded`, `DescendantRemoving`, `Destroying`, `StyledPropertiesChanged`, `childAdded`
- From [Object](https://rapi.sleaze.dev/classes/Object.md): `ClassName`, `className`, `GetPropertyChangedSignal`, `IsA`, `isA`, `Changed`