Difference between revisions of "love.window.setMode"
m (Added some functions to the 'see also' list) |
m (Added new flags from the SDL2 merge) |
||
| Line 5: | Line 5: | ||
If width or height is 0, setMode will use the width or height of the desktop. | 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. | + | 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. |
== Function == | == Function == | ||
=== Synopsis === | === Synopsis === | ||
| Line 16: | Line 16: | ||
{{param|table|flags|The flags table with the options:}} | {{param|table|flags|The flags table with the options:}} | ||
{{subparam|boolean|fullscreen (false)|Fullscreen (true), or windowed (false).}} | {{subparam|boolean|fullscreen (false)|Fullscreen (true), or windowed (false).}} | ||
| + | {{subparam|FullscreenType|fullscreentype ("normal")|The type of fullscreen to use.}} | ||
{{subparam|boolean|vsync (true)|True if LÖVE should wait for vsync, false otherwise.}} | {{subparam|boolean|vsync (true)|True if LÖVE should wait for vsync, false otherwise.}} | ||
{{subparam|number|fsaa (0)|The number of antialiasing samples.}} | {{subparam|number|fsaa (0)|The number of antialiasing samples.}} | ||
| Line 21: | Line 22: | ||
{{subparam|boolean|borderless (false)|True if the window should be borderless in windowed mode, false otherwise.}} | {{subparam|boolean|borderless (false)|True if the window should be borderless in windowed mode, false otherwise.}} | ||
{{subparam|boolean|centered (true)|True if the window should be centered in windowed mode, false otherwise.}} | {{subparam|boolean|centered (true)|True if the window should be centered in windowed mode, false otherwise.}} | ||
| + | {{subparam|number|display (1)|The index of the display to show the window in, if multiple monitors are available.}} | ||
| + | {{subparam|number|minwidth (100)|The minimum width of the window, if it's resizable.}} | ||
| + | {{subparam|number|minheight (100)|The minimum height of the window, if it's resizable.}} | ||
=== Returns === | === Returns === | ||
{{param|boolean|success|True if successful, false otherwise.}} | {{param|boolean|success|True if successful, false otherwise.}} | ||
Revision as of 21:51, 25 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 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 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 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
