Browse Source

Merge pull request #56215 from timothyqiu/alpha-channel-3.x

[3.x] Alpha channel indicates opacity, not transparency
Clay John 3 years ago
parent
commit
7fcfde9b75
2 changed files with 3 additions and 3 deletions
  1. 2 2
      doc/classes/Color.xml
  2. 1 1
      doc/classes/ColorPicker.xml

+ 2 - 2
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 [method @GDScript.ColorN] 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].
@@ -246,7 +246,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.

+ 1 - 1
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.