Difference between revisions of "love.window.setFullscreen"
m (→Examples: Fixed setFullscreen arguments.) |
m (Descriptions of return values are no longer ambiguous. I read the source code on bitbucket, this is correct.) |
||
| Line 9: | Line 9: | ||
{{param|boolean|fullscreen|Whether to enter or exit fullscreen mode.}} | {{param|boolean|fullscreen|Whether to enter or exit fullscreen mode.}} | ||
=== Returns === | === Returns === | ||
| − | {{param|boolean|success|True if successful, false otherwise.}} | + | {{param|boolean|success|True if an attempt to enter fullscreen was successful, false otherwise.}} |
== Function == | == Function == | ||
| Line 20: | Line 20: | ||
{{param|FullscreenType|fstype|The type of fullscreen mode to use.}} | {{param|FullscreenType|fstype|The type of fullscreen mode to use.}} | ||
=== Returns === | === Returns === | ||
| − | {{param|boolean|success|True if successful, false otherwise.}} | + | {{param|boolean|success|True if an attempt to enter fullscreen was successful, false otherwise.}} |
== Notes == | == Notes == | ||
Revision as of 16:28, 16 March 2018
| Available since LÖVE 0.9.0 |
| This function is not supported in earlier versions. |
Enters or exits fullscreen. The display to use when entering fullscreen is chosen based on which display the window is currently in, if multiple monitors are connected.
Contents
Function
Synopsis
success = love.window.setFullscreen( fullscreen )
Arguments
boolean fullscreen- Whether to enter or exit fullscreen mode.
Returns
boolean success- True if an attempt to enter fullscreen was successful, false otherwise.
Function
Synopsis
success = love.window.setFullscreen( fullscreen, fstype )
Arguments
boolean fullscreen- Whether to enter or exit fullscreen mode.
FullscreenType fstype- The type of fullscreen mode to use.
Returns
boolean success- True if an attempt to enter fullscreen was successful, false otherwise.
Notes
If fullscreen mode is entered and the window size doesn't match one of the monitor's display modes (in normal fullscreen mode) or the window size doesn't match the desktop size (in 'desktop' fullscreen mode), the window will be resized appropriately. The window will revert back to its original size again when fullscreen mode is exited using this function.
Examples
Make the window fullscreen in desktop mode.
function love.load()
love.window.setFullscreen(true, "desktop")
end
See Also
Other Languages
Dansk –
Deutsch –
English –
Español –
Français –
Indonesia –
Italiano –
Lietuviškai –
Magyar –
Nederlands –
Polski –
Português –
Română –
Slovenský –
Suomi –
Svenska –
Türkçe –
Česky –
Ελληνικά –
Български –
Русский –
Српски –
Українська –
עברית –
ไทย –
日本語 –
正體中文 –
简体中文 –
Tiếng Việt –
한국어
More info
