Difference between revisions of "love.graphics.setMode"

m (typo)
m (Moved the warning about deferred window creation to a Notes section)
Line 6: Line 6:
  
 
Changing the display mode may have side effects: for example, [[Canvas]]es will be cleared; make sure to save their contents beforehand.
 
Changing the display mode may have side effects: for example, [[Canvas]]es will be cleared; make sure to save their contents beforehand.
 
'''Note:''' 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 due to OpenGL specifics.
 
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
Line 21: Line 19:
 
=== Returns ===
 
=== Returns ===
 
{{param|boolean|success|True if successful, false otherwise.}}
 
{{param|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 ==
 
== See Also ==

Revision as of 23:39, 22 August 2013

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


Changes the display mode.

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 FSAA-buffers.

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