summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authormara <vmedea@protonmail.com>2023-05-30 12:59:35 +0200
committermara <vmedea@protonmail.com>2023-05-30 15:15:04 +0200
commit779ac20bb9efc869736ace5f2854aef50c21c0af (patch)
tree2f5e075667dc405b57401a913f38dba23a2d9f52 /doc
parent8f25cc2d133a17480c95dec026deb9338d2da74c (diff)
downloadredot-engine-779ac20bb9efc869736ace5f2854aef50c21c0af.tar.gz
Clarify doc for Color.hex and C# Color()
The "alpha channel first" seems misleading to me. It doesn't match with the examples, so remove it. Add a more detailed specification of the expected number format in hex.
Diffstat (limited to 'doc')
-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 f5411750b5..26b3e68e24 100644
--- a/doc/classes/Color.xml
+++ b/doc/classes/Color.xml
@@ -203,8 +203,8 @@
<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, alpha channel first).
- In GDScript and C#, the [int] is best visualized with hexadecimal notation ([code]"0x"[/code] prefix).
+ Returns the [Color] associated with the provided [param hex] integer in 32-bit RGBA format (8 bits per channel).
+ In GDScript and C#, the [int] is best visualized with hexadecimal notation ([code]"0x"[/code] prefix, making it [code]"0xRRGGBBAA"[/code]).
[codeblocks]
[gdscript]
var red = Color.hex(0xff0000ff)
@@ -223,8 +223,8 @@
<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, alpha channel first).
- In GDScript and C#, the [int] is best visualized with hexadecimal notation ([code]"0x"[/code] prefix).
+ Returns the [Color] associated with the provided [param hex] integer in 64-bit RGBA format (16 bits per channel).
+ In GDScript and C#, the [int] is best visualized with hexadecimal notation ([code]"0x"[/code] prefix, making it [code]"0xRRRRGGGGBBBBAAAA"[/code]).
</description>
</method>
<method name="html" qualifiers="static">