Version: 2022.2
LanguageEnglish
  • C#

Screen

class in UnityEngine

/

Implemented in:UnityEngine.CoreModule

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

Provides access to display information.

Use the Screen class to get a list of supported screen resolutions, switch the current resolution, or hide or show the system mouse pointer.

Static Properties

autorotateToLandscapeLeftEnables auto-rotation to landscape left
autorotateToLandscapeRightEnables auto-rotation to landscape right.
autorotateToPortraitEnables auto-rotation to portrait.
autorotateToPortraitUpsideDownEnables auto-rotation to portrait, upside down.
brightnessThe current brightness of the screen.
currentResolutionThe current screen resolution (Read Only).
cutoutsReturns a list of screen areas that are not functional for displaying content (Read Only).
dpiThe current DPI of the screen / device (Read Only).
fullScreenEnables full-screen mode for the application.
fullScreenModeSet this property to one of the values in FullScreenMode to change the display mode of your application.
heightThe current height of the screen window in pixels (Read Only).
mainWindowDisplayInfoThe display information associated with the display that the main application window is on.
mainWindowPositionThe position of the top left corner of the main window relative to the top left corner of the display.
orientationSpecifies logical orientation of the screen.
resolutionsReturns all full-screen resolutions that the monitor supports (Read Only).
safeAreaReturns the safe area of the screen in pixels (Read Only).
sleepTimeoutA power saving setting, allowing the screen to dim some time after the last active user interaction.
widthThe current width of the screen window in pixels (Read Only).

Static Methods

GetDisplayLayoutRetrieves layout information about connected displays such as names, resolutions and refresh rates.
MoveMainWindowToMoves the main window to the specified position relative to the top left corner of the specified display. Position value is represented in pixels. Moving the window is an asynchronous operation, which can take multiple frames.
SetResolutionSwitches the screen resolution.