Reference API Roblox

Engine API

Website

Related

Reference API Roblox

SafeAreaCompatibility

Describes how descendants of a ScreenGui adapt to screens with cutouts.

Items 2

HistoryNameValueDescription
549None0

Do not apply compatibility transformations to any descendants of the ScreenGui.

549FullscreenExtension1

If the total area of any descendant GuiObject within the ScreenGui (including any applied border or UIStroke) covers the device's safe area both horizontally and vertically, its background area will be expanded to cover the fullscreen area. This expansion does not affect the size or position of the descendant's content, except in the case of ImageLabel, ImageButton, or VideoFrame where the image/video is considered part of the background and will be expanded to fullscreen.

Note that this option is intended to automatically improve the appearance of UI that was authored for screens without any cutouts. However, it's recommended that you avoid fullscreen extensions for new work; instead, use the ScreenInsets property to specify which insets should be respected for different ScreenGuis.

Description

This enum describes the automatic compatibility transformations that apply to descendant "fullscreen" GuiObjects of a ScreenGui on displays with screen cutouts.

History 3

Settings