Switches the screen resolution.
A width
by height
resolution is used.
If no matching resolution is supported, the closest one is used.
If preferredRefreshRate
is 0 (default) Unity switches to the highest refresh rate that the monitor supports.
If preferredRefreshRate
is not 0 Unity uses it if the monitor supports it, otherwise it chooses
the highest supported one. Changing refresh rate is only supported when using exclusive full-screen mode.
On Android fullscreen
controls the SYSTEM_UI_FLAG_LOW_PROFILE
flag to View.setSystemUiVisibility
.
To set a specific full-screen mode on a desktop platform, use the method overload that accepts the FullScreenMode parameter. Exclusive full-screen mode is only supported on Windows standalone player.
If you use multi-display, you can only use Screen.SetResolution
to set the resolution of the primary screen.
A resolution switch does not happen immediately; it happens 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, FullScreenMode.ExclusiveFullScreen, new RefreshRate() { numerator = 60, denominator = 1 }); } }
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:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.