Difference between revisions of "love.window.setVSync"
m (vsync > 0 notice.) |
(Added driver-dependent n-frame-skip-sync feature to arguments; Explained it in notes with an example.) |
||
| Line 8: | Line 8: | ||
</source> | </source> | ||
=== Arguments === | === Arguments === | ||
| − | {{param|number|vsync|VSync number: 1 to enable, 0 to disable, | + | {{param|number|vsync|VSync number: 1 to enable, 0 to disable, -1 for adaptive vsync, 2 or larger will wait that many frames before syncing.}} |
=== Returns === | === Returns === | ||
Nothing. | Nothing. | ||
| Line 14: | Line 14: | ||
== Notes == | == Notes == | ||
* Not all graphics drivers support adaptive vsync (-1 value) and values more than 1 (vsync at other intervals). In that case, it will be automatically set to 1. | * Not all graphics drivers support adaptive vsync (-1 value) and values more than 1 (vsync at other intervals). In that case, it will be automatically set to 1. | ||
| + | * Having vsync be a number larger than one means that the game will sync to the nearest whole number of the screen's refresh rate divided by the given number; e.g. on a 60 FPS screen, vsync being 2 means it'll run at 30 FPS, 3 means 15 FPS, etc. | ||
* It is recommended to keep vsync activated if you don't know about the possible implications of turning it off. | * It is recommended to keep vsync activated if you don't know about the possible implications of turning it off. | ||
* This function doesn't recreate the window, unlike [[love.window.setMode]] and [[love.window.updateMode]]. | * This function doesn't recreate the window, unlike [[love.window.setMode]] and [[love.window.updateMode]]. | ||
Revision as of 12:29, 24 August 2021
| Available since LÖVE 11.3 |
| This function is not supported in earlier versions. |
Sets vertical synchronization mode.
Function
Synopsis
love.window.setVSync( vsync )
Arguments
number vsync- VSync number: 1 to enable, 0 to disable, -1 for adaptive vsync, 2 or larger will wait that many frames before syncing.
Returns
Nothing.
Notes
- Not all graphics drivers support adaptive vsync (-1 value) and values more than 1 (vsync at other intervals). In that case, it will be automatically set to 1.
- Having vsync be a number larger than one means that the game will sync to the nearest whole number of the screen's refresh rate divided by the given number; e.g. on a 60 FPS screen, vsync being 2 means it'll run at 30 FPS, 3 means 15 FPS, etc.
- It is recommended to keep vsync activated if you don't know about the possible implications of turning it off.
- This function doesn't recreate the window, unlike love.window.setMode and love.window.updateMode.
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
