Colour module

Typedefs
typedef struct lraspi_Colour	lraspi_Colour

Functions
lraspi_Colour *	lraspi_colour_new (uint8_t red, uint8_t green, uint8_t blue, uint8_t alpha)
	Creates a new colour object. More...
void	lraspi_colour_free (lraspi_Colour *colour)
	Releases the colour. More...
uint8_t	lraspi_colour_getredchannel (lraspi_Colour *colour)
	Gets the red channel value. More...
void	lraspi_colour_setredchannel (lraspi_Colour *colour, uint8_t red)
	Sets the red channel value. More...
uint8_t	lraspi_colour_getgreenchannel (lraspi_Colour *colour)
	Gets the green channel value. More...
void	lraspi_colour_setgreenchannel (lraspi_Colour *colour, uint8_t green)
	Sets the green channel value. More...
uint8_t	lraspi_colour_getbluechannel (lraspi_Colour *colour)
	Gets the blue channel value. More...
void	lraspi_colour_setbluechannel (lraspi_Colour *colour, uint8_t blue)
	Sets the blue channel value. More...
uint8_t	lraspi_colour_getalphachannel (lraspi_Colour *colour)
	Gets the alpha channel value. More...
void	lraspi_colour_setalphachannel (lraspi_Colour *colour, uint8_t alpha)
	Sets the alpha channel value. More...
void	lraspi_colour_setforeground (lraspi_Colour *colour)
	Sets the default foreground colour. More...
lraspi_Colour *	lraspi_colour_getforeground ()
	Gets the default foreground colour. More...
void	lraspi_colour_setbackground (lraspi_Colour *colour)
	Sets the default foreground colour. More...
lraspi_Colour *	lraspi_colour_getbackground ()
	Gets the default background colour. More...
const char *	lraspi_colour_tostring (lraspi_Colour *colour)
	Gets the string representation of the colour.

Detailed Description

Funtions to create, convert and modify colours

Typedef Documentation

lraspi_Colour

typedef struct lraspi_Colour lraspi_Colour

Represents a colour object.

Function Documentation

lraspi_colour_free()

void lraspi_colour_free

(

lraspi_Colour *

colour

)

Releases the colour.

Parameters

colour

The colour object which will be released.

lraspi_colour_getalphachannel()

uint8_t lraspi_colour_getalphachannel

(

lraspi_Colour *

colour

)

Gets the alpha channel value.

Parameters

colour

A colour object.

lraspi_colour_getbackground()

lraspi_Colour* lraspi_colour_getbackground

(

)

Gets the default background colour.

Returns

Current background colour.

lraspi_colour_getbluechannel()

uint8_t lraspi_colour_getbluechannel

(

lraspi_Colour *

colour

)

Gets the blue channel value.

Parameters

colour

A colour object.

lraspi_colour_getforeground()

lraspi_Colour* lraspi_colour_getforeground

(

)

Gets the default foreground colour.

Returns

Current foreground colour.

lraspi_colour_getgreenchannel()

uint8_t lraspi_colour_getgreenchannel

(

lraspi_Colour *

colour

)

Gets the green channel value.

Parameters

colour

A colour object.

lraspi_colour_getredchannel()

uint8_t lraspi_colour_getredchannel

(

lraspi_Colour *

colour

)

Gets the red channel value.

Parameters

colour

A colour object.

lraspi_colour_new()

lraspi_Colour* lraspi_colour_new	(	uint8_t	red,
		uint8_t	green,
		uint8_t	blue,
		uint8_t	alpha
	)

Creates a new colour object.

Parameters

red	The red channel value (0 - 255).
green	The green channel value (0 - 255).
blue	The blue channel value (0 - 255).
alpha	The alpha channel value (0 - 255).

lraspi_colour_setalphachannel()

void lraspi_colour_setalphachannel	(	lraspi_Colour *	colour,
		uint8_t	alpha
	)

Sets the alpha channel value.

Parameters

colour	A colour object.
alpha	The new value.

lraspi_colour_setbackground()

void lraspi_colour_setbackground

(

lraspi_Colour *

colour

)

Sets the default foreground colour.

Parameters

colour

A colour object. NULL to set the default foreground.

lraspi_colour_setbluechannel()

void lraspi_colour_setbluechannel	(	lraspi_Colour *	colour,
		uint8_t	blue
	)

Sets the blue channel value.

Parameters

colour	A colour object.
blue	The new value.

lraspi_colour_setforeground()

void lraspi_colour_setforeground

(

lraspi_Colour *

colour

)

Sets the default foreground colour.

Parameters

colour

A colour object. NULL to set the default foreground.

lraspi_colour_setgreenchannel()

void lraspi_colour_setgreenchannel	(	lraspi_Colour *	colour,
		uint8_t	green
	)

Sets the green channel value.

Parameters

colour	A colour object.
green	The new value.

lraspi_colour_setredchannel()

void lraspi_colour_setredchannel	(	lraspi_Colour *	colour,
		uint8_t	red
	)

Sets the red channel value.

Parameters

colour	A colour object.
red	The new value.