display.safeScreenOriginY

Type Number
Library display.*
Revision Current Public Release (2017.3135)
Keywords screen, origin, safe area
See also display.safeScreenOriginX
display.safeActualContentHeight
display.getSafeAreaInsets()

The current public release is 2017.3135. This property is only available in daily build 2017.3141 or later.

Overview

Returns the y distance from the top side of the "safe area" boundary to the top side of the content area, in Corona content units. The "safe area" is the rectangular region where it's safe to place important UI elements, ensuring that they are not obscured by status bars, device aspects like a sensor bar or rounded corners, software buttons, TV overscan areas, etc.

For devices which do not feature the concept of a safe area, this value is the same as display.screenOriginY.

Example

-- Create a vector rectangle sized exactly to the "safe area"
local safeArea = display.newRect(
    display.safeScreenOriginX,
    display.safeScreenOriginY,
    display.safeActualContentWidth,
    display.safeActualContentHeight
)
safeArea:translate( safeArea.width*0.5, safeArea.height*0.5 )