mirror of
https://github.com/rojo-rbx/rojo.git
synced 2026-10-23 22:11:38 +00:00
62 lines
2.7 KiB
YAML
62 lines
2.7 KiB
YAML
# 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: ScreenInsets
|
||
type: enum
|
||
summary: |
|
||
Insets associated with various screen safe areas.
|
||
description: |
|
||
This enum specifies screen edge insets that are associated with a particular
|
||
screen safe area. The insets are relative to the **fullscreen area**, meaning
|
||
the rectangular region that encompasses all visible pixels on the screen.
|
||
|
||
<img src="../../../assets/engine-api/enums/ScreenInsets/Inset-Regions-All.png" width="840"
|
||
alt="Mobile device screen showing inset regions." />
|
||
code_samples: []
|
||
tags: []
|
||
deprecation_message: ''
|
||
items:
|
||
- name: None
|
||
summary: |
|
||
No insets are added to the fullscreen area. This mode may result in UI
|
||
that is obscured or completely hidden by device notches and cutouts, so
|
||
you should only use it for a `Class.ScreenGui` that contains
|
||
non‑interactive content like background images.
|
||
value: 0
|
||
tags: []
|
||
deprecation_message: ''
|
||
- name: DeviceSafeInsets
|
||
summary: |
|
||
Device safe area insets are added to the fullscreen area. The resulting
|
||
area is guaranteed to not be occluded by any **device** screen cutouts
|
||
such as the camera notch, although no inset is added for Roblox core UI
|
||
elements like the top bar buttons. As a result, it's recommended that you
|
||
use `CoreUISafeInsets` for a `Class.ScreenGui` whose contents should
|
||
remain unobscured by both device cutouts **and** core screen elements.
|
||
value: 1
|
||
tags: []
|
||
deprecation_message: ''
|
||
- name: CoreUISafeInsets
|
||
summary: |
|
||
Core UI insets are added to the `DeviceSafeInsets` area, resulting in an
|
||
area guaranteed to be unobscured by both device screen cutouts and Roblox
|
||
core UI elements like the top bar buttons. This mode is recommended for
|
||
any `Class.ScreenGui` that contains interactive and/or important UI
|
||
elements such as buttons and status messages.
|
||
value: 2
|
||
tags: []
|
||
deprecation_message: ''
|
||
- name: TopbarSafeInsets
|
||
summary: |
|
||
Top bar safe area insets are added to the `DeviceSafeInsets` area,
|
||
resulting in an area guaranteed to be unobscured by both device screen
|
||
cutouts and Roblox core UI elements like the experience controls. Unlike
|
||
`CoreUISafeInsets`, this area's position and size is dynamic and is
|
||
limited to the space available within the top bar area itself, outside of
|
||
`CoreUISafeInsets`. See the `Class.GuiService.TopbarInset` property which
|
||
represents the absolute size and position of the unobstructed area within
|
||
the top bar space.
|
||
value: 3
|
||
tags: []
|
||
deprecation_message: ''
|