summaryrefslogtreecommitdiff
path: root/doc/classes/Rect2i.xml
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2020-02-24 17:00:40 +0100
committerRémi Verschelde <rverschelde@gmail.com>2020-02-25 15:27:29 +0100
commit6c8f2ae53a1921aa8589cf4da735f5cd443ff706 (patch)
treea3d444dd3179172a39d6d9759cfbbbdaf5d9e530 /doc/classes/Rect2i.xml
parent2f237d181b6fd769b52bded49cafc9bc5eb9f087 (diff)
Update docs and bindings for new integer vector types
Diffstat (limited to 'doc/classes/Rect2i.xml')
-rw-r--r--doc/classes/Rect2i.xml52
1 files changed, 52 insertions, 0 deletions
diff --git a/doc/classes/Rect2i.xml b/doc/classes/Rect2i.xml
new file mode 100644
index 0000000000..2e8be384c1
--- /dev/null
+++ b/doc/classes/Rect2i.xml
@@ -0,0 +1,52 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="Rect2i" version="4.0">
+ <brief_description>
+ 2D axis-aligned bounding box using integer coordinates.
+ </brief_description>
+ <description>
+ [Rect2i] consists of a position, a size, and several utility functions. It is typically used for fast overlap tests.
+ It uses integer coordinates.
+ </description>
+ <tutorials>
+ <link>https://docs.godotengine.org/en/latest/tutorials/math/index.html</link>
+ </tutorials>
+ <methods>
+ <method name="Rect2i">
+ <return type="Rect2i">
+ </return>
+ <argument index="0" name="position" type="Vector2">
+ </argument>
+ <argument index="1" name="size" type="Vector2">
+ </argument>
+ <description>
+ Constructs a [Rect2i] by position and size.
+ </description>
+ </method>
+ <method name="Rect2i">
+ <return type="Rect2i">
+ </return>
+ <argument index="0" name="x" type="int">
+ </argument>
+ <argument index="1" name="y" type="int">
+ </argument>
+ <argument index="2" name="width" type="int">
+ </argument>
+ <argument index="3" name="height" type="int">
+ </argument>
+ <description>
+ Constructs a [Rect2i] by x, y, width, and height.
+ </description>
+ </method>
+ <method name="Rect2i">
+ <return type="Rect2i">
+ </return>
+ <argument index="0" name="from" type="Rect2">
+ </argument>
+ <description>
+ Constructs a new [Rect2i] from [Rect2]. The floating point coordinates will be truncated.
+ </description>
+ </method>
+ </methods>
+ <constants>
+ </constants>
+</class>