Difference between revisions of "HPL3/SOMA/Scripting/cColor"
Jump to navigation
Jump to search
| Line 8: | Line 8: | ||
! 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 22: | ||
! 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 36: | ||
! Return Type !! Function Name !! Parameters !! Description | ! 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. |
| − | const bool abCorrectAlpha, | ||
| − | const</syntaxhighlight> || Returns the color converted into the linear 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. |
| − | const</syntaxhighlight> || Returns the color converted into the [[wikipedia:sRGB|sRGB]] space. | ||
|} | |} | ||
Revision as of 22:08, 3 August 2020
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 this post on StackOverflow for an explanation on the differences between the linear color space and the sRGB color space.
Contents
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. |
cColor |
ToSRGB | const bool abCorrectAlpha,const |
Returns the color converted into the sRGB space. |