Version: 2019.4
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 this option is assigned to the Screen.orientation property, the screen will auto-rotate so that the bottom of the screen image points downwards. The orientations that can be used are set by the Screen.autorotateToLandscapeLeft, Screen.autorotateToLandscapeRight, Screen.autorotateToPortrait and Screen::autorotateToPortraitUpsideDown properties. For example, if Screen.autorotateToPortrait and Screen::autorotateToPortraitUpsideDown are both true but the others are false then the auto-rotation will never choose either of the landscape options even when the device is held with the long side of the screen pointing downwards.

using UnityEngine;

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

Screen.autorotateToPortraitUpsideDown = true;

Screen.orientation = ScreenOrientation.AutoRotation; } }