Skip to main content

Display Metrics

This allows you to get information about the display on the current device.

The densityDpi value is the 'bucket' DPI which is useful for scaling your UI.

The more accurate values are the xdpi and ydpi which provide the actual x and y dpi for the device.

The screenHeight and screenWidth represent the fullscreen pixel height and width of the device.

trace( "DISPLAY METRICS ========================" );
trace( "densityDpi:   " + Application.service.display.displayMetrics.densityDpi );
trace( "screenHeight: " + Application.service.display.displayMetrics.screenHeight );
trace( "screenWidth:  " + Application.service.display.displayMetrics.screenWidth );
trace( "xdpi:         " + Application.service.display.displayMetrics.xdpi );
trace( "ydpi:         " + Application.service.display.displayMetrics.ydpi );
trace( "scale:        " + Application.service.display.displayMetrics.scale );
trace( "nativeScale:  " + Application.service.display.displayMetrics.nativeScale );

These values are taken from the underlying APIs, in particular:

The iOS screen density is determined from a lookup and is not provided by the API.

Native Scale​

The scale & nativeScale property are only valid on iOS.

These value reflects the scale factor needed to convert from the default logical coordinate space into the device coordinate space of this screen. The default logical coordinate space is measured using points. For Retina displays, the scale factor may be 3.0 or 2.0 and one point can represented by nine or four pixels, respectively. For standard-resolution displays, the scale factor is 1.0 and one point equals one pixel.

This native scale property will change on an iOS device if the screen is put into it's "zoomed" display state and knowing this value can allow you to react accordingly.

The following logic is useful when checking for the zoomed state of a device:

function isZoomed( displayMetrics:DisplayMetrics ):Boolean
{
    return displayMetrics.scale < displayMetrics.nativeScale;
}

if (isZoomed( Application.service.device.displayMetrics ))
{
    // zoomed state
}