Floating point color description class (for float).
More...
#include <color.h>
List of all members.
Public Member Functions |
|
|
| CL_Colorf () |
| Constructs a color.
|
| CL_Colorf (float r, float g, float b, float a=1.0f) |
| Constructs a color.
|
| CL_Colorf (const float *array_rgba) |
| Constructs a color.
|
| CL_Colorf (unsigned char r, unsigned char g, unsigned char b, unsigned char a=255) |
| Constructs a color.
|
| CL_Colorf (int r, int g, int b, int a=255) |
| Constructs a color.
|
| CL_Colorf (const CL_Color &color) |
| CL_Colorf (const CL_StringRef &hexstr) |
| Constructs a color.
|
|
|
void | normalize () |
| Normalize the color by ensuring that all color values lie inbetween (0.0, 1.0).
|
void | set_alpha (float value) |
| Set alpha color component, in the range 0-1.
|
void | set_red (float value) |
| Set red color component, in the range 0-1.
|
void | set_green (float value) |
| Set green color component, in the range 0-1.
|
void | set_blue (float value) |
| Set blue color component, in the range 0-1.
|
bool | operator== (const CL_Colorf &c) const |
| Color == Color operator (deep compare).
|
bool | operator!= (const CL_Colorf &c) const |
| Color != Color operator (deep compare).
|
| operator CL_Color () const |
| Type conversion operator.
|
Static Public Attributes |
|
|
static CL_Colorf | aliceblue |
static CL_Colorf | antiquewhite |
static CL_Colorf | aqua |
static CL_Colorf | aquamarine |
static CL_Colorf | azure |
static CL_Colorf | beige |
static CL_Colorf | bisque |
static CL_Colorf | black |
static CL_Colorf | blanchedalmond |
static CL_Colorf | blue |
static CL_Colorf | blueviolet |
static CL_Colorf | brown |
static CL_Colorf | burlywood |
static CL_Colorf | cadetblue |
static CL_Colorf | chartreuse |
static CL_Colorf | chocolate |
static CL_Colorf | coral |
static CL_Colorf | cornflowerblue |
static CL_Colorf | cornsilk |
static CL_Colorf | crimson |
static CL_Colorf | cyan |
static CL_Colorf | darkblue |
static CL_Colorf | darkcyan |
static CL_Colorf | darkgoldenrod |
static CL_Colorf | darkgray |
static CL_Colorf | darkgreen |
static CL_Colorf | darkgrey |
static CL_Colorf | darkkhaki |
static CL_Colorf | darkmagenta |
static CL_Colorf | darkolivegreen |
static CL_Colorf | darkorange |
static CL_Colorf | darkorchid |
static CL_Colorf | darkred |
static CL_Colorf | darksalmon |
static CL_Colorf | darkseagreen |
static CL_Colorf | darkslateblue |
static CL_Colorf | darkslategray |
static CL_Colorf | darkslategrey |
static CL_Colorf | darkturquoise |
static CL_Colorf | darkviolet |
static CL_Colorf | deeppink |
static CL_Colorf | deepskyblue |
static CL_Colorf | dimgray |
static CL_Colorf | dimgrey |
static CL_Colorf | dodgerblue |
static CL_Colorf | firebrick |
static CL_Colorf | floralwhite |
static CL_Colorf | forestgreen |
static CL_Colorf | fuchsia |
static CL_Colorf | gainsboro |
static CL_Colorf | ghostwhite |
static CL_Colorf | gold |
static CL_Colorf | goldenrod |
static CL_Colorf | gray |
static CL_Colorf | grey |
static CL_Colorf | green |
static CL_Colorf | greenyellow |
static CL_Colorf | honeydew |
static CL_Colorf | hotpink |
static CL_Colorf | indianred |
static CL_Colorf | indigo |
static CL_Colorf | ivory |
static CL_Colorf | khaki |
static CL_Colorf | lavender |
static CL_Colorf | lavenderblush |
static CL_Colorf | lawngreen |
static CL_Colorf | lemonchiffon |
static CL_Colorf | lightblue |
static CL_Colorf | lightcoral |
static CL_Colorf | lightcyan |
static CL_Colorf | lightgoldenrodyellow |
static CL_Colorf | lightgray |
static CL_Colorf | lightgreen |
static CL_Colorf | lightgrey |
static CL_Colorf | lightpink |
static CL_Colorf | lightsalmon |
static CL_Colorf | lightseagreen |
static CL_Colorf | lightskyblue |
static CL_Colorf | lightslategray |
static CL_Colorf | lightslategrey |
static CL_Colorf | lightsteelblue |
static CL_Colorf | lightyellow |
static CL_Colorf | lime |
static CL_Colorf | limegreen |
static CL_Colorf | linen |
static CL_Colorf | magenta |
static CL_Colorf | maroon |
static CL_Colorf | mediumaquamarine |
static CL_Colorf | mediumblue |
static CL_Colorf | mediumorchid |
static CL_Colorf | mediumpurple |
static CL_Colorf | mediumseagreen |
static CL_Colorf | mediumslateblue |
static CL_Colorf | mediumspringgreen |
static CL_Colorf | mediumturquoise |
static CL_Colorf | mediumvioletred |
static CL_Colorf | midnightblue |
static CL_Colorf | mintcream |
static CL_Colorf | mistyrose |
static CL_Colorf | moccasin |
static CL_Colorf | navajowhite |
static CL_Colorf | navy |
static CL_Colorf | oldlace |
static CL_Colorf | olive |
static CL_Colorf | olivedrab |
static CL_Colorf | orange |
static CL_Colorf | orangered |
static CL_Colorf | orchid |
static CL_Colorf | palegoldenrod |
static CL_Colorf | palegreen |
static CL_Colorf | paleturquoise |
static CL_Colorf | palevioletred |
static CL_Colorf | papayawhip |
static CL_Colorf | peachpuff |
static CL_Colorf | peru |
static CL_Colorf | pink |
static CL_Colorf | plum |
static CL_Colorf | powderblue |
static CL_Colorf | purple |
static CL_Colorf | red |
static CL_Colorf | rosybrown |
static CL_Colorf | royalblue |
static CL_Colorf | saddlebrown |
static CL_Colorf | salmon |
static CL_Colorf | sandybrown |
static CL_Colorf | seagreen |
static CL_Colorf | seashell |
static CL_Colorf | sienna |
static CL_Colorf | silver |
static CL_Colorf | skyblue |
static CL_Colorf | slateblue |
static CL_Colorf | slategray |
static CL_Colorf | slategrey |
static CL_Colorf | snow |
static CL_Colorf | springgreen |
static CL_Colorf | steelblue |
static CL_Colorf | tan |
static CL_Colorf | teal |
static CL_Colorf | thistle |
static CL_Colorf | tomato |
static CL_Colorf | turquoise |
static CL_Colorf | violet |
static CL_Colorf | wheat |
static CL_Colorf | white |
static CL_Colorf | whitesmoke |
static CL_Colorf | yellow |
static CL_Colorf | yellowgreen |
static CL_Colorf | transparent |
| rgba(0, 0, 0, 0).
|
static CL_Colorf | gray10 |
static CL_Colorf | gray20 |
static CL_Colorf | gray30 |
static CL_Colorf | gray40 |
static CL_Colorf | gray50 |
static CL_Colorf | gray60 |
static CL_Colorf | gray70 |
static CL_Colorf | gray80 |
static CL_Colorf | gray90 |
Attributes |
|
float | r |
float | g |
float | b |
float | a |
float | get_red () const |
| Get Red.
|
float | get_green () const |
| Get Green.
|
float | get_blue () const |
| Get Blue.
|
float | get_alpha () const |
| Get Alpha.
|
Detailed Description
Floating point color description class (for float).
Constructor & Destructor Documentation
CL_Colorf::CL_Colorf |
( |
|
) |
[inline] |
CL_Colorf::CL_Colorf |
( |
float |
r, |
|
|
float |
g, |
|
|
float |
b, |
|
|
float |
a = 1.0f | |
|
) |
| | [inline] |
Constructs a color.
Color components are specified in the range 0 to 1.
An alpha value of 0 means complete transparency, while 1 means completely opaque (solid).
- Parameters:
-
| r | = Red color component. |
| g | = Green color component. |
| b | = Blue color component. |
| a | = Alpha (transparency) color component. |
CL_Colorf::CL_Colorf |
( |
const float * |
array_rgba |
) |
[inline] |
Constructs a color.
Color components are specified in the range 0 to 1.
An alpha value of 0 means complete transparency, while 1 means completely opaque (solid).
- Parameters:
-
| array_rgba | = Red,Green,Blue,Alpha color component. |
CL_Colorf::CL_Colorf |
( |
unsigned char |
r, |
|
|
unsigned char |
g, |
|
|
unsigned char |
b, |
|
|
unsigned char |
a = 255 | |
|
) |
| | [inline] |
Constructs a color.
Color components are specified in the range 0 to 255.
An alpha value of 0 means complete transparency, while 255 means completely opaque (solid).
- Parameters:
-
| r | = Red color component. |
| g | = Green color component. |
| b | = Blue color component. |
| a | = Alpha (transparency) color component. |
CL_Colorf::CL_Colorf |
( |
int |
r, |
|
|
int |
g, |
|
|
int |
b, |
|
|
int |
a = 255 | |
|
) |
| | [inline] |
Constructs a color.
Color components are specified in the range 0 to 255.
An alpha value of 0 means complete transparency, while 255 means completely opaque (solid).
- Parameters:
-
| r | = Red color component. |
| g | = Green color component. |
| b | = Blue color component. |
| a | = Alpha (transparency) color component. |
CL_Colorf::CL_Colorf |
( |
const CL_Color & |
color |
) |
[inline, explicit] |
CL_Colorf::CL_Colorf |
( |
const CL_StringRef & |
hexstr |
) |
[inline] |
Constructs a color.
Color components are specified in the range 0 to 255.
An alpha value of 0 means complete transparency, while 255 means completely opaque (solid).
- Parameters:
-
| hexstr | The colors rgba components as a hexadecimal string of the format "#rrggbbaa", where the '#' and "aa" parts are optional. |
References CL_Color::find_color().
Member Function Documentation
float CL_Colorf::get_alpha |
( |
|
) |
const [inline] |
Get Alpha.
- Returns:
- alpha
References a.
float CL_Colorf::get_blue |
( |
|
) |
const [inline] |
Get Blue.
- Returns:
- blue
References b.
float CL_Colorf::get_green |
( |
|
) |
const [inline] |
Get Green.
- Returns:
- green
References g.
float CL_Colorf::get_red |
( |
|
) |
const [inline] |
Get Red.
- Returns:
- red
References r.
void CL_Colorf::normalize |
( |
|
) |
[inline] |
Normalize the color by ensuring that all color values lie inbetween (0.0, 1.0).
References a, b, g, and r.
CL_Colorf::operator CL_Color |
( |
|
) |
const [inline] |
Type conversion operator.
bool CL_Colorf::operator!= |
( |
const CL_Colorf & |
c |
) |
const [inline] |
Color != Color operator (deep compare).
References a, b, g, and r.
bool CL_Colorf::operator== |
( |
const CL_Colorf & |
c |
) |
const [inline] |
Color == Color operator (deep compare).
References a, b, g, and r.
void CL_Colorf::set_alpha |
( |
float |
value |
) |
[inline] |
Set alpha color component, in the range 0-1.
References a.
void CL_Colorf::set_blue |
( |
float |
value |
) |
[inline] |
Set blue color component, in the range 0-1.
References b.
void CL_Colorf::set_green |
( |
float |
value |
) |
[inline] |
Set green color component, in the range 0-1.
References g.
void CL_Colorf::set_red |
( |
float |
value |
) |
[inline] |
Set red color component, in the range 0-1.
References r.
Member Data Documentation
The documentation for this class was generated from the following file: