summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2024-06-17 10:59:03 +0200
committerRémi Verschelde <rverschelde@gmail.com>2024-06-17 10:59:03 +0200
commitf6bd88090d869b8527563dfe20a72ce9967f6ff8 (patch)
tree464cacb4699981643f1cb5105a3b1df4b8bfa9fc
parent4671bbc42eb2a189c374bbfabb2ac68789788b41 (diff)
parentaa9bd34d68ac8ac50ac28b1300aadd6f35d8d314 (diff)
downloadredot-engine-f6bd88090d869b8527563dfe20a72ce9967f6ff8.tar.gz
Merge pull request #93218 from thmasn/color-documentation
Mention inverse of hex functions in `Color`
-rw-r--r--doc/classes/Color.xml8
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/classes/Color.xml b/doc/classes/Color.xml
index 37beca5f81..3f0ccc0b5e 100644
--- a/doc/classes/Color.xml
+++ b/doc/classes/Color.xml
@@ -203,7 +203,7 @@
<return type="Color" />
<param index="0" name="hex" type="int" />
<description>
- Returns the [Color] associated with the provided [param hex] integer in 32-bit RGBA format (8 bits per channel).
+ Returns the [Color] associated with the provided [param hex] integer in 32-bit RGBA format (8 bits per channel). This method is the inverse of [method to_rgba32].
In GDScript and C#, the [int] is best visualized with hexadecimal notation ([code]"0x"[/code] prefix, making it [code]"0xRRGGBBAA"[/code]).
[codeblocks]
[gdscript]
@@ -223,7 +223,7 @@
<return type="Color" />
<param index="0" name="hex" type="int" />
<description>
- Returns the [Color] associated with the provided [param hex] integer in 64-bit RGBA format (16 bits per channel).
+ Returns the [Color] associated with the provided [param hex] integer in 64-bit RGBA format (16 bits per channel). This method is the inverse of [method to_rgba64].
In GDScript and C#, the [int] is best visualized with hexadecimal notation ([code]"0x"[/code] prefix, making it [code]"0xRRRRGGGGBBBBAAAA"[/code]).
</description>
</method>
@@ -441,7 +441,7 @@
<method name="to_rgba32" qualifiers="const">
<return type="int" />
<description>
- Returns the color converted to a 32-bit integer in RGBA format (each component is 8 bits). RGBA is Godot's default format.
+ Returns the color converted to a 32-bit integer in RGBA format (each component is 8 bits). RGBA is Godot's default format. This method is the inverse of [method hex].
[codeblocks]
[gdscript]
var color = Color(1, 0.5, 0.2)
@@ -457,7 +457,7 @@
<method name="to_rgba64" qualifiers="const">
<return type="int" />
<description>
- Returns the color converted to a 64-bit integer in RGBA format (each component is 16 bits). RGBA is Godot's default format.
+ Returns the color converted to a 64-bit integer in RGBA format (each component is 16 bits). RGBA is Godot's default format. This method is the inverse of [method hex64].
[codeblocks]
[gdscript]
var color = Color(1, 0.5, 0.2)