summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
authorHugo Locurcio <hugo.locurcio@hugo.pro>2019-10-08 15:42:46 +0200
committerHugo Locurcio <hugo.locurcio@hugo.pro>2019-10-08 15:43:01 +0200
commit5c2bb56979ee09276866375f3243aafdf5d4ef89 (patch)
tree3b70128d95623317491d9e6ab8bfd6ed3b14f04f /doc/classes
parent2078dcbe15e7b1a25bc06b0834a007d63c7ccd01 (diff)
Improve the OS `get_screen_*` methods' documentation
Diffstat (limited to 'doc/classes')
-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">