Difference between revisions of "HPL3/SOMA/Scripting/cColor"

From Frictional Wiki
< HPL3‎ | SOMA‎ | Scripting
Jump to navigation Jump to search
 
(2 intermediate revisions by the same user not shown)
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.
−
 
 
−
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 ==
 
== Constructors ==
Line 8: Line 6:
 
! Constructor !! Description
 
! 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 20:
 
! Field Name !! Type !! Description
 
! 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 34:
 
! Return Type !! Function Name !! Parameters !! Description
 
! 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. (See remarks.)
−
const bool abCorrectAlpha,
 
−
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. (See remarks.
−
const</syntaxhighlight> || Returns the color converted into the [[wikipedia:sRGB|sRGB]] space.
 
 
|}
 
|}
  
−
[[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.
 +
 
 +
{{ReferencesSection}}
 +
 
 +
{{HPL3SOMAScriptingCategories}}
 
__FORCETOC__
 
__FORCETOC__

Latest revision as of 14:25, 6 August 2020

A four-channel color unit which stores float-based RGBA data. Color channel values are stored using a 0.0 - 1.0 range.

Constructors

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

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

Return Type Function Name Parameters Description
cColor ToLinearSpace const float afPower,
const bool abCorrectAlpha,
const		 Returns the color converted into the linear space. (See remarks.)
cColor ToSRGB const bool abCorrectAlpha,
const		 Returns the color converted into the sRGB space. (See remarks.

Remarks

Read this post on StackOverflow for an explanation on the differences between the linear color space and the sRGB color space.

References

See all references...

Retrieved from "https://wiki.frictionalgames.com/page?title=HPL3/SOMA/Scripting/cColor&oldid=3544"