# ScreenshotHud

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

- Inherits from, nearest first: [Instance](https://rapi.sleaze.dev/classes/Instance.md), [Object](https://rapi.sleaze.dev/classes/Object.md)
- Tags: Not creatable, Not replicated
- Memory category: Instances
- HTML page: https://rapi.sleaze.dev/classes/ScreenshotHud/
- Roblox documentation: https://create.roblox.com/docs/reference/engine/classes/ScreenshotHud

A 2D user interface that allows users to capture and save screenshots to their local device.

## Properties

### CameraButtonIcon

```luau
ScreenshotHud.CameraButtonIcon: string
```

- Tags: Capabilities: UI

Asset ID of the icon used for the camera button.

### CameraButtonIconContent

```luau
ScreenshotHud.CameraButtonIconContent: Content
```

- Tags: Capabilities: UI

The image content used as the icon for the camera button.

### CameraButtonPosition

```luau
ScreenshotHud.CameraButtonPosition: UDim2
```

- Tags: Capabilities: UI

Screen location of the camera button.

### CloseButtonPosition

```luau
ScreenshotHud.CloseButtonPosition: UDim2
```

- Tags: Capabilities: UI

Screen location of the close button.

### ExperienceNameOverlayEnabled

```luau
ScreenshotHud.ExperienceNameOverlayEnabled: boolean
```

- Tags: Deprecated, Hidden, Capabilities: UI

**Deprecated:** This property is deprecated. Do not use it for new work.

Whether the experience name in the overlay is enabled.

### OverlayFont

```luau
ScreenshotHud.OverlayFont: Enum.Font
```

- Tags: Deprecated, Hidden, Capabilities: UI

**Deprecated:** This property is deprecated. Do not use it for new work.

[`Font`](https://rapi.sleaze.dev/index/types/Font.md) used for the experience name in the overlay.

### UsernameOverlayEnabled

```luau
ScreenshotHud.UsernameOverlayEnabled: boolean
```

- Tags: Deprecated, Hidden, Capabilities: UI

**Deprecated:** This property is deprecated. Do not use it for new work.

Has no effect.

### CloseWhenScreenshotTaken

```luau
ScreenshotHud.CloseWhenScreenshotTaken: boolean
```

- Tags: Capabilities: UI

Whether the [`ScreenshotHud`](https://rapi.sleaze.dev/classes/ScreenshotHud.md) closes automatically when a screenshot is taken.

### HideCoreGuiForCaptures

```luau
ScreenshotHud.HideCoreGuiForCaptures: boolean
```

- Tags: Capabilities: UI

Whether Roblox's core GUI is hidden while a screenshot is captured.

### HidePlayerGuiForCaptures

```luau
ScreenshotHud.HidePlayerGuiForCaptures: boolean
```

- Tags: Capabilities: UI

Whether the local player's GUI is hidden while a screenshot is captured.

### Visible

```luau
ScreenshotHud.Visible: boolean
```

- Tags: Capabilities: UI

Determines whether the [`ScreenshotHud`](https://rapi.sleaze.dev/classes/ScreenshotHud.md) is visible.

## Inherited members

- 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`
