Version: 2021.3
LanguageEnglish
  • C#

ScreenOrientation.AutoRotation

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

Auto-rotates the screen as necessary toward any of the enabled orientations.

When you assign ScreenOrientation.AutoRotation to the Screen.orientation property, the screen auto-rotates so that the bottom of the image points downwards. To set permitted the orientations, use the following properties

You can set a combination of orientations. For example, you can set Screen.autorotateToPortrait and Screen.autorotateToPortraitUpsideDown to true but leave the others as false. In this case, the auto-rotation never chooses either of the landscape options.

WebGL builds only support auto-rotation on the mobile Chrome browser, and will only allow orienting to a subset of combinations, these are:

  • Individual orientations
  • Opposite pairs of orientations
  • All four of the above orientations.

If another combination is set, auto-rotation defaults to all four orientations.
Note: Auto-rotation on WebGL only works in full-screen mode.

using UnityEngine;

public class Example : MonoBehaviour { void Start() { Screen.autorotateToPortrait = true;

Screen.autorotateToPortraitUpsideDown = true;

Screen.orientation = ScreenOrientation.AutoRotation; } }

See Also: Screen.orientation.