Difference between revisions of "HPL3/SOMA/Scripting/cColor"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
| − | Color channel values are stored using a 0.0 - 1.0 range | + | A four-channel color unit which stores float-based RGBA data. Color channel values are stored using a 0.0 - 1.0 range. |
| − | |||
| − | |||
== Constructors == | == Constructors == | ||
| Line 36: | Line 34: | ||
! 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. | + | | [[../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. |
|} | |} | ||
| − | [ | + | == Remarks == |
| − | + | ||
| − | + | 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__ | __FORCETOC__ | ||
Revision as of 02:02, 4 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.
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. (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.