A color.
More...
#include <SignDocSDK-c.h>
A color.
Use the static factory functions SIGNDOC_Color_createGray(), SIGNDOC_Color_createRGB(), and SIGNDOC_Color_createRGB1() to create SIGNDOC_Color objects. Do not forget to destroy the objects after use.
Create a copy of a SIGNDOC_Color object.
Do not forget to destroy the copy after use.
- Parameters
-
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aObj | A pointer to the SIGNDOC_Color object. |
- Returns
- A pointer to the new object.
Create a new gray-scale color object.
- Parameters
-
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aIntensity | The intensity (0 through 255, 0 is black). |
- Returns
- A pointer to the new color object. Do not forget to destroy the object after use.
Create a new RGB color object.
The values are in 0 through 255, 0 is black.
- Parameters
-
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[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
- A pointer to the new color object. Do not forget to destroy the object after use.
Create a new RGB color object from a single integer.
- Parameters
-
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |
[in] | aRGB | 0x00rrggbb (rr is the red component, gg is the green component, bb is the blue component). |
- Returns
- A pointer to the new color object. Do not forget to destroy the object after use.
unsigned char SIGNDOC_Color_getBlue |
( |
const struct SIGNDOC_Color * |
aObj | ) |
|
Get the blue component of an RGB color object.
- Parameters
-
- Returns
- The blue component (0 through 255, 0 is black) of an RGB color object, undefined for other color types.
unsigned char SIGNDOC_Color_getComponent |
( |
const struct SIGNDOC_Color * |
aObj, |
|
|
unsigned |
aIndex |
|
) |
| |
Get one color component (channel).
- Parameters
-
[in] | aObj | A pointer to the SIGNDOC_Color object. |
[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.
unsigned char SIGNDOC_Color_getGreen |
( |
const struct SIGNDOC_Color * |
aObj | ) |
|
Get the green component of an RGB color object.
- Parameters
-
- Returns
- The green component (0 through 255, 0 is black) of an RGB color object, undefined for other color types.
unsigned char SIGNDOC_Color_getIntensity |
( |
const struct SIGNDOC_Color * |
aObj | ) |
|
Get the intensity of a gray-scale color object.
- Parameters
-
- Returns
- The intensity (0 through 255, 0 is black) for a gray-scale color object, undefined for other color types.
unsigned SIGNDOC_Color_getNumberOfComponents |
( |
const struct SIGNDOC_Color * |
aObj | ) |
|
Get the number of color components (channels).
- Parameters
-
- Returns
- 1 for gray scale, 3 for RGB.
unsigned char SIGNDOC_Color_getRed |
( |
const struct SIGNDOC_Color * |
aObj | ) |
|
Get the red component of an RGB color object.
- Parameters
-
- Returns
- The red component (0 through 255, 0 is black) of an RGB color object, undefined for other color types.
unsigned SIGNDOC_Color_getRGB |
( |
const struct SIGNDOC_Color * |
aObj | ) |
|
Get the color as integer (0x00rrggbb).
rr is the red component, gg is the green component, bb is the blue component.
- Parameters
-
The documentation for this class was generated from the following file: