summaryrefslogtreecommitdiffstats
path: root/doc/classes
diff options
context:
space:
mode:
authorJesse <jesse.katzman+github@gmail.com>2024-11-13 22:02:42 -0800
committerGitHub <noreply@github.com>2024-11-13 22:02:42 -0800
commit4ba533d0b5dc62e8cf18f2aefdb1b0ae7ba6fb27 (patch)
tree278348a48034db48822ea6758755605929421a6c /doc/classes
parent76fa7b291455a8ba24c50005072ebdb58f8a5984 (diff)
downloadredot-engine-4ba533d0b5dc62e8cf18f2aefdb1b0ae7ba6fb27.tar.gz
[DisplayServer] [docs] Describe edge cases for `get_screen_from_rect()`
Describes output when multiple screens intersect with rectangle or rectangle has no area.
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/DisplayServer.xml2
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/classes/DisplayServer.xml b/doc/classes/DisplayServer.xml
index dafa86d42e..57041a0e8c 100644
--- a/doc/classes/DisplayServer.xml
+++ b/doc/classes/DisplayServer.xml
@@ -237,7 +237,7 @@
<return type="int" />
<param index="0" name="rect" type="Rect2" />
<description>
- Returns index of the screen which contains specified rectangle.
+ Returns index of screen that overlaps the most with the given rectangle. Returns [code]-1[/code] if the rectangle doesn't overlap any screen or has zero area.
</description>
</method>
<method name="get_swap_cancel_ok">