From 2e13e3ed4a0f94e5f868cc827d1ba6ad4bed8b35 Mon Sep 17 00:00:00 2001
From: Aaron Franke <arnfranke@yahoo.com>
Date: Mon, 1 Feb 2021 00:10:52 -0500
Subject: Allow clamping vectors and colors

---
 doc/classes/Color.xml    | 11 +++++++++++
 doc/classes/Vector2.xml  | 11 +++++++++++
 doc/classes/Vector2i.xml | 11 +++++++++++
 doc/classes/Vector3.xml  | 11 +++++++++++
 doc/classes/Vector3i.xml | 11 +++++++++++
 5 files changed, 55 insertions(+)

(limited to 'doc/classes')

diff --git a/doc/classes/Color.xml b/doc/classes/Color.xml
index 6133bb8d8c..ddff92e6fc 100644
--- a/doc/classes/Color.xml
+++ b/doc/classes/Color.xml
@@ -136,6 +136,17 @@
 				[/codeblocks]
 			</description>
 		</method>
+		<method name="clamp" qualifiers="const">
+			<return type="Color">
+			</return>
+			<argument index="0" name="min" type="Color" default="Color( 0, 0, 0, 0 )">
+			</argument>
+			<argument index="1" name="max" type="Color" default="Color( 1, 1, 1, 1 )">
+			</argument>
+			<description>
+				Returns a new color with all components clamped between the components of [code]min[/code] and [code]max[/code], by running [method @GlobalScope.clamp] on each component.
+			</description>
+		</method>
 		<method name="darkened" qualifiers="const">
 			<return type="Color">
 			</return>
diff --git a/doc/classes/Vector2.xml b/doc/classes/Vector2.xml
index 9e47ebfaea..1390a5e45b 100644
--- a/doc/classes/Vector2.xml
+++ b/doc/classes/Vector2.xml
@@ -110,6 +110,17 @@
 				Returns the vector with all components rounded up (towards positive infinity).
 			</description>
 		</method>
+		<method name="clamp" qualifiers="const">
+			<return type="Vector2">
+			</return>
+			<argument index="0" name="min" type="Vector2">
+			</argument>
+			<argument index="1" name="max" type="Vector2">
+			</argument>
+			<description>
+				Returns a new vector with all components clamped between the components of [code]min[/code] and [code]max[/code], by running [method @GlobalScope.clamp] on each component.
+			</description>
+		</method>
 		<method name="cross" qualifiers="const">
 			<return type="float">
 			</return>
diff --git a/doc/classes/Vector2i.xml b/doc/classes/Vector2i.xml
index b38b968ba3..6efb52b712 100644
--- a/doc/classes/Vector2i.xml
+++ b/doc/classes/Vector2i.xml
@@ -64,6 +64,17 @@
 				Returns the ratio of [member x] to [member y].
 			</description>
 		</method>
+		<method name="clamp" qualifiers="const">
+			<return type="Vector2i">
+			</return>
+			<argument index="0" name="min" type="Vector2i">
+			</argument>
+			<argument index="1" name="max" type="Vector2i">
+			</argument>
+			<description>
+				Returns a new vector with all components clamped between the components of [code]min[/code] and [code]max[/code], by running [method @GlobalScope.clamp] on each component.
+			</description>
+		</method>
 		<method name="operator !=" qualifiers="operator">
 			<return type="bool">
 			</return>
diff --git a/doc/classes/Vector3.xml b/doc/classes/Vector3.xml
index 94ecce5e31..170bd78067 100644
--- a/doc/classes/Vector3.xml
+++ b/doc/classes/Vector3.xml
@@ -87,6 +87,17 @@
 				Returns a new vector with all components rounded up (towards positive infinity).
 			</description>
 		</method>
+		<method name="clamp" qualifiers="const">
+			<return type="Vector3">
+			</return>
+			<argument index="0" name="min" type="Vector3">
+			</argument>
+			<argument index="1" name="max" type="Vector3">
+			</argument>
+			<description>
+				Returns a new vector with all components clamped between the components of [code]min[/code] and [code]max[/code], by running [method @GlobalScope.clamp] on each component.
+			</description>
+		</method>
 		<method name="cross" qualifiers="const">
 			<return type="Vector3">
 			</return>
diff --git a/doc/classes/Vector3i.xml b/doc/classes/Vector3i.xml
index ea5945f5b7..6e8a34b692 100644
--- a/doc/classes/Vector3i.xml
+++ b/doc/classes/Vector3i.xml
@@ -58,6 +58,17 @@
 			<description>
 			</description>
 		</method>
+		<method name="clamp" qualifiers="const">
+			<return type="Vector3i">
+			</return>
+			<argument index="0" name="min" type="Vector3i">
+			</argument>
+			<argument index="1" name="max" type="Vector3i">
+			</argument>
+			<description>
+				Returns a new vector with all components clamped between the components of [code]min[/code] and [code]max[/code], by running [method @GlobalScope.clamp] on each component.
+			</description>
+		</method>
 		<method name="max_axis" qualifiers="const">
 			<return type="int">
 			</return>
-- 
cgit v1.2.3