godotengine
/
godot
mirror of https://github.com/godotengine/godot
1
0
Fork 0
Code

Alpha channel indicates opacity, not transparency

This commit is contained in:
Haoyu Qiu 2021-12-24 16:45:09 +08:00
parent 9d02cfa6b4
commit 3ec5a5fb5c
2 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/classes/Color.xml
View File

@ -4,7 +4,7 @@
Color in RGBA format using floats on the range of 0 to 1. Color in RGBA format using floats on the range of 0 to 1.
</brief_description> </brief_description>
<description> <description>
A color represented by red, green, blue, and alpha (RGBA) components. The alpha component is often used for transparency. Values are in floating-point and usually range from 0 to 1. Some properties (such as CanvasItem.modulate) may accept values greater than 1 (overbright or HDR colors). A color represented by red, green, blue, and alpha (RGBA) components. The alpha component is often used for opacity. Values are in floating-point and usually range from 0 to 1. Some properties (such as CanvasItem.modulate) may accept values greater than 1 (overbright or HDR colors).
You can also create a color from standardized color names by using the string constructor or directly using the color constants defined here. The standardized color set is based on the [url=https://en.wikipedia.org/wiki/X11_color_names]X11 color names[/url]. You can also create a color from standardized color names by using the string constructor or directly using the color constants defined here. The standardized color set is based on the [url=https://en.wikipedia.org/wiki/X11_color_names]X11 color names[/url].
If you want to supply values in a range of 0 to 255, you should use [method @GDScript.Color8]. If you want to supply values in a range of 0 to 255, you should use [method @GDScript.Color8].
[b]Note:[/b] In a boolean context, a Color will evaluate to [code]false[/code] if it's equal to [code]Color(0, 0, 0, 1)[/code] (opaque black). Otherwise, a Color will always evaluate to [code]true[/code]. [b]Note:[/b] In a boolean context, a Color will evaluate to [code]false[/code] if it's equal to [code]Color(0, 0, 0, 1)[/code] (opaque black). Otherwise, a Color will always evaluate to [code]true[/code].
@ -30,10 +30,10 @@
Constructs a [Color] from an existing color, but with a custom alpha value. Constructs a [Color] from an existing color, but with a custom alpha value.
[codeblocks] [codeblocks]
[gdscript] [gdscript]
var red = Color(Color.red, 0.5) # 50% transparent red. var red = Color(Color.red, 0.2) # 20% opaque red.
[/gdscript] [/gdscript]
[csharp] [csharp]
var red = new Color(Colors.Red, 0.5f); // 50% transparent red. var red = new Color(Colors.Red, 0.2f); // 20% opaque red.
[/csharp] [/csharp]
[/codeblocks] [/codeblocks]
</description> </description>
@ -405,7 +405,7 @@
</methods> </methods>
<members> <members>
<member name="a" type="float" setter="" getter="" default="1.0"> <member name="a" type="float" setter="" getter="" default="1.0">
The color's alpha (transparency) component, typically on the range of 0 to 1. The color's alpha component, typically on the range of 0 to 1. A value of 0 means that the color is fully transparent. A value of 1 means that the color is fully opaque.
</member> </member>
<member name="a8" type="int" setter="" getter="" default="255"> <member name="a8" type="int" setter="" getter="" default="255">
Wrapper for [member a] that uses the range 0 to 255 instead of 0 to 1. Wrapper for [member a] that uses the range 0 to 255 instead of 0 to 1.

2
doc/classes/ColorPicker.xml
View File

@ -41,7 +41,7 @@
If [code]true[/code], the color will apply only after the user releases the mouse button, otherwise it will apply immediately even in mouse motion event (which can cause performance issues). If [code]true[/code], the color will apply only after the user releases the mouse button, otherwise it will apply immediately even in mouse motion event (which can cause performance issues).
</member> </member>
<member name="edit_alpha" type="bool" setter="set_edit_alpha" getter="is_editing_alpha" default="true"> <member name="edit_alpha" type="bool" setter="set_edit_alpha" getter="is_editing_alpha" default="true">
If [code]true[/code], shows an alpha channel slider (transparency). If [code]true[/code], shows an alpha channel slider (opacity).
</member> </member>
<member name="hsv_mode" type="bool" setter="set_hsv_mode" getter="is_hsv_mode" default="false"> <member name="hsv_mode" type="bool" setter="set_hsv_mode" getter="is_hsv_mode" default="false">
If [code]true[/code], allows editing the color with Hue/Saturation/Value sliders. If [code]true[/code], allows editing the color with Hue/Saturation/Value sliders.