HPL3/SOMA/Scripting/cColor - Revision history

Abion47 at 13:25, 6 August 2020

2020-08-06T13:25:08Z

Abion47 at 01:02, 4 August 2020

2020-08-04T01:02:04Z

Abion47 at 21:08, 3 August 2020

2020-08-03T21:08:03Z

Abion47 at 20:46, 3 August 2020

2020-08-03T20:46:40Z

Abion47 at 20:35, 3 August 2020

2020-08-03T20:35:00Z

Abion47 at 20:28, 3 August 2020

2020-08-03T20:28:36Z

Abion47: Created page with "Color channel values are stored using a 0.0 - 1.0 range, where 0.0 is equal to 0 and 1.0 is equal to 255. Read [http://stackoverflow.com/questions/12524623/what-are-the-pract..."

2020-08-03T20:18:46Z

Created page with "Color channel values are stored using a 0.0 - 1.0 range, where 0.0 is equal to 0 and 1.0 is equal to 255. Read [http://stackoverflow.com/questions/12524623/what-are-the-pract..."

New page

Color channel values are stored using a 0.0 - 1.0 range, where 0.0 is equal to 0 and 1.0 is equal to 255.

Read [http://stackoverflow.com/questions/12524623/what-are-the-practical-differences-when-working-with-colors-in-a-linear-vs-a-no this post on StackOverflow] for an explanation on the differences between the linear color space and the sRGB color space.

== Constructors ==

{| class="wikitable"
! Constructor !! Description
|-
| cColor() || Creates a color with a default value of opaque black.
|-
| cColor(float, float) || Creates a color with the first parameter given to all the RGB values (the color will be a shade of grey) and the second parameter given to the alpha channel.
|-
| cColor(float, float, float) || Creates an opaque color using the given values as RGB data.
|-
| cColor(float, float, float, float) || Creates a color using the given values as RGBA data.
|}

== Fields ==

{| class="wikitable"
! Field Name !! Type !! Description
|-
| r || float || The value of the red channel.
|-
| g || float || The value of the green channel.
|-
| b || float || The value of the blue channel.
|-
| a || float || The value of the alpha channel.
|}

== Functions ==

{| class="wikitable"
! Return Type !! Function Name !! Parameters !! Description
|-
| [[cColor]] || ToLinearSpace || const float afPower, const bool abCorrectAlpha, const || Returns the color converted into the linear space.
|-
| [[cColor]] || ToSRGB || const bool abCorrectAlpha, const || Returns the color converted into the [[wikipedia:sRGB|sRGB]] space.
|}

[[Category:HPL3]]
[[Category:HPL3 Scripting]]
[[Category:HPL3 Classes]]
__FORCETOC__

@@ Line 8: / Line 8: @@
 ! Constructor !! Description
 |-
-| <syntaxhighlight lang="c++">cColor()</syntaxhighlight> || Creates a color with a default value of opaque black.
+| <syntaxhighlight lang="c++" inline>cColor()</syntaxhighlight> || Creates a color with a default value of opaque black.
 |-
-| <syntaxhighlight lang="c++">cColor(float, float)</syntaxhighlight> || Creates a color with the first parameter given to all the RGB values (the color will be a shade of grey) and the second parameter given to the alpha channel.
+| <syntaxhighlight lang="c++" inline>cColor(float, float)</syntaxhighlight> || Creates a color with the first parameter given to all the RGB values (the color will be a shade of grey) and the second parameter given to the alpha channel.
 |-
-| <syntaxhighlight lang="c++">cColor(float, float, float)</syntaxhighlight> || Creates an opaque color using the given values as RGB data.
+| <syntaxhighlight lang="c++" inline>cColor(float, float, float)</syntaxhighlight> || Creates an opaque color using the given values as RGB data.
 |-
-| <syntaxhighlight lang="c++">cColor(float, float, float, float)</syntaxhighlight> || Creates a color using the given values as RGBA data.
+| <syntaxhighlight lang="c++" inline>cColor(float, float, float, float)</syntaxhighlight> || Creates a color using the given values as RGBA data.
 |}
@@ Line 22: / Line 22: @@
 ! Field Name !! Type !! Description
 |-
-| r || <syntaxhighlight lang="c++">float</syntaxhighlight> || The value of the red channel.
+| r || <syntaxhighlight lang="c++" inline>float</syntaxhighlight> || The value of the red channel.
 |-
-| g || <syntaxhighlight lang="c++">float</syntaxhighlight> || The value of the green channel.
+| g || <syntaxhighlight lang="c++" inline>float</syntaxhighlight> || The value of the green channel.
 |-
-| b || <syntaxhighlight lang="c++">float</syntaxhighlight> || The value of the blue channel.
+| b || <syntaxhighlight lang="c++" inline>float</syntaxhighlight> || The value of the blue channel.
 |-
-| a || <syntaxhighlight lang="c++">float</syntaxhighlight> || The value of the alpha channel.
+| a || <syntaxhighlight lang="c++" inline>float</syntaxhighlight> || The value of the alpha channel.
 |}
@@ Line 36: / Line 36: @@
 ! Return Type !! Function Name !! Parameters !! Description
 |-
-| [[HPL3/SOMA/Scripting/cColor|<syntaxhighlight lang="c++">cColor</syntaxhighlight>]] || ToLinearSpace || <syntaxhighlight lang="c++">const float afPower,
+| [[../cColor|<syntaxhighlight lang="c++" inline>cColor</syntaxhighlight>]] || ToLinearSpace || <syntaxhighlight lang="c++" inline>const float afPower,</syntaxhighlight><br /><syntaxhighlight lang="c++" inline>const bool abCorrectAlpha,</syntaxhighlight><br /><syntaxhighlight lang="c++" inline>const</syntaxhighlight> || Returns the color converted into the linear space.
 |-
-| [[HPL3/SOMA/Scripting/cColor|<syntaxhighlight lang="c++">cColor</syntaxhighlight>]] || ToSRGB || <syntaxhighlight lang="c++">const bool abCorrectAlpha,
+| [[../cColor|<syntaxhighlight lang="c++" inline>cColor</syntaxhighlight>]] || ToSRGB || <syntaxhighlight lang="c++" inline>const bool abCorrectAlpha,</syntaxhighlight><br /><syntaxhighlight lang="c++" inline>const</syntaxhighlight> || Returns the color converted into the [[wikipedia:sRGB|sRGB]] space.
 |}

@@ Line 36: / Line 36: @@
 ! Return Type !! Function Name !! Parameters !! Description
 |-
-| [[HPL3/SOMA/Scripting/cColor|cColor]] || ToLinearSpace || const float afPower, const bool abCorrectAlpha, const || Returns the color converted into the linear space.
+| [[HPL3/SOMA/Scripting/cColor|cColor]] || ToLinearSpace || const float afPower, <br />const bool abCorrectAlpha, <br />const || Returns the color converted into the linear space.
 |-
-| [[HPL3/SOMA/Scripting/cColor|cColor]] || ToSRGB || const bool abCorrectAlpha, const || Returns the color converted into the [[wikipedia:sRGB|sRGB]] space.
+| [[HPL3/SOMA/Scripting/cColor|cColor]] || ToSRGB || const bool abCorrectAlpha, <br />const || Returns the color converted into the [[wikipedia:sRGB|sRGB]] space.
 |}

@@ Line 42: / Line 42: @@
 Read [http://stackoverflow.com/questions/12524623/what-are-the-practical-differences-when-working-with-colors-in-a-linear-vs-a-no this post on StackOverflow] for an explanation on the differences between the linear color space and the sRGB color space.
 {{HPL3SOMAScriptingCategories}}
 __FORCETOC__

@@ Line 1: / Line 1: @@
-Color channel values are stored using a 0.0 - 1.0 range, where 0.0 is equal to 0 and 1.0 is equal to 255.
+A four-channel color unit which stores float-based RGBA data. Color channel values are stored using a 0.0 - 1.0 range.
 == Constructors ==
@@ Line 36: / Line 34: @@
 ! Return Type !! Function Name !! Parameters !! Description
 |-
-| [[../cColor|<syntaxhighlight lang="c++" inline>cColor</syntaxhighlight>]] || ToLinearSpace || <syntaxhighlight lang="c++" inline>const float afPower,</syntaxhighlight><br /><syntaxhighlight lang="c++" inline>const bool abCorrectAlpha,</syntaxhighlight><br /><syntaxhighlight lang="c++" inline>const</syntaxhighlight> || Returns the color converted into the linear space.
+| [[../cColor|<syntaxhighlight lang="c++" inline>cColor</syntaxhighlight>]] || ToLinearSpace || <syntaxhighlight lang="c++" inline>const float afPower,</syntaxhighlight><br /><syntaxhighlight lang="c++" inline>const bool abCorrectAlpha,</syntaxhighlight><br /><syntaxhighlight lang="c++" inline>const</syntaxhighlight> || Returns the color converted into the linear space. (See remarks.)
 |-
-| [[../cColor|<syntaxhighlight lang="c++" inline>cColor</syntaxhighlight>]] || ToSRGB || <syntaxhighlight lang="c++" inline>const bool abCorrectAlpha,</syntaxhighlight><br /><syntaxhighlight lang="c++" inline>const</syntaxhighlight> || Returns the color converted into the [[wikipedia:sRGB|sRGB]] space.
+| [[../cColor|<syntaxhighlight lang="c++" inline>cColor</syntaxhighlight>]] || ToSRGB || <syntaxhighlight lang="c++" inline>const bool abCorrectAlpha,</syntaxhighlight><br /><syntaxhighlight lang="c++" inline>const</syntaxhighlight> || Returns the color converted into the [[wikipedia:sRGB|sRGB]] space. (See remarks.
 |}
-[[Category:HPL3]]
+== Remarks ==
-[[Category:HPL3 Scripting]]
-[[Category:HPL3 Classes]]
+Read [http://stackoverflow.com/questions/12524623/what-are-the-practical-differences-when-working-with-colors-in-a-linear-vs-a-no this post on StackOverflow] for an explanation on the differences between the linear color space and the sRGB color space.
 __FORCETOC__