diff options
| author | Haoyu Qiu <timothyqiu32@gmail.com> | 2021-12-24 16:45:09 +0800 |
|---|---|---|
| committer | Haoyu Qiu <timothyqiu32@gmail.com> | 2021-12-24 16:52:15 +0800 |
| commit | 3ec5a5fb5cfd2ccd9abc00beb917ceb3f8bd3b5c (patch) | |
| tree | d6b170133bdba9170ea89beae69c4e5c0d21f696 | |
| parent | 9d02cfa6b4509f46dc31cca5542ba31bb9b94ae4 (diff) | |
Alpha channel indicates opacity, not transparency
| -rw-r--r-- | doc/classes/Color.xml | 8 | ||||
| -rw-r--r-- | doc/classes/ColorPicker.xml | 2 |
2 files changed, 5 insertions, 5 deletions
diff --git a/doc/classes/Color.xml b/doc/classes/Color.xml index 21d17969e2..f3fcd90f51 100644 --- a/doc/classes/Color.xml +++ b/doc/classes/Color.xml @@ -4,7 +4,7 @@ Color in RGBA format using floats on the range of 0 to 1. </brief_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]. 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]. @@ -30,10 +30,10 @@ Constructs a [Color] from an existing color, but with a custom alpha value. [codeblocks] [gdscript] - var red = Color(Color.red, 0.5) # 50% transparent red. + var red = Color(Color.red, 0.2) # 20% opaque red. [/gdscript] [csharp] - var red = new Color(Colors.Red, 0.5f); // 50% transparent red. + var red = new Color(Colors.Red, 0.2f); // 20% opaque red. [/csharp] [/codeblocks] </description> @@ -405,7 +405,7 @@ </methods> <members> <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 name="a8" type="int" setter="" getter="" default="255"> Wrapper for [member a] that uses the range 0 to 255 instead of 0 to 1. diff --git a/doc/classes/ColorPicker.xml b/doc/classes/ColorPicker.xml index 22439f6ca5..cb543afaba 100644 --- a/doc/classes/ColorPicker.xml +++ b/doc/classes/ColorPicker.xml @@ -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). </member> <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 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. |