Version: 5.6 (switch to 2017.1b)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

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 var orientation: ScreenOrientation;
public static ScreenOrientation orientation;

Description

Specifies logical orientation of the screen.

Default value is taken from the 'Default Orientation' in Player Settings. As an example, if we take 480x320 resolution on iPhone, horizontal orientation is treated as 480x320 resolution and vertical orientation as 320x480.

Note: 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 will be rotated clockwise or counter-clockwise to match screen coordinates.

Currently screen orientation is only relevant on mobile platforms.

// Start in landscape mode
function Start () {
    Screen.orientation = ScreenOrientation.LandscapeLeft;
}
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour { void Start() { Screen.orientation = ScreenOrientation.LandscapeLeft; } }

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

See Also: ScreenOrientation.