# This file is automatically generated. Please don't edit it manually.
# To submit a bug report on the content, see
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72

name: SafeAreaCompatibility
type: enum
summary: |
  Describes how descendants of a `Class.ScreenGui` adapt to screens with
  cutouts.
description: |
  This enum describes the automatic compatibility transformations that apply to
  descendant "fullscreen" `Class.GuiObject|GuiObjects` of a `Class.ScreenGui` on
  displays with screen cutouts.
code_samples: []
tags: []
deprecation_message: ''
items:
  - name: None
    summary: |
      Do not apply compatibility transformations to any descendants of the
      `Class.ScreenGui`.
    value: 0
    tags: []
    deprecation_message: ''
  - name: FullscreenExtension
    summary: |
      If the total area of any descendant `Class.GuiObject` within the
      `Class.ScreenGui` (including any applied border or `Class.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 `Class.ImageLabel`,
      `Class.ImageButton`, or `Class.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 `Class.ScreenGui.ScreenInsets|ScreenInsets` property to specify
      which insets should be respected for different
      `Class.ScreenGui|ScreenGuis`.
    value: 1
    tags: []
    deprecation_message: ''