Difference between revisions of "love.window.setMode"
m (Added new flags from the SDL2 merge) |
m (Added note about auto-resizing when the size isn't supported in fullscreen) |
||
| Line 3: | Line 3: | ||
Changes the display mode. | Changes the display mode. | ||
| − | If width or height is 0, setMode will use the width | + | If width or height is 0, setMode will use the width and 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 if you need to. | Changing the display mode may have side effects: for example, [[canvas]]es will be cleared; make sure to save their contents beforehand if you need to. | ||
| Line 29: | Line 29: | ||
== Notes == | == Notes == | ||
| − | + | If fullscreen is enabled and the width or height is not supported (see [[love.window.checkMode]]), the window may be resized to the closest available resolution and a [[love.resize|resize]] event will be triggered. If the fullscreen type is "desktop", then the window will be automatically resized to the desktop resolution. | |
| + | |||
| + | If you have disabled the window 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 and/or crashes because OpenGL cannot function properly without a window. | ||
== See Also == | == See Also == | ||
Revision as of 07:01, 26 August 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 and 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 if you need to.
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).
FullscreenType fullscreentype ("normal")- The type of fullscreen to use.
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.
number display (1)- The index of the display to show the window in, if multiple monitors are available.
number minwidth (100)- The minimum width of the window, if it's resizable.
number minheight (100)- The minimum height of the window, if it's resizable.
Returns
boolean success- True if successful, false otherwise.
Notes
If fullscreen is enabled and the width or height is not supported (see love.window.checkMode), the window may be resized to the closest available resolution and a resize event will be triggered. If the fullscreen type is "desktop", then the window will be automatically resized to the desktop resolution.
If you have disabled the window 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 and/or crashes because OpenGL cannot function properly without a window.
See Also
Other Languages
Dansk –
Deutsch –
English –
Español –
Français –
Indonesia –
Italiano –
Lietuviškai –
Magyar –
Nederlands –
Polski –
Português –
Română –
Slovenský –
Suomi –
Svenska –
Türkçe –
Česky –
Ελληνικά –
Български –
Русский –
Српски –
Українська –
עברית –
ไทย –
日本語 –
正體中文 –
简体中文 –
Tiếng Việt –
한국어
More info
