asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[3.2] Improve comments in Color documentation

Browse source
This commit is contained in:
Aaron Franke 2020-11-14 04:44:14 -05:00
parent f5bf92faf4
commit 9c83b8ed70
No known key found for this signature in database
GPG key ID: 40A1750B977E56BF
2 changed files with 44 additions and 44 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

54
doc/classes/Color.xml
View file

@ -38,9 +38,9 @@
<argument index="0" name="from" type="int">
</argument>
<description>
Constructs a color from a 32-bit integer (each byte represents a component of the RGBA profile).
Constructs a color from a 32-bit integer in RGBA format (each byte represents a color channel).
[codeblock]
var c = Color(274) # Equivalent to RGBA(0, 0, 1, 18)
var c = Color(274) # Similar to Color(0.0, 0.0, 0.004, 0.07)
[/codeblock]
</description>
</method>
@ -54,9 +54,9 @@
<argument index="2" name="b" type="float">
</argument>
<description>
Constructs a color from an RGB profile using values between 0 and 1. Alpha will always be 1.
Constructs a color from RGB values, typically between 0 and 1. Alpha will be 1.
[codeblock]
var c = Color(0.2, 1.0, 0.7) # Equivalent to RGBA(51, 255, 178, 255)
var color = Color(0.2, 1.0, 0.7) # Similar to Color8(51, 255, 178, 255)
[/codeblock]
</description>
</method>
@ -72,9 +72,9 @@
<argument index="3" name="a" type="float">
</argument>
<description>
Constructs a color from an RGBA profile using values between 0 and 1.
Constructs a color from RGBA values, typically between 0 and 1.
[codeblock]
var c = Color(0.2, 1.0, 0.7, 0.8) # Equivalent to RGBA(51, 255, 178, 204)
var color = Color(0.2, 1.0, 0.7, 0.8) # Similar to Color8(51, 255, 178, 204)
[/codeblock]
</description>
</method>
@ -152,8 +152,8 @@
<description>
Returns the inverted color [code](1 - r, 1 - g, 1 - b, a)[/code].
[codeblock]
var c = Color(0.3, 0.4, 0.9)
var inverted_color = c.inverted() # A color of an RGBA(178, 153, 26, 255)
var color = Color(0.3, 0.4, 0.9)
var inverted_color = color.inverted() # Equivalent to Color(0.7, 0.6, 0.1)
[/codeblock]
</description>
</method>
@ -191,7 +191,7 @@
[codeblock]
var c1 = Color(1.0, 0.0, 0.0)
var c2 = Color(0.0, 1.0, 0.0)
var li_c = c1.linear_interpolate(c2, 0.5) # A color of an RGBA(128, 128, 0, 255)
var li_c = c1.linear_interpolate(c2, 0.5) # Equivalent to Color(0.5, 0.5, 0.0)
[/codeblock]
</description>
</method>
@ -199,10 +199,10 @@
<return type="int">
</return>
<description>
Returns the color's 32-bit integer in ABGR format (each byte represents a component of the ABGR profile). ABGR is the reversed version of the default format.
Returns the color converted to a 32-bit integer in ABGR format (each byte represents a color channel). ABGR is the reversed version of the default format.
[codeblock]
var c = Color(1, 0.5, 0.2)
print(c.to_abgr32()) # Prints 4281565439
var color = Color(1, 0.5, 0.2)
print(color.to_abgr32()) # Prints 4281565439
[/codeblock]
</description>
</method>
@ -210,10 +210,10 @@
<return type="int">
</return>
<description>
Returns the color's 64-bit integer in ABGR format (each word represents a component of the ABGR profile). ABGR is the reversed version of the default format.
Returns the color converted to a 64-bit integer in ABGR format (each word represents a color channel). ABGR is the reversed version of the default format.
[codeblock]
var c = Color(1, 0.5, 0.2)
print(c.to_abgr64()) # Prints -225178692812801
var color = Color(1, 0.5, 0.2)
print(color.to_abgr64()) # Prints -225178692812801
[/codeblock]
</description>
</method>
@ -221,10 +221,10 @@
<return type="int">
</return>
<description>
Returns the color's 32-bit integer in ARGB format (each byte represents a component of the ARGB profile). ARGB is more compatible with DirectX.
Returns the color converted to a 32-bit integer in ARGB format (each byte represents a color channel). ARGB is more compatible with DirectX.
[codeblock]
var c = Color(1, 0.5, 0.2)
print(c.to_argb32()) # Prints 4294934323
var color = Color(1, 0.5, 0.2)
print(color.to_argb32()) # Prints 4294934323
[/codeblock]
</description>
</method>
@ -232,10 +232,10 @@
<return type="int">
</return>
<description>
Returns the color's 64-bit integer in ARGB format (each word represents a component of the ARGB profile). ARGB is more compatible with DirectX.
Returns the color converted to a 64-bit integer in ARGB format (each word represents a color channel). ARGB is more compatible with DirectX.
[codeblock]
var c = Color(1, 0.5, 0.2)
print(c.to_argb64()) # Prints -2147470541
var color = Color(1, 0.5, 0.2)
print(color.to_argb64()) # Prints -2147470541
[/codeblock]
</description>
</method>
@ -258,10 +258,10 @@
<return type="int">
</return>
<description>
Returns the color's 32-bit integer in RGBA format (each byte represents a component of the RGBA profile). RGBA is Godot's default format.
Returns the color converted to a 32-bit integer in RGBA format (each byte represents a color channel). RGBA is Godot's default format.
[codeblock]
var c = Color(1, 0.5, 0.2)
print(c.to_rgba32()) # Prints 4286526463
var color = Color(1, 0.5, 0.2)
print(color.to_rgba32()) # Prints 4286526463
[/codeblock]
</description>
</method>
@ -269,10 +269,10 @@
<return type="int">
</return>
<description>
Returns the color's 64-bit integer in RGBA format (each word represents a component of the RGBA profile). RGBA is Godot's default format.
Returns the color converted to a 64-bit integer in RGBA format (each word represents a color channel). RGBA is Godot's default format.
[codeblock]
var c = Color(1, 0.5, 0.2)
print(c.to_rgba64()) # Prints -140736629309441
var color = Color(1, 0.5, 0.2)
print(color.to_rgba64()) # Prints -140736629309441
[/codeblock]
</description>
</method>

34
modules/mono/glue/GodotSharp/GodotSharp/Core/Color.cs
View file

@ -462,8 +462,8 @@ namespace Godot
}
/// <summary>
/// Returns the color's 32-bit integer in ABGR format
/// (each byte represents a component of the ABGR profile).
/// Returns the color converted to a 32-bit integer in ABGR
/// format (each byte represents a color channel).
/// ABGR is the reversed version of the default format.
/// </summary>
/// <returns>An int representing this color in ABGR32 format.</returns>
@ -481,8 +481,8 @@ namespace Godot
}
/// <summary>
/// Returns the color's 64-bit integer in ABGR format
/// (each byte represents a component of the ABGR profile).
/// Returns the color converted to a 64-bit integer in ABGR
/// format (each word represents a color channel).
/// ABGR is the reversed version of the default format.
/// </summary>
/// <returns>An int representing this color in ABGR64 format.</returns>
@ -500,8 +500,8 @@ namespace Godot
}
/// <summary>
/// Returns the color's 32-bit integer in ARGB format
/// (each byte represents a component of the ARGB profile).
/// Returns the color converted to a 32-bit integer in ARGB
/// format (each byte represents a color channel).
/// ARGB is more compatible with DirectX, but not used much in Godot.
/// </summary>
/// <returns>An int representing this color in ARGB32 format.</returns>
@ -519,8 +519,8 @@ namespace Godot
}
/// <summary>
/// Returns the color's 64-bit integer in ARGB format
/// (each word represents a component of the ARGB profile).
/// Returns the color converted to a 64-bit integer in ARGB
/// format (each word represents a color channel).
/// ARGB is more compatible with DirectX, but not used much in Godot.
/// </summary>
/// <returns>A long representing this color in ARGB64 format.</returns>
@ -538,8 +538,8 @@ namespace Godot
}
/// <summary>
/// Returns the color's 32-bit integer in RGBA format
/// (each byte represents a component of the RGBA profile).
/// Returns the color converted to a 32-bit integer in RGBA
/// format (each byte represents a color channel).
/// RGBA is Godot's default and recommended format.
/// </summary>
/// <returns>An int representing this color in RGBA32 format.</returns>
@ -557,8 +557,8 @@ namespace Godot
}
/// <summary>
/// Returns the color's 64-bit integer in RGBA format
/// (each word represents a component of the RGBA profile).
/// Returns the color converted to a 64-bit integer in RGBA
/// format (each word represents a color channel).
/// RGBA is Godot's default and recommended format.
/// </summary>
/// <returns>A long representing this color in RGBA64 format.</returns>
@ -595,7 +595,7 @@ namespace Godot
}
/// <summary>
/// Constructs a color from RGBA values on the range of 0 to 1.
/// Constructs a color from RGBA values, typically on the range of 0 to 1.
/// </summary>
/// <param name="r">The color's red component, typically on the range of 0 to 1.</param>
/// <param name="g">The color's green component, typically on the range of 0 to 1.</param>
@ -623,8 +623,8 @@ namespace Godot
}
/// <summary>
/// Constructs a color from a 32-bit integer
/// (each byte represents a component of the RGBA profile).
/// Constructs a color from a 32-bit integer in RGBA format
/// (each byte represents a color channel).
/// </summary>
/// <param name="rgba">The int representing the color.</param>
public Color(int rgba)
@ -639,8 +639,8 @@ namespace Godot
}
/// <summary>
/// Constructs a color from a 64-bit integer
/// (each word represents a component of the RGBA profile).
/// Constructs a color from a 64-bit integer in RGBA format
/// (each word represents a color channel).
/// </summary>
/// <param name="rgba">The long representing the color.</param>
public Color(long rgba)