| Cogl Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | ||||
struct CoglColor; CoglColor * cogl_color_new (void); CoglColor * cogl_color_copy (const CoglColor *color);void cogl_color_free (CoglColor *color);void cogl_color_init_from_4f (CoglColor *color,,float red,float green,float blue);float alphavoid cogl_color_init_from_4fv (CoglColor *color,const);float *color_arrayvoid cogl_color_init_from_4ub (CoglColor *color,,uint8_t red,uint8_t green,uint8_t blue);uint8_t alphavoid cogl_color_set_from_4ub (CoglColor *color,,uint8_t red,uint8_t green,uint8_t blue);uint8_t alphavoid cogl_color_set_from_4f (CoglColor *color,,float red,float green,float blue);float alphafloat cogl_color_get_red (const CoglColor *color);float cogl_color_get_green (const CoglColor *color);float cogl_color_get_blue (const CoglColor *color);float cogl_color_get_alpha (const CoglColor *color); unsignedchar cogl_color_get_red_byte (const CoglColor *color); unsignedchar cogl_color_get_green_byte (const CoglColor *color); unsignedchar cogl_color_get_blue_byte (const CoglColor *color); unsignedchar cogl_color_get_alpha_byte (const CoglColor *color);float cogl_color_get_red_float (const CoglColor *color);float cogl_color_get_green_float (const CoglColor *color);float cogl_color_get_blue_float (const CoglColor *color);float cogl_color_get_alpha_float (const CoglColor *color);void cogl_color_set_red (CoglColor *color,);float redvoid cogl_color_set_green (CoglColor *color,);float greenvoid cogl_color_set_blue (CoglColor *color,);float bluevoid cogl_color_set_alpha (CoglColor *color,);float alphavoid cogl_color_set_red_byte (CoglColor *color,unsigned);char redvoid cogl_color_set_green_byte (CoglColor *color,unsigned);char greenvoid cogl_color_set_blue_byte (CoglColor *color,unsigned);char bluevoid cogl_color_set_alpha_byte (CoglColor *color,unsigned);char alphavoid cogl_color_set_red_float (CoglColor *color,);float redvoid cogl_color_set_green_float (CoglColor *color,);float greenvoid cogl_color_set_blue_float (CoglColor *color,);float bluevoid cogl_color_set_alpha_float (CoglColor *color,);float alphavoid cogl_color_premultiply (CoglColor *color);void cogl_color_unpremultiply (CoglColor *color);CoglBool cogl_color_equal (const,void *v1const);void *v2
CoglColor is a simple structure holding the definition of a color such that it can be efficiently used by GL
struct CoglColor {
};
A structure for holding a color definition. The contents of the CoglColor structure are private and should never by accessed directly.
Since 1.0
CoglColor * cogl_color_new (void);
Creates a new (empty) color
Returns : |
a newly-allocated CoglColor. Use cogl_color_free()
to free the allocated resources |
Since 1.0
CoglColor * cogl_color_copy (const CoglColor *color);
Creates a copy of color
|
the color to copy |
Returns : |
a newly-allocated CoglColor. Use cogl_color_free()
to free the allocate resources |
Since 1.0
void cogl_color_free (CoglColor *color);
Frees the resources allocated by cogl_color_new() and cogl_color_copy()
|
the color to free |
Since 1.0
void cogl_color_init_from_4f (CoglColor *color,,float red,float green,float blue);float alpha
Sets the values of the passed channels into a CoglColor
|
A pointer to a CoglColor to initialize |
|
value of the red channel, between 0 and 1.0 |
|
value of the green channel, between 0 and 1.0 |
|
value of the blue channel, between 0 and 1.0 |
|
value of the alpha channel, between 0 and 1.0 |
Since 1.4
void cogl_color_init_from_4fv (CoglColor *color,const);float *color_array
Sets the values of the passed channels into a CoglColor
|
A pointer to a CoglColor to initialize |
|
a pointer to an array of 4 float color components |
Since 1.4
void cogl_color_init_from_4ub (CoglColor *color,,uint8_t red,uint8_t green,uint8_t blue);uint8_t alpha
Sets the values of the passed channels into a CoglColor.
|
A pointer to a CoglColor to initialize |
|
value of the red channel, between 0 and 255 |
|
value of the green channel, between 0 and 255 |
|
value of the blue channel, between 0 and 255 |
|
value of the alpha channel, between 0 and 255 |
Since 1.4
void cogl_color_set_from_4ub (CoglColor *color,,uint8_t red,uint8_t green,uint8_t blue);uint8_t alpha
cogl_color_set_from_4ub has been deprecated since version 1.4 and should not be used in newly-written code. Use cogl_color_init_from_4ub instead.
Sets the values of the passed channels into a CoglColor.
|
A pointer to a CoglColor to initialize |
|
value of the red channel, between 0 and 255 |
|
value of the green channel, between 0 and 255 |
|
value of the blue channel, between 0 and 255 |
|
value of the alpha channel, between 0 and 255 |
Since 1.0
void cogl_color_set_from_4f (CoglColor *color,,float red,float green,float blue);float alpha
cogl_color_set_from_4f has been deprecated since version 1.4 and should not be used in newly-written code. Use cogl_color_init_from_4f instead.
Sets the values of the passed channels into a CoglColor
|
A pointer to a CoglColor to initialize |
|
value of the red channel, between 0 and 1 |
|
value of the green channel, between 0 and 1 |
|
value of the blue channel, between 0 and 1 |
|
value of the alpha channel, between 0 and 1 |
Since 1.0
float cogl_color_get_red (const CoglColor *color);
Retrieves the red channel of color as a fixed point
value between 0 and 1.0.
|
a CoglColor |
Returns : |
the red channel of the passed color |
Since 1.0
float cogl_color_get_green (const CoglColor *color);
Retrieves the green channel of color as a fixed point
value between 0 and 1.0.
|
a CoglColor |
Returns : |
the green channel of the passed color |
Since 1.0
float cogl_color_get_blue (const CoglColor *color);
Retrieves the blue channel of color as a fixed point
value between 0 and 1.0.
|
a CoglColor |
Returns : |
the blue channel of the passed color |
Since 1.0
float cogl_color_get_alpha (const CoglColor *color);
Retrieves the alpha channel of color as a fixed point
value between 0 and 1.0.
|
a CoglColor |
Returns : |
the alpha channel of the passed color |
Since 1.0
unsignedchar cogl_color_get_red_byte (const CoglColor *color);
Retrieves the red channel of color as a byte value
between 0 and 255
|
a CoglColor |
Returns : |
the red channel of the passed color |
Since 1.0
unsignedchar cogl_color_get_green_byte (const CoglColor *color);
Retrieves the green channel of color as a byte value
between 0 and 255
|
a CoglColor |
Returns : |
the green channel of the passed color |
Since 1.0
unsignedchar cogl_color_get_blue_byte (const CoglColor *color);
Retrieves the blue channel of color as a byte value
between 0 and 255
|
a CoglColor |
Returns : |
the blue channel of the passed color |
Since 1.0
unsignedchar cogl_color_get_alpha_byte (const CoglColor *color);
Retrieves the alpha channel of color as a byte value
between 0 and 255
|
a CoglColor |
Returns : |
the alpha channel of the passed color |
Since 1.0
float cogl_color_get_red_float (const CoglColor *color);
Retrieves the red channel of color as a floating point
value between 0.0 and 1.0
|
a CoglColor |
Returns : |
the red channel of the passed color |
Since 1.0
float cogl_color_get_green_float (const CoglColor *color);
Retrieves the green channel of color as a floating point
value between 0.0 and 1.0
|
a CoglColor |
Returns : |
the green channel of the passed color |
Since 1.0
float cogl_color_get_blue_float (const CoglColor *color);
Retrieves the blue channel of color as a floating point
value between 0.0 and 1.0
|
a CoglColor |
Returns : |
the blue channel of the passed color |
Since 1.0
float cogl_color_get_alpha_float (const CoglColor *color);
Retrieves the alpha channel of color as a floating point
value between 0.0 and 1.0
|
a CoglColor |
Returns : |
the alpha channel of the passed color |
Since 1.0
void cogl_color_set_red (CoglColor *color,);float red
Sets the red channel of color to red.
|
a CoglColor |
|
a float value between 0.0f and 1.0f |
Since 1.4
void cogl_color_set_green (CoglColor *color,);float green
Sets the green channel of color to green.
|
a CoglColor |
|
a float value between 0.0f and 1.0f |
Since 1.4
void cogl_color_set_blue (CoglColor *color,);float blue
Sets the blue channel of color to blue.
|
a CoglColor |
|
a float value between 0.0f and 1.0f |
Since 1.4
void cogl_color_set_alpha (CoglColor *color,);float alpha
Sets the alpha channel of color to alpha.
|
a CoglColor |
|
a float value between 0.0f and 1.0f |
Since 1.4
void cogl_color_set_red_byte (CoglColor *color,unsigned);char red
Sets the red channel of color to red.
|
a CoglColor |
|
a byte value between 0 and 255 |
Since 1.4
void cogl_color_set_green_byte (CoglColor *color,unsigned);char green
Sets the green channel of color to green.
|
a CoglColor |
|
a byte value between 0 and 255 |
Since 1.4
void cogl_color_set_blue_byte (CoglColor *color,unsigned);char blue
Sets the blue channel of color to blue.
|
a CoglColor |
|
a byte value between 0 and 255 |
Since 1.4
void cogl_color_set_alpha_byte (CoglColor *color,unsigned);char alpha
Sets the alpha channel of color to alpha.
|
a CoglColor |
|
a byte value between 0 and 255 |
Since 1.4
void cogl_color_set_red_float (CoglColor *color,);float red
Sets the red channel of color to red.
|
a CoglColor |
|
a float value between 0.0f and 1.0f |
Since 1.4
void cogl_color_set_green_float (CoglColor *color,);float green
Sets the green channel of color to green.
|
a CoglColor |
|
a float value between 0.0f and 1.0f |
Since 1.4
void cogl_color_set_blue_float (CoglColor *color,);float blue
Sets the blue channel of color to blue.
|
a CoglColor |
|
a float value between 0.0f and 1.0f |
Since 1.4
void cogl_color_set_alpha_float (CoglColor *color,);float alpha
Sets the alpha channel of color to alpha.
|
a CoglColor |
|
a float value between 0.0f and 1.0f |
Since 1.4
void cogl_color_premultiply (CoglColor *color);
Converts a non-premultiplied color to a pre-multiplied color. For example, semi-transparent red is (1.0, 0, 0, 0.5) when non-premultiplied and (0.5, 0, 0, 0.5) when premultiplied.
|
the color to premultiply |
Since 1.0
void cogl_color_unpremultiply (CoglColor *color);
Converts a pre-multiplied color to a non-premultiplied color. For example, semi-transparent red is (0.5, 0, 0, 0.5) when premultiplied and (1.0, 0, 0, 0.5) when non-premultiplied.
|
the color to unpremultiply |
Since 1.4