Screen:getState: Difference between revisions

From GiderosMobile
No edit summary
m Text replacement - "</source>" to "</syntaxhighlight>"
 
(2 intermediate revisions by 2 users not shown)
Line 5: Line 5:
=== Description ===
=== Description ===
Returns the state of the screen.
Returns the state of the screen.
<source lang="lua">
<syntaxhighlight lang="lua">
(number) = Screen:getState()
(number) = Screen:getState()
</source>
</syntaxhighlight>


The returned number is the sum of the following possible values:
The returned number is the sum of the following possible values:
* Screen.STATE_MINIMIZED: Screen/Window is minimized
* Screen.STATE_NORMAL '''0''': Screen/Window is normal
* Screen.STATE_MAXIMIZED: Screen/Window is maximized
* Screen.STATE_MINIMIZED '''1''': Screen/Window is minimized
* Screen.STATE_FULLSCREEN: Screen/Window is fullscreen
* Screen.STATE_MAXIMIZED '''2''': Screen/Window is maximized
* Screen.STATE_ACTIVE: Screen/Window is active/focused
* Screen.STATE_FULLSCREEN '''4''': Screen/Window is fullscreen
* Screen.STATE_HIDDEN: Screen/Window is not displayed
* Screen.STATE_ACTIVE '''8''': Screen/Window is active/focused
* Screen.STATE_CLOSED: Screen/Window is closed
* Screen.STATE_HIDDEN '''16''': Screen/Window is not displayed
* Screen.STATE_CLOSED '''32''': Screen/Window is closed


=== Return values ===
=== Return values ===
'''Returns''' (number) the screen state<br/>
'''Returns''' (number) the sum of the screen states<br/>


{{Screen}}
{{Screen}}

Latest revision as of 13:32, 13 July 2023

Available since: Gideros 2017.8
Class: Screen

Description

Returns the state of the screen.

(number) = Screen:getState()

The returned number is the sum of the following possible values:

  • Screen.STATE_NORMAL 0: Screen/Window is normal
  • Screen.STATE_MINIMIZED 1: Screen/Window is minimized
  • Screen.STATE_MAXIMIZED 2: Screen/Window is maximized
  • Screen.STATE_FULLSCREEN 4: Screen/Window is fullscreen
  • Screen.STATE_ACTIVE 8: Screen/Window is active/focused
  • Screen.STATE_HIDDEN 16: Screen/Window is not displayed
  • Screen.STATE_CLOSED 32: Screen/Window is closed

Return values

Returns (number) the sum of the screen states