Difference between revisions of "love.graphics.setMode"

m (Fixed Removed, and conf.lua link.)
 
(28 intermediate revisions by 11 users not shown)
Line 1: Line 1:
 +
{{oldin|[[0.9.0]]|090|type=function|text=Moved to the [[love.window]] module as [[love.window.setMode]]}}
  
Changes the display mode.
+
Changes the window size, or the display mode if fullscreen.
 +
 
 +
If width or height is 0, setMode will use the width or height of the desktop.
 +
 
 +
Changing the display mode may have side effects: for example, [[Canvas]]es will be cleared; make sure to save their contents beforehand.
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
True = love.graphics.setMode( width, height, fullscreen, vsync, fsaa )
+
success = love.graphics.setMode( width, height, fullscreen, vsync, fsaa )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
 
{{param|number|width|Display width.}}
 
{{param|number|width|Display width.}}
 
{{param|number|height|Display height.}}
 
{{param|number|height|Display height.}}
{{param|number|fullscreen (false)|Fullscreen (true), or windowed (false).}}
+
{{param|boolean|fullscreen (false)|Fullscreen (true), or windowed (false).}}
{{param|number|vsync (true)|True if LOVE should wait for vsync, false otherwise.}}
+
{{param|boolean|vsync (true)|True if LÖVE should wait for vsync, false otherwise.}}
{{param|number|fsaa (0)|The number of FSAA-buffers.}}
+
{{param|number|fsaa (0)|The number of MSAA samples.}}
 
=== Returns ===
 
=== Returns ===
{{param|boolean|True|if successful, false otherwise.}}
+
{{param|boolean|success|True if successful, false otherwise.}}
 +
 
 +
== Notes ==
 +
If you have disabled the screen in [[Config_Files|conf.lua]] and use this function to manually create the window, then you must not call any other [[love.graphics]].* function before this one. Doing so will result in undefined behavior and/or crashes.
 +
 
 
== See Also ==
 
== See Also ==
 
* [[parent::love.graphics]]
 
* [[parent::love.graphics]]
 
[[Category:Functions]]
 
[[Category:Functions]]
 
{{#set:Description=Changes the display mode.}}
 
{{#set:Description=Changes the display mode.}}
 +
{{#set:Since=000}}
 +
{{#set:Removed=090}}
 +
{{#set:Sub-Category=Window}}
 +
== Other Languages ==
 +
{{i18n|love.graphics.setMode}}

Latest revision as of 04:06, 10 September 2016

Removed in LÖVE 0.9.0
Moved to the love.window module as love.window.setMode.


Changes the window size, or the display mode if fullscreen.

If width or height is 0, setMode will use the width or height of the desktop.

Changing the display mode may have side effects: for example, Canvases will be cleared; make sure to save their contents beforehand.

Function

Synopsis

success = love.graphics.setMode( width, height, fullscreen, vsync, fsaa )

Arguments

number width
Display width.
number height
Display height.
boolean fullscreen (false)
Fullscreen (true), or windowed (false).
boolean vsync (true)
True if LÖVE should wait for vsync, false otherwise.
number fsaa (0)
The number of MSAA samples.

Returns

boolean success
True if successful, false otherwise.

Notes

If you have disabled the screen in conf.lua and use this function to manually create the window, then you must not call any other love.graphics.* function before this one. Doing so will result in undefined behavior and/or crashes.

See Also



Other Languages