Legacy Documentation: Version 2018.2 (Go to current version)
LanguageEnglish
  • C#

Screen.SetResolution

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

public static void SetResolution(int width, int height, bool fullscreen);
public static void SetResolution(int width, int height, bool fullscreen, int preferredRefreshRate = 0);
public static void SetResolution(int width, int height, FullScreenMode fullscreenMode, int preferredRefreshRate = 0);

Description

Switches the screen resolution.

A width by height resolution will be used. If no matching resolution is supported, the closest one will be used.

If preferredRefreshRate is 0 (default) Unity will switch to the highest refresh rate supported by the monitor.
If preferredRefreshRate is not 0 Unity will use it if the monitor supports it, otherwise will choose the highest supported one.

On Android fullscreen controls the SYSTEM_UI_FLAG_LOW_PROFILE flag to View.setSystemUiVisibility(), on devices running Honeycomb (OS 3.0 / API 11) or later.

On Windows Store Apps, switching to non-native resolution is only supported starting from Windows 8.1 and newer.

To set a specific full-screen mode on a desktop platform, use the method overload tht accepts the FullScreenMode parameter.

A resolution switch does not happen immediately; it will actually happen when the current frame is finished.

using UnityEngine;

public class ExampleScript : MonoBehaviour { void Start() { // Switch to 640 x 480 full-screen Screen.SetResolution(640, 480, true); } }

Another example:

using UnityEngine;

public class ExampleScript : MonoBehaviour { void Start() { // Switch to 640 x 480 full-screen at 60 hz Screen.SetResolution(640, 480, true, 60); } }

Another example:

using UnityEngine;

public class ExampleScript : MonoBehaviour { void Start() { // Switch to 800 x 600 windowed Screen.SetResolution(800, 600, false); } }

See Also: resolutions property.

Did you find this page useful? Please give it a rating: