Difference between revisions of "love.window.setMode"

m
(OpenGL note)
Line 7: Line 7:
 
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 functon 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 ===

Revision as of 18:42, 23 June 2013

Available since LÖVE 0.9.0
Moved from love.graphics.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.

Note: if you have disabled the screen in conf.lua and use this functon 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

Synopsis

success = love.window.setMode( width, height, flags )

Arguments

number width
Display width.
number height
Display height.
table flags
The flags table with the options:
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 antialiasing samples.
boolean resizable (false)
True if the window should be resizable in windowed mode, false otherwise.
boolean borderless (false)
True if the window should be borderless in windowed mode, false otherwise.
boolean centered (true)
True if the window should be centered in windowed mode, false otherwise.

Returns

boolean success
True if successful, false otherwise.

See Also


Other Languages