Difference between revisions of "Application:getDeviceSafeArea"
From GiderosMobile
(prefixindex) |
|||
| Line 1: | Line 1: | ||
| − | + | '''Available since:''' Gideros 2017.11.3<br/> | |
| − | + | '''Class:''' [[Application|Application]]<br/> | |
| − | ''' | + | |
| − | ''' | + | === Description === |
| − | === | + | Some screens have non rectangular shapes, in which case it is useful to know the bounds of the safe area, that is area that is guaranteed to be visible and user accessible. This functions returns the minimum and maximum coordinates to use, either in physical coordinates or in logical coordinates. |
| − | + | <br /> | |
| − | Some screens have non rectangular shapes, in which case it is useful to know the bounds of the safe area, that is area that is guaranteed to be visible and user accessible. This functions returns the minimum and maximum coordinates to use, | + | |
| − | either in physical coordinates or in logical coordinates.<br /> | ||
| − | |||
<source lang="lua"> | <source lang="lua"> | ||
(number), (number), (number), (number) = application:getDeviceSafeArea(logical) | (number), (number), (number), (number) = application:getDeviceSafeArea(logical) | ||
</source> | </source> | ||
| − | === | + | |
| − | '''logical''': (boolean) | + | === Parameters === |
| − | === | + | '''logical''': (boolean) Returns the margin in logical scale if set to true. '''optional''' |
| − | ''' | + | <br/> |
| − | ''' | + | |
| − | ''' | + | === Return values === |
| − | ''' | + | '''Returns''' (number) Minimum x<br/> |
| + | '''Returns''' (number) Minimum y<br/> | ||
| + | '''Returns''' (number) Maximum x<br/> | ||
| + | '''Returns''' (number) Maximum y<br/> | ||
| + | |||
| + | ---- | ||
| + | {{Special:PrefixIndex/Application}} | ||
| + | <br/> | ||
| + | |||
| + | {{Special:PrefixIndex/Event.APPLICATION}} | ||
Revision as of 12:57, 2 December 2019
Available since: Gideros 2017.11.3
Class: Application
Description
Some screens have non rectangular shapes, in which case it is useful to know the bounds of the safe area, that is area that is guaranteed to be visible and user accessible. This functions returns the minimum and maximum coordinates to use, either in physical coordinates or in logical coordinates.
(number), (number), (number), (number) = application:getDeviceSafeArea(logical)
Parameters
logical: (boolean) Returns the margin in logical scale if set to true. optional
Return values
Returns (number) Minimum x
Returns (number) Minimum y
Returns (number) Maximum x
Returns (number) Maximum y
- Application
- Application.CONSTANTS
- Application.LANDSCAPE LEFT
- Application.LANDSCAPE RIGHT
- Application.PORTRAIT
- Application.PORTRAIT UPSIDE DOWN
- Application:applyStyles
- Application:canOpenUrl
- Application:checkPermission
- Application:configureFrustum
- Application:enableDrawInfo
- Application:enableOnDemandDraw
- Application:exit
- Application:get
- Application:getApiVersion
- Application:getAppId
- Application:getBackgroundColor
- Application:getClipboard
- Application:getContentHeight
- Application:getContentWidth
- Application:getDeviceHeight
- Application:getDeviceInfo
- Application:getDeviceName
- Application:getDeviceOrientation
- Application:getDeviceSafeArea
- Application:getDeviceWidth
- Application:getFps
- Application:getKeyboardModifiers
- Application:getLanguage
- Application:getLocale
- Application:getLogicalBounds
- Application:getLogicalHeight
- Application:getLogicalScaleX
- Application:getLogicalScaleY
- Application:getLogicalTranslateX
- Application:getLogicalTranslateY
- Application:getLogicalWidth
- Application:getNativePath
- Application:getOrientation
- Application:getProjectProperties
- Application:getScaleMode
- Application:getScreenDensity
- Application:getTextureMemoryUsage
- Application:isPlayerMode
- Application:openUrl
- Application:requestPermissions
- Application:set
- Application:setBackgroundColor
- Application:setClipboard
- Application:setEventMerging
- Application:setFps
- Application:setFullScreen
- Application:setKeepAwake
- Application:setKeyboardVisibility
- Application:setLogicalDimensions
- Application:setOrientation
- Application:setScaleMode
- Application:setTextInput
- Application:setWindowSize
- Application:vibrate
