Document alternatives to some static Color methods

This commit is contained in:
kobewi 2024-07-28 17:30:02 +02:00
parent 607b230ffe
commit 7cc0df6b46

View File

@ -190,6 +190,7 @@
<param index="1" name="default" type="Color" /> <param index="1" name="default" type="Color" />
<description> <description>
Creates a [Color] from the given string, which can be either an HTML color code or a named color (case-insensitive). Returns [param default] if the color cannot be inferred from the string. Creates a [Color] from the given string, which can be either an HTML color code or a named color (case-insensitive). Returns [param default] if the color cannot be inferred from the string.
If you want to create a color from String in a constant expression, use the equivalent constructor instead (i.e. [code]Color("color string")[/code]).
</description> </description>
</method> </method>
<method name="get_luminance" qualifiers="const"> <method name="get_luminance" qualifiers="const">
@ -217,6 +218,7 @@
var my_color = new Color(0xbbefd2a4); var my_color = new Color(0xbbefd2a4);
[/csharp] [/csharp]
[/codeblocks] [/codeblocks]
If you want to use hex notation in a constant expression, use the equivalent constructor instead (i.e. [code]Color(0xRRGGBBAA)[/code]).
</description> </description>
</method> </method>
<method name="hex64" qualifiers="static"> <method name="hex64" qualifiers="static">