summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
authorTerminalJack <TerminalJack@sbcglobal.net>2019-11-06 20:18:55 -0600
committerRémi Verschelde <rverschelde@gmail.com>2019-12-04 11:14:21 +0100
commite1dda5195cb2b8620a61740e8491cbb243aa653c (patch)
tree82a09611dfef0b3855b880f970ec9af7563f4fb1 /doc/classes
parent10481046e52cbb7a90dd084fc51633388ba7ea6e (diff)
Added support for vertical syncing via the Windows OS compositor (DWM.)
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/OS.xml3
-rw-r--r--doc/classes/ProjectSettings.xml3
2 files changed, 6 insertions, 0 deletions
diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml
index 331723df7c..54b4f3df64 100644
--- a/doc/classes/OS.xml
+++ b/doc/classes/OS.xml
@@ -928,6 +928,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">
+ 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.
+ </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.
[b]Note:[/b] Setting [code]window_borderless[/code] to [code]false[/code] disables per-pixel transparency.
diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml
index 772c2f5073..97af3ec77a 100644
--- a/doc/classes/ProjectSettings.xml
+++ b/doc/classes/ProjectSettings.xml
@@ -431,6 +431,9 @@
<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">
+ 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="&quot;res://script_templates&quot;">
</member>
<member name="editor/search_in_file_extensions" type="PoolStringArray" setter="" getter="" default="PoolStringArray( &quot;gd&quot;, &quot;shader&quot; )">