Difference between revisions of "love.graphics.setMode"

m
Line 5: Line 5:
 
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.
 
== Function ==
 
== Function ==
 +
{{oldin|[[0.9.0]]|090|type=variant}}
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
Line 17: Line 18:
 
=== Returns ===
 
=== Returns ===
 
{{param|boolean|success|True if successful, false otherwise.}}
 
{{param|boolean|success|True if successful, false otherwise.}}
 +
 +
== Function ==
 +
{{newin|[[0.9.0]]|090|type=variant}}
 +
=== Synopsis ===
 +
<source lang="lua">
 +
success = love.graphics.setMode( width, height, flags )
 +
</source>
 +
=== Arguments ===
 +
{{param|number|width|Display width.}}
 +
{{param|number|height|Display height.}}
 +
{{param|table|flags|The flags table with the options:}}
 +
{{subparam|boolean|fullscreen|Fullscreen (true), or windowed (false).}}
 +
{{subparam|boolean|vsync (true)|True if LÖVE should wait for vsync, false otherwise.}}
 +
{{subparam|number|fsaa (0)|The number of FSAA-buffers.}}
 +
{{subparam|boolean|resizable (false)|Resizable (true), or not (false) window mode.}}
 +
{{subparam|boolean|borderless (false)|Borderless (true), or not (false) window mode.}}
 +
{{subparam|boolean|centered (true)|Center the window (true), or not (false).}}
 +
=== Returns ===
 +
{{param|boolean|success|True if successful, false otherwise.}}
 +
 
== See Also ==
 
== See Also ==
 
* [[parent::love.graphics]]
 
* [[parent::love.graphics]]

Revision as of 08:49, 31 March 2013

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

Removed in LÖVE 0.9.0
This variant is not supported in that and later versions.

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.

Function

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

Synopsis

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

Arguments

number width
Display width.
number height
Display height.
table flags
The flags table with the options:
boolean fullscreen
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.
boolean resizable (false)
Resizable (true), or not (false) window mode.
boolean borderless (false)
Borderless (true), or not (false) window mode.
boolean centered (true)
Center the window (true), or not (false).

Returns

boolean success
True if successful, false otherwise.

See Also


Other Languages