diff options
| author | Clay John <claynjohn@gmail.com> | 2023-01-23 10:32:15 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-01-23 10:32:15 -0800 |
| commit | c06df6779ae8c3145cd7be727102663ccae568e9 (patch) | |
| tree | 10717b3bed01344d4b6457414a34fcf1b3646836 | |
| parent | e6bd9c10fcc3acb8fe47b1c5c4b3e189143f4d33 (diff) | |
| parent | abcf0aaed2122365997c38120c8548928cc1f832 (diff) | |
Merge pull request #71927 from Calinou/doc-vsync-runtime-change
Document changing V-Sync at runtime in the class reference
| -rw-r--r-- | doc/classes/DisplayServer.xml | 4 | ||||
| -rw-r--r-- | doc/classes/ProjectSettings.xml | 3 |
2 files changed, 4 insertions, 3 deletions
diff --git a/doc/classes/DisplayServer.xml b/doc/classes/DisplayServer.xml index 832adb6e98..b77ec4c517 100644 --- a/doc/classes/DisplayServer.xml +++ b/doc/classes/DisplayServer.xml @@ -1434,9 +1434,9 @@ <param index="0" name="vsync_mode" type="int" enum="DisplayServer.VSyncMode" /> <param index="1" name="window_id" type="int" default="0" /> <description> - Sets the V-Sync mode of the given window. + Sets the V-Sync mode of the given window. See also [member ProjectSettings.display/window/vsync/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 [constant VSYNC_ENABLED], if the desired mode is not supported. + Depending on the platform and used renderer, the engine will fall back to [constant VSYNC_ENABLED] if the desired mode is not supported. </description> </method> <method name="window_set_window_buttons_offset"> diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index ec05be368c..84df014fa4 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -662,7 +662,8 @@ <member name="display/window/vsync/vsync_mode" type="int" setter="" getter="" default="1"> Sets the V-Sync mode for the main game window. 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 [code]Enabled[/code], if the desired mode is not supported. + Depending on the platform and used renderer, the engine will fall back to [code]Enabled[/code] if the desired mode is not supported. + [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=""""> Name of the .NET assembly. This name is used as the name of the [code].csproj[/code] and [code].sln[/code] files. By default, it's set to the name of the project ([member application/config/name]) allowing to change it in the future without affecting the .NET assembly. |