Difference between revisions of "love.window.setFullscreen"

m (moved love.window.toggleFullscreen to love.window.setFullscreen: Function has been renamed/reworked)
(Changed from love.window.toggleFullscreen to love.window.setFullscreen)
Line 1: Line 1:
 
{{newin|[[0.9.0]]|090|type=function}}
 
{{newin|[[0.9.0]]|090|type=function}}
Toggles fullscreen.
+
Enters or exits fullscreen.
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
success = love.window.toggleFullscreen( )
+
success = love.window.setFullscreen( fullscreen )
 
</source>
 
</source>
 +
=== Arguments ===
 +
{{param|boolean|fullscreen|Whether to enter or exit fullscreen mode.}}
 +
=== Returns ===
 +
{{param|boolean|success|True if successful, false otherwise.}}
  
 +
== Function ==
 +
=== Synopsis ===
 +
<source lang="lua">
 +
success = love.window.setFullscreen( fullscreen, fstype )
 +
</source>
 
=== Arguments ===
 
=== Arguments ===
None.
+
{{param|boolean|fullscreen|Whether to enter or exit fullscreen mode.}}
 +
{{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 successful, false otherwise.}}
Line 16: Line 26:
 
* [[love.window.setMode]]
 
* [[love.window.setMode]]
 
[[Category:Functions]]
 
[[Category:Functions]]
{{#set:Description=Toggles fullscreen.}}
+
{{#set:Description=Enters or exits fullscreen.}}
 
== Other Languages ==
 
== Other Languages ==
{{i18n|love.window.toggleFullscreen}}
+
{{i18n|love.window.setFullscreen}}

Revision as of 21:44, 25 August 2013

Available since LÖVE 0.9.0
This function is not supported in earlier versions.

Enters or exits fullscreen.

Function

Synopsis

success = love.window.setFullscreen( fullscreen )

Arguments

boolean fullscreen
Whether to enter or exit fullscreen mode.

Returns

boolean success
True if 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 successful, false otherwise.

See Also

Other Languages