A color.
More...
Create a copy of this object.
- Returns
- The new object.
Create a new gray-scale color object.
- Parameters
-
[in] | aIntensity | The intensity (0 through 255, 0 is black). |
- Returns
- The new color object.
static SignDocColor createRGB |
( |
byte |
aRed, |
|
|
uint char |
aGreen, |
|
|
unsigned char |
aBlue |
|
) |
| |
|
static |
Create a new RGB color object.
The values are in 0 through 255, 0 is black.
- Parameters
-
[in] | aRed | The value of the red channel. |
[in] | aGreen | The value of the green channel. |
[in] | aBlue | The value of the blue channel. |
- Returns
- The new color object.
Create a new RGB color object.
- Parameters
-
[in] | aRGB | 0x00rrggbb (rr is the red component, gg is the green component, bb is the blue component). |
- Returns
- The new color object.
Get the blue component of an RGB color object.
- Returns
- The blue component (0 through 255, 0 is black) of an RGB color object, undefined for other color types.
byte getComponent |
( |
int |
aIndex | ) |
|
Get one color component (channel).
- Parameters
-
[in] | aIndex | The index of the color component (0 through 2). The meaning depends on the color type. |
- Returns
- The value (0 through 255) of the color component aIndex or 0 if aIndex is out of range.
Get the green component of an RGB color object.
- Returns
- The green component (0 through 255, 0 is black) of an RGB color object, undefined for other color types.
Get the intensity of a gray-scale color object.
- Returns
- The intensity (0 through 255, 0 is black) for a gray-scale color object, undefined for other color types.
int getNumberOfComponents |
( |
| ) |
|
Get the number of color components (channels).
- Returns
- 1 for gray scale, 3 for RGB.
Get the red component of an RGB color object.
- Returns
- The red component (0 through 255, 0 is black) of an RGB color object, undefined for other color types.
Get the color as integer (0x00rrggbb).
rr is the red component, gg is the green component, bb is the blue component.
- Returns
- The color as integer (0x00rrggbb).
Get the color type of this object.
- Returns
- The color type.
The documentation for this class was generated from the following file: