Util screen
Screen functions.
Functions
| init (w, h, flags) | INTERNAL - Initializes screen parameters. |
| setDefaultRenderDimensions (w, h) | Set the default render dimensions of your game. |
| setScaleType (stype) | Set the scaling type. |
| updateDisplays () | INTERNAL - Update display information. |
| set (w, h, flags) | Set screen mode. |
| preDraw () | INTERNAL - Is called before everything draws. |
| postDraw () | INTERNAL - Is called after everything draws. |
| getRenderWidth () | Get screen render width. |
| getRenderHeight () | Get screen render height. |
| getAspectRatio () | Get screen aspect ratio. |
| getMousePosition () | Get the mouse position. |
| resize (w, h) | INTERNAL - Called when the screen size changes. |
Functions
- init (w, h, flags)
-
INTERNAL - Initializes screen parameters.
Is called when the framework loads.
Parameters:
- w
- h
- flags
- setDefaultRenderDimensions (w, h)
-
Set the default render dimensions of your game.
Independent of window size.
Parameters:
- w number render width
- h number render height
- setScaleType (stype)
-
Set the scaling type. See SCREEN_SCALE constants.
Parameters:
- stype SCREEN_SCALE scaling type
Usage:
screen.setScaleType( SCREEN_SCALE.FIT_LETTERBOX )
- updateDisplays ()
- INTERNAL - Update display information. Stores display count and width, height and available fullscreen modes per display.
- set (w, h, flags)
-
Set screen mode.
Replaces love.window.setMode. Same parameters.
Parameters:
- w number screen width
- h number screen height
- flags table screen settings
- preDraw ()
- INTERNAL - Is called before everything draws.
- postDraw ()
- INTERNAL - Is called after everything draws.
- getRenderWidth ()
-
Get screen render width.
Returns:
-
number
render width
- getRenderHeight ()
-
Get screen render height.
Returns:
-
number
render width
- getAspectRatio ()
-
Get screen aspect ratio.
Returns:
-
number
aspect ratio ( width / height )
- getMousePosition ()
-
Get the mouse position.
Replaces love.mouse.getPosition.
Returns:
- number x
- number y
- resize (w, h)
-
INTERNAL - Called when the screen size changes.
Parameters:
- w number new width
- h number new height