Difference between revisions of "love.graphics.setMode"
m (1 revision: Imported docs from potato.) |
m (Fixed Removed, and conf.lua link.) |
||
| (29 intermediate revisions by 11 users not shown) | |||
| Line 1: | Line 1: | ||
| + | {{oldin|[[0.9.0]]|090|type=function|text=Moved to the [[love.window]] module as [[love.window.setMode]]}} | ||
| + | Changes the window size, or the display mode if fullscreen. | ||
| + | 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. | ||
== Function == | == Function == | ||
=== Synopsis === | === Synopsis === | ||
<source lang="lua"> | <source lang="lua"> | ||
| − | + | success = love.graphics.setMode( width, height, fullscreen, vsync, fsaa ) | |
</source> | </source> | ||
=== Arguments === | === Arguments === | ||
{{param|number|width|Display width.}} | {{param|number|width|Display width.}} | ||
{{param|number|height|Display height.}} | {{param|number|height|Display height.}} | ||
| − | {{param| | + | {{param|boolean|fullscreen (false)|Fullscreen (true), or windowed (false).}} |
| − | {{param| | + | {{param|boolean|vsync (true)|True if LÖVE should wait for vsync, false otherwise.}} |
| − | {{param|number|fsaa (0)|The number of | + | {{param|number|fsaa (0)|The number of MSAA samples.}} |
=== Returns === | === Returns === | ||
| − | {{param|boolean|True | + | {{param|boolean|success|True if successful, false otherwise.}} |
| + | |||
| + | == Notes == | ||
| + | If you have disabled the screen in [[Config_Files|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 == | ||
* [[parent::love.graphics]] | * [[parent::love.graphics]] | ||
[[Category:Functions]] | [[Category:Functions]] | ||
| − | {{#set:Description=}} | + | {{#set:Description=Changes the display mode.}} |
| + | {{#set:Since=000}} | ||
| + | {{#set:Removed=090}} | ||
| + | {{#set:Sub-Category=Window}} | ||
| + | == Other Languages == | ||
| + | {{i18n|love.graphics.setMode}} | ||
Latest revision as of 03:06, 10 September 2016
| Removed in LÖVE 0.9.0 |
| Moved to the love.window module as love.window.setMode. |
Changes the window size, or the display mode if fullscreen.
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 MSAA samples.
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
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
