Version: 2023.2
LanguageEnglish
  • C#

PlayerSettings.Android.maxAspectRatio

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

Switch to Manual
public static float maxAspectRatio;

Description

Maximum aspect ratio which is supported by the application.

This value is expressed as (longer dimension / shorter dimension) in decimal form. It can not be set to a value lower than 1.86 which matches the aspect ratio of 16:9. By default it is set to 2.1 which means the application supports all devices with aspect ratio up to 18.5:9. For more information, see Declare a maximum aspect ratio.

using UnityEditor;
using UnityEditor.Build;
using UnityEngine;
public class MaxAspectRatio : MonoBehaviour
{
    [MenuItem("Build/Android Max Aspect Ratio Example")]
    public static void AndroidArchitectures()
    {
        PlayerSettings.SetScriptingBackend(NamedBuildTarget.Android, ScriptingImplementation.IL2CPP);
        PlayerSettings.Android.targetArchitectures = AndroidArchitecture.ARM64;
        //Set the maxAspectRatio to the default value
        PlayerSettings.Android.maxAspectRatio = 2.1f;
        BuildPlayerOptions options = new BuildPlayerOptions();
        options.scenes = new[] { "Assets/Scenes/SampleScene.unity" };
        options.locationPathName = "Builds/AndroidBuild.apk";
        options.target = BuildTarget.Android;
        options.targetGroup = BuildTargetGroup.Android;
        BuildPipeline.BuildPlayer(options);
    }
}