Version: 2021.1
LanguageEnglish
  • C#

Screen.orientation

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 ScreenOrientation orientation;

Description

Specifies logical orientation of the screen.

The default value is taken from the Default Orientation property in Player Settings. Currently screen orientation is only relevant on mobile platforms. For example, if a mobile device has a resoltion of 480x320, the horizontal orientation is treated as 480x320 resolution and vertical orientation is 320x480.

Note: The logical orientation affects not only screen orientation, but also touch coordinates. You should expect drastic changes in the touch positions after changing logical orientation, since touch positions are rotated clockwise or counter-clockwise to match screen coordinates.

using UnityEngine;

public class Example : MonoBehaviour { // Start in landscape mode void Start() { Screen.orientation = ScreenOrientation.LandscapeLeft; } }

If the value is set to ScreenOrientation.AutoRotation then the screen selects from any of the options (enabled by autorotateToPortrait, etc) automatically as the device orientation changes.

See Also: ScreenOrientation.