summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <remi@verschelde.fr>2022-02-04 11:51:07 +0100
committerGitHub <noreply@github.com>2022-02-04 11:51:07 +0100
commitd235c1bb1964b80d776a64aa2a1b198a8e52bf72 (patch)
tree5580b3e38c269efb494b20d54ae6a3e355d2dd58 /doc/classes
parent85f6151e9d4ce9ecc4fe587cc6e76356b49e8a43 (diff)
parent54dec44dbae4859842c6d99aafaafd186b33fee4 (diff)
Merge pull request #57335 from jordigcs/display-refresh-rate
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/DisplayServer.xml8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/classes/DisplayServer.xml b/doc/classes/DisplayServer.xml
index 8be944b105..307dbf9d88 100644
--- a/doc/classes/DisplayServer.xml
+++ b/doc/classes/DisplayServer.xml
@@ -399,6 +399,14 @@
<description>
</description>
</method>
+ <method name="screen_get_refresh_rate" qualifiers="const">
+ <return type="float" />
+ <argument index="0" name="screen" type="int" default="-1" />
+ <description>
+ Returns the current refresh rate of the specified screen. If [code]screen[/code] is [code]SCREEN_OF_MAIN_WINDOW[/code] (the default value), a screen with the main window will be used.
+ [b]Note:[/b] Returns [code]60.0[/code] if the DisplayServer fails to find the refresh rate for the specified screen. On HTML5, [method screen_get_refresh_rate] will always return [code]60.0[/code] as there is no way to retrieve the refresh rate on that platform.
+ </description>
+ </method>
<method name="screen_get_scale" qualifiers="const">
<return type="float" />
<argument index="0" name="screen" type="int" default="-1" />