diff options
| author | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2024-05-25 20:03:36 +0200 |
|---|---|---|
| committer | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2024-05-25 20:04:14 +0200 |
| commit | 0683677563fc35af6b25ad6e010d44aa5126f0f8 (patch) | |
| tree | e31f8da0a4fa5e5d04871d8e32c383a81b546d2c /doc | |
| parent | b7feebefabc2d48b0d4794cd31fc141f1caecc5c (diff) | |
| download | redot-engine-0683677563fc35af6b25ad6e010d44aa5126f0f8.tar.gz | |
Fix outdated `vsync_mode` project setting documentation
Disabling V-Sync when using the Compatibility rendering method works
since Godot 4.2 at least.
This also documents the `--disable-vsync` command line argument.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/ProjectSettings.xml | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index 5ac4c96d93..32e71ce030 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -902,8 +902,9 @@ <member name="display/window/vsync/vsync_mode" type="int" setter="" getter="" default="1"> Sets the V-Sync mode for the main game window. The editor's own V-Sync mode can be set using [member EditorSettings.interface/editor/vsync_mode]. See [enum DisplayServer.VSyncMode] for possible values and how they affect the behavior of your application. - Depending on the platform and used renderer, the engine will fall back to [b]Enabled[/b] if the desired mode is not supported. - [b]Note:[/b] V-Sync modes other than [b]Enabled[/b] are only supported in the Forward+ and Mobile rendering methods, not Compatibility. + Depending on the platform and rendering method, the engine will fall back to [b]Enabled[/b] if the desired mode is not supported. + V-Sync can be disabled on the command line using the [code]--disable-vsync[/code] [url=$DOCS_URL/tutorials/editor/command_line_tutorial.html]command line argument[/url]. + [b]Note:[/b] The [b]Adaptive[/b] and [b]Mailbox[/b] V-Sync modes are only supported in the Forward+ and Mobile rendering methods, not Compatibility. [b]Note:[/b] This property is only read when the project starts. To change the V-Sync mode at runtime, call [method DisplayServer.window_set_vsync_mode] instead. </member> <member name="dotnet/project/assembly_name" type="String" setter="" getter="" default=""""> |