diff options
| author | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2020-01-09 22:20:00 +0100 |
|---|---|---|
| committer | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2020-01-09 22:22:11 +0100 |
| commit | 9600fd5dde1f85b7dd2dd8558d52ff86b18651e7 (patch) | |
| tree | 37ff0bc647f116365c08306622501f4a87c2334c /doc/classes | |
| parent | 76678b2609921f27f52c1a2e2bd62b8d2a27bb4b (diff) | |
Enable Vsync via Compositor by default
This feature was added in #33414 but it was disabled by default.
Now that it got some testing, it's probably safe to enable it
by default.
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/OS.xml | 3 | ||||
| -rw-r--r-- | doc/classes/ProjectSettings.xml | 2 |
2 files changed, 3 insertions, 2 deletions
diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index 71d0c1a6fe..3550ef6b5f 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -937,8 +937,9 @@ <member name="vsync_enabled" type="bool" setter="set_use_vsync" getter="is_vsync_enabled" default="true"> If [code]true[/code], vertical synchronization (Vsync) is enabled. </member> - <member name="vsync_via_compositor" type="bool" setter="set_vsync_via_compositor" getter="is_vsync_via_compositor_enabled" default="false"> + <member name="vsync_via_compositor" type="bool" setter="set_vsync_via_compositor" getter="is_vsync_via_compositor_enabled" default="true"> If [code]true[/code] and [code]vsync_enabled[/code] is true, the operating system's window compositor will be used for vsync when the compositor is enabled and the game is in windowed mode. + [b]Note:[/b] This property is only implemented on Windows. </member> <member name="window_borderless" type="bool" setter="set_borderless_window" getter="get_borderless_window" default="false"> If [code]true[/code], removes the window frame. diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index 126f11a4ed..1bc43dc964 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -437,7 +437,7 @@ <member name="display/window/vsync/use_vsync" type="bool" setter="" getter="" default="true"> If [code]true[/code], enables vertical synchronization. This eliminates tearing that may appear in moving scenes, at the cost of higher input latency and stuttering at lower framerates. If [code]false[/code], vertical synchronization will be disabled, however, many platforms will enforce it regardless (such as mobile platforms and HTML5). </member> - <member name="display/window/vsync/vsync_via_compositor" type="bool" setter="" getter="" default="false"> + <member name="display/window/vsync/vsync_via_compositor" type="bool" setter="" getter="" default="true"> If [code]Use Vsync[/code] is enabled and this setting is [code]true[/code], enables vertical synchronization via the operating system's window compositor when in windowed mode and the compositor is enabled. This will prevent stutter in certain situations. (Windows only.) </member> <member name="editor/script_templates_search_path" type="String" setter="" getter="" default=""res://script_templates""> |