Engrave_Spectrum: Functions to work with engrave spectrum objects
Data Structures | |
struct | _Engrave_Spectrum |
Stores the needed spectrum information. More... | |
struct | _Engrave_Spectrum_Color |
Stores the spectrum color information. More... | |
Typedefs | |
typedef _Engrave_Spectrum | Engrave_Spectrum |
The Engrave_Spectrum typedef. | |
Functions | |
EAPI Engrave_Spectrum * | engrave_spectrum_new () |
engrave_spectrum_new - create a new Engrave_Spectrum object | |
EAPI void | engrave_spectrum_free (Engrave_Spectrum *es) |
engrave_spectrum_free - frees a Engrave_Spectrum object | |
EAPI Engrave_Spectrum_Color * | engrave_spectrum_color_new (int r, int g, int b, int a, int d) |
engrave_spectrum_color_new - Creates an Engrave_Spectrum_Color object | |
EAPI void | engrave_spectrum_color_free (Engrave_Spectrum_Color *esc) |
engrave_spectrum_color_free - frees a Engrave_Spectrum_Color object | |
EAPI void | engrave_spectrum_parent_set (Engrave_Spectrum *es, void *parent) |
engrave_spectrum_parent_set - sets the parent of the Engrave_Spectrum object | |
EAPI void | engrave_spectrum_color_add (Engrave_Spectrum *spec, Engrave_Spectrum_Color *col) |
engrave_spectrum_color_add - Adds a color to a Engrave_Spectrum object | |
EAPI void | engrave_spectrum_color_del (Engrave_Spectrum *spec, Engrave_Spectrum_Color *col) |
engrave_spectrum_color_del - Removes a color from a Engrave_Spectrum object | |
EAPI const char * | engrave_spectrum_name_get (Engrave_Spectrum *es) |
engrave_spectrum_name_get - gets the name of the Engrave_Spectrum object | |
EAPI void | engrave_spectrum_name_set (Engrave_Spectrum *es, const char *name) |
engrave_spectrum_name_set - sets the name of the Engrave_Spectrum object | |
EAPI int | engrave_spectrum_color_count (Engrave_Spectrum *es) |
engrave_spectrum_color_count - returns the number of colors inside an Engrave_Spectrum object | |
EAPI Engrave_Spectrum_Color * | engrave_spectrum_color_nth (Engrave_Spectrum *es, int n) |
engrave_spectrum_color_nth - gets the nth color of the Engrave_Spectrum object |
Function Documentation
EAPI void engrave_spectrum_color_add | ( | Engrave_Spectrum * | es, | |
Engrave_Spectrum_Color * | col | |||
) |
engrave_spectrum_color_add - Adds a color to a Engrave_Spectrum object
- Parameters:
-
es,: The spectrum object to add to col,: The Engrave_Spectrum_Color object to add
- Returns:
- Returns no value
EAPI int engrave_spectrum_color_count | ( | Engrave_Spectrum * | es | ) |
engrave_spectrum_color_count - returns the number of colors inside an Engrave_Spectrum object
- Parameters:
-
es,: The spectrum object
- Returns:
- Returns the number of colors
EAPI void engrave_spectrum_color_del | ( | Engrave_Spectrum * | es, | |
Engrave_Spectrum_Color * | col | |||
) |
engrave_spectrum_color_del - Removes a color from a Engrave_Spectrum object
- Parameters:
-
es,: The spectrum object to remove from col,: The Engrave_Spectrum_Color object to remove
- Returns:
- Returns no value
EAPI void engrave_spectrum_color_free | ( | Engrave_Spectrum_Color * | esc | ) |
engrave_spectrum_color_free - frees a Engrave_Spectrum_Color object
- Parameters:
-
esc,: The spectrum color object to free
- Returns:
- Returns no value
EAPI Engrave_Spectrum_Color* engrave_spectrum_color_new | ( | int | r, | |
int | g, | |||
int | b, | |||
int | a, | |||
int | d | |||
) |
engrave_spectrum_color_new - Creates an Engrave_Spectrum_Color object
- Parameters:
-
r,: The red value g,: The green value b,: The blue value a,: The alpha value d,: TBD
- Returns:
- Returns a new Engrave_Spectrum_Color object
EAPI Engrave_Spectrum_Color* engrave_spectrum_color_nth | ( | Engrave_Spectrum * | es, | |
int | n | |||
) |
engrave_spectrum_color_nth - gets the nth color of the Engrave_Spectrum object
- Parameters:
-
es,: The spectrum object n,: The nth color to get
- Returns:
- Returns the nth Engrave_Spectrum_Color of the object
EAPI void engrave_spectrum_free | ( | Engrave_Spectrum * | es | ) |
engrave_spectrum_free - frees a Engrave_Spectrum object
- Parameters:
-
es,: The spectrum object to free
- Returns:
- Returns no value
EAPI const char* engrave_spectrum_name_get | ( | Engrave_Spectrum * | es | ) |
engrave_spectrum_name_get - gets the name of the Engrave_Spectrum object
- Parameters:
-
es,: The spectrum object
- Returns:
- Returns the name of the object
EAPI void engrave_spectrum_name_set | ( | Engrave_Spectrum * | es, | |
const char * | name | |||
) |
engrave_spectrum_name_set - sets the name of the Engrave_Spectrum object
- Parameters:
-
es,: The spectrum object name,: The name to set
- Returns:
- Returns no value
EAPI Engrave_Spectrum* engrave_spectrum_new | ( | ) |
engrave_spectrum_new - create a new Engrave_Spectrum object
- Returns:
- Returns a pointer to a newly allocated object on success, or NULL
EAPI void engrave_spectrum_parent_set | ( | Engrave_Spectrum * | es, | |
void * | parent | |||
) |
engrave_spectrum_parent_set - sets the parent of the Engrave_Spectrum object
- Parameters:
-
es,: The spectrum object parent,: The parent of the spectrum object
- Returns:
- Returns no value