summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2019-10-08 22:52:13 +0200
committerGitHub <noreply@github.com>2019-10-08 22:52:13 +0200
commit9a929a7e4d9aa32ea46f824096694534109ad459 (patch)
tree75fea6c65b9d04262a38b9718a01161eb43322ed
parentc84aafdac24bf6b88eefe616f3bed1c815a34b44 (diff)
parent5c2bb56979ee09276866375f3243aafdf5d4ef89 (diff)
Merge pull request #32647 from Calinou/doc-improve-os-screen
Improve the OS `get_screen_*` methods' documentation
-rw-r--r--doc/classes/OS.xml6
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml
index 9acddb3115..9e1b25abe1 100644
--- a/doc/classes/OS.xml
+++ b/doc/classes/OS.xml
@@ -326,7 +326,7 @@
<argument index="0" name="screen" type="int" default="-1">
</argument>
<description>
- Returns the dots per inch density of the specified screen.
+ Returns the dots per inch density of the specified screen. If [code]screen[/code] is [/code]-1[/code] (the default value), the current screen will be used.
On Android devices, the actual screen densities are grouped into six generalized densities:
[codeblock]
ldpi - 120 dpi
@@ -344,7 +344,7 @@
<argument index="0" name="screen" type="int" default="-1">
</argument>
<description>
- Returns the position of the specified screen by index. If no screen index is provided, the current screen will be used.
+ Returns the position of the specified screen by index. If [code]screen[/code] is [/code]-1[/code] (the default value), the current screen will be used.
</description>
</method>
<method name="get_screen_size" qualifiers="const">
@@ -353,7 +353,7 @@
<argument index="0" name="screen" type="int" default="-1">
</argument>
<description>
- Returns the dimensions in pixels of the specified screen.
+ Returns the dimensions in pixels of the specified screen. If [code]screen[/code] is [/code]-1[/code] (the default value), the current screen will be used.
</description>
</method>
<method name="get_splash_tick_msec" qualifiers="const">