class in UnityEngine
/
Implemented in:UnityEngine.CoreModule
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.
CloseFor 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.
CloseProvides access to display information.
Use this class to get a list of supported screen resolutions, change the current resolution, or hide/show the system mouse pointer.
When you launch your application, Unity immediately needs to use settings like the screen's resolution and full-screen mode to render the first frame before any custom code starts to run. This means Unity doesn't initially use your code to configure these settings. Instead, Unity gets the values of these settings from command line arguments, Player settings, or from PlayerPrefs.
Priority of initial startup settings
Unity determines the initial startup settings based on the following order of priority (highest to lowest):
You can also implement your own logic, but Unity will only apply your logic after it starts to execute code.
Persistence of Screen settings
During gameplay, if the user changes the Screen settings, the settings will persist between launches. Unity writes these settings to PlayerPrefs, which saves these settings and stores them differently depending on the platform. Unity saves the following settings to PlayerPrefs:
Unity saves the settings to PlayerPrefs when any of the following situations occur:
| Property | Description |
|---|---|
| autorotateToLandscapeLeft | Enables auto-rotation to landscape left. |
| autorotateToLandscapeRight | Enables auto-rotation to landscape right. |
| autorotateToPortrait | Enables auto-rotation to portrait. |
| autorotateToPortraitUpsideDown | Enables auto-rotation to portrait, upside down. |
| brightness | Indicates the current brightness of the screen. |
| currentResolution | The current screen resolution (Read Only). |
| cutouts | Returns a list of screen areas that are not functional for displaying content (Read Only). |
| dpi | The current pixel density of the screen measured in dots-per-inch (DPI) (Read Only). |
| fullScreen | Enables full-screen mode for the application. |
| fullScreenMode | Set this property to one of the values in FullScreenMode to change the display mode of your application. |
| height | The current height of the screen window in pixels (Read Only). |
| mainWindowDisplayInfo | The display information associated with the display that the main application window is on. |
| mainWindowPosition | The position of the top left corner of the main window relative to the top left corner of the display. |
| msaaSamples | Get the requested MSAA sample count of the screen buffer. |
| orientation | Specifies logical orientation of the screen. |
| resolutions | Returns all full-screen resolutions that the monitor supports (Read Only). |
| safeArea | Returns the safe area of the screen in pixels (Read Only). |
| sleepTimeout | A power saving setting, allowing the screen to dim some time after the last active user interaction. |
| width | The current width of the screen window in pixels (Read Only). |
| Method | Description |
|---|---|
| GetDisplayLayout | Retrieves layout information about connected displays such as names, resolutions, and refresh rates. |
| MoveMainWindowTo | Moves 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. |
| SetMSAASamples | Sets the given number of MSAA samples for the screen buffer. |
| SetResolution | Switches the screen resolution. |