Version: 2021.3
LanguageEnglish
  • C#

FullScreenMode

enumeration

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

Platform agnostic full-screen mode. Not all platforms support all modes.

This defines how full-screen modes are handled on all platforms.

Properties

ExclusiveFullScreenSet your app to maintain sole full-screen use of a display. Unlike Fullscreen Window, this mode changes the OS resolution of the display to match the app's chosen resolution. This option is only supported on Windows; on other platforms the setting falls back to FullScreenMode.FullScreenWindow.
FullScreenWindowSet your app window to the full-screen native display resolution, covering the whole screen. This full-screen mode is also known as "borderless full-screen." Unity renders app content at the resolution set by a script (or the native display resolution if none is set) and scales it to fill the window. When scaling, Unity adds black bars to the rendered output to match the display aspect ratio to prevent content stretching. This process is called letterboxing. The OS overlay UI will display on top of the full-screen window (such as IME input windows). All platforms support this mode.
MaximizedWindowSet the app window to the operating system’s definition of “maximized”. This means a full-screen window with a hidden menu bar and dock on macOS. This option is only supported on macOS; on other platforms, the setting falls back to FullScreenMode.FullScreenWindow.
WindowedSet your app to a standard, non-full-screen movable window, the size of which is dependent on the app resolution. All desktop platforms support this full-screen mode.