Engrave_Program: Functions to work with Engrave_Program objects.
Data Structures | |
struct | _Engrave_Program |
Contains all the info to define a program. More... | |
Typedefs | |
typedef _Engrave_Program | Engrave_Program |
The Engrave_Program typedef. | |
Functions | |
EAPI Engrave_Program * | engrave_program_new (void) |
engrave_program_new - create a new Engrave_Program object. | |
EAPI void | engrave_program_free (Engrave_Program *ep) |
engrave_program_free - free the program | |
EAPI void | engrave_program_parent_set (Engrave_Program *ep, void *eg) |
engrave_program_parent_set - set the parent of the program | |
EAPI void * | engrave_program_parent_get (Engrave_Program *ep) |
engrave_program_parent_get - get the parent pointer | |
EAPI void | engrave_program_script_set (Engrave_Program *ep, const char *script) |
engrave_program_script_set - attach a script to the program. | |
EAPI void | engrave_program_name_set (Engrave_Program *ep, const char *name) |
engrave_program_name_set - set the name of the program. | |
EAPI void | engrave_program_signal_set (Engrave_Program *ep, const char *signal) |
engrave_program_signal_set - set the given signal on the program | |
EAPI void | engrave_program_source_set (Engrave_Program *ep, const char *source) |
engrave_program_source_set - set the source of the program. | |
EAPI void | engrave_program_target_add (Engrave_Program *ep, const char *target) |
engrave_program_target_add - set the target on the program. | |
EAPI void | engrave_program_after_add (Engrave_Program *ep, const char *after) |
engrave_program_after_add - add the after to the program. | |
EAPI void | engrave_program_in_set (Engrave_Program *ep, double from, double range) |
engrave_program_in_set - set the in value of the program. | |
EAPI void | engrave_program_action_set (Engrave_Program *ep, Engrave_Action action, const char *state, const char *state2, double value, double value2) |
engrave_program_action_set - set the action for the program. | |
EAPI void | engrave_program_transition_set (Engrave_Program *ep, Engrave_Transition trans, double duration) |
engrave_program_transition_set - set the transition on the program | |
EAPI const char * | engrave_program_name_get (Engrave_Program *ep) |
engrave_program_name_get - Get the program name | |
EAPI const char * | engrave_program_signal_get (Engrave_Program *ep) |
engrave_program_signal_get - Get the program signal | |
EAPI const char * | engrave_program_source_get (Engrave_Program *ep) |
engrave_program_source_get - Get the program source | |
EAPI void | engrave_program_action_get (Engrave_Program *ep, Engrave_Action *action, char *state, char *state2, int state_len, int state2_len, double *value, double *value2) |
engrave_program_action_get - Get the action information for the program | |
EAPI void | engrave_program_transition_get (Engrave_Program *ep, Engrave_Transition *trans, double *duration) |
engrave_program_transition_get - Get the programs transition information | |
EAPI const char * | engrave_program_script_get (Engrave_Program *ep) |
engrave_program_script_get - Get the script from the program | |
EAPI void | engrave_program_in_get (Engrave_Program *ep, double *from, double *range) |
engrave_program_in_get - Get the in data for the program | |
EAPI int | engrave_program_afters_count (Engrave_Program *ep) |
engrave_program_afters_count - get the number of afters | |
EAPI int | engrave_program_targets_count (Engrave_Program *ep) |
engrave_program_targets_count - count the number of targets | |
EAPI void | engrave_program_target_foreach (Engrave_Program *ep, void(*func)(const char *, void *), void *data) |
engrave_program_target_foreach - Iterate over each target | |
EAPI void | engrave_program_after_foreach (Engrave_Program *ep, void(*func)(const char *, void *), void *data) |
engrave_program_after_foreach - Iterate over each after |
Function Documentation
EAPI void engrave_program_action_get | ( | Engrave_Program * | ep, | |
Engrave_Action * | action, | |||
char * | state, | |||
char * | state2, | |||
int | state_len, | |||
int | state2_len, | |||
double * | value, | |||
double * | value2 | |||
) |
engrave_program_action_get - Get the action information for the program
- Parameters:
-
ep,: The Engrave_Program to get the action information from action,: Where to store the action setting state,: Buffer to put state into state2,: Buffer to put state2 into state_len,: The length of the state buffer state2_len,: The length of the state2 buffer value,: Where to put the value setting value2,: Where to put the value2 setting
- Returns:
- Returns no value.
EAPI void engrave_program_action_set | ( | Engrave_Program * | ep, | |
Engrave_Action | action, | |||
const char * | state, | |||
const char * | state2, | |||
double | value, | |||
double | value2 | |||
) |
engrave_program_action_set - set the action for the program.
- Parameters:
-
ep,: The Engrave_Program to set the action on. action,: The Engrave_Action to set on the program. state,: The state value to set. state2,: The state2 value to set. value,: The value value to set. value2,: The value2 value to set.
- Returns:
- Returns no value.
EAPI void engrave_program_after_add | ( | Engrave_Program * | ep, | |
const char * | after | |||
) |
engrave_program_after_add - add the after to the program.
- Parameters:
-
ep,: The Engrave_Program to add the after too. after,: The after to add to the program.
- Returns:
- Returns no value.
EAPI void engrave_program_after_foreach | ( | Engrave_Program * | ep, | |
void(*)(const char *, void *) | func, | |||
void * | data | |||
) |
engrave_program_after_foreach - Iterate over each after
- Parameters:
-
ep,: The Engrave_Program to get the afters from func,: The function to call for each after data,: User data
- Returns:
- Returns no value.
EAPI int engrave_program_afters_count | ( | Engrave_Program * | ep | ) |
engrave_program_afters_count - get the number of afters
- Parameters:
-
ep,: The Engrave_Program to check for afters
- Returns:
- Returns number of afters, 0 otherwise
EAPI void engrave_program_free | ( | Engrave_Program * | ep | ) |
engrave_program_free - free the program
- Parameters:
-
ep,: The Engrave_Program to free
- Returns:
- Returns no value.
EAPI void engrave_program_in_get | ( | Engrave_Program * | ep, | |
double * | from, | |||
double * | range | |||
) |
engrave_program_in_get - Get the in data for the program
- Parameters:
-
ep,: The Engrave_Program to get the in data from from,: The place to put the from value range,: The place to put the range value
- Returns:
- Returns no value.
EAPI void engrave_program_in_set | ( | Engrave_Program * | ep, | |
double | from, | |||
double | range | |||
) |
engrave_program_in_set - set the in value of the program.
- Parameters:
-
ep,: The Engrave_Program to set the in value on. from,: The from value to set. range,: The range value to set.
- Returns:
- Returns no value.
EAPI const char* engrave_program_name_get | ( | Engrave_Program * | ep | ) |
engrave_program_name_get - Get the program name
- Parameters:
-
ep,: The Engrave_Program to get the name from
- Returns:
- Returns the name of the program or NULL on failure.
EAPI void engrave_program_name_set | ( | Engrave_Program * | ep, | |
const char * | name | |||
) |
engrave_program_name_set - set the name of the program.
- Parameters:
-
ep,: The Engrave_Program to attach the name too. name,: The name to attach to the program.
- Returns:
- Returns no value.
EAPI Engrave_Program* engrave_program_new | ( | void | ) |
engrave_program_new - create a new Engrave_Program object.
- Returns:
- Returns a pointer to the newly allocated Engrave_Program object on success or NULL on failure.
EAPI void* engrave_program_parent_get | ( | Engrave_Program * | ep | ) |
engrave_program_parent_get - get the parent pointer
- Parameters:
-
ep,: The Engrave_Program to get the parent from
- Returns:
- Returns a pointer to the Engrave_Group parent, or NULL if none set
EAPI void engrave_program_parent_set | ( | Engrave_Program * | ep, | |
void * | eg | |||
) |
engrave_program_parent_set - set the parent of the program
- Parameters:
-
ep,: The Engrave_Program to set the parent into eg,: The Engrave_Group to set as parent
- Returns:
- Returns no value.
EAPI const char* engrave_program_script_get | ( | Engrave_Program * | ep | ) |
engrave_program_script_get - Get the script from the program
- Parameters:
-
ep,: The Engrave_Program to get the script from
- Returns:
- Returns the script or NULL on failure.
EAPI void engrave_program_script_set | ( | Engrave_Program * | ep, | |
const char * | script | |||
) |
engrave_program_script_set - attach a script to the program.
- Parameters:
-
ep,: The Engrave_Program to attach the script too. script,: The script to attach to the program.
- Returns:
- Returns no value.
EAPI const char* engrave_program_signal_get | ( | Engrave_Program * | ep | ) |
engrave_program_signal_get - Get the program signal
- Parameters:
-
ep,: The Engrave_Program to get the signal from
- Returns:
- Returns the signal of the program or NULL on failure.
EAPI void engrave_program_signal_set | ( | Engrave_Program * | ep, | |
const char * | signal | |||
) |
engrave_program_signal_set - set the given signal on the program
- Parameters:
-
ep,: The Engrave_Program to attach the signal too. signal,: The signal to attach to the program.
- Returns:
- Returns no value.
EAPI const char* engrave_program_source_get | ( | Engrave_Program * | ep | ) |
engrave_program_source_get - Get the program source
- Parameters:
-
ep,: The Engrave_Program to get the source from
- Returns:
- Returns the source of the program or NULL on failure.
EAPI void engrave_program_source_set | ( | Engrave_Program * | ep, | |
const char * | source | |||
) |
engrave_program_source_set - set the source of the program.
- Parameters:
-
ep,: The Engrave_Program to attach the souce too. source,: The name to attach to the group.
- Returns:
- Returns no value.
EAPI void engrave_program_target_add | ( | Engrave_Program * | ep, | |
const char * | target | |||
) |
engrave_program_target_add - set the target on the program.
- Parameters:
-
ep,: The Engrave_Program to set the target on. target,: The target to set on the program.
- Returns:
- Returns no value.
EAPI void engrave_program_target_foreach | ( | Engrave_Program * | ep, | |
void(*)(const char *, void *) | func, | |||
void * | data | |||
) |
engrave_program_target_foreach - Iterate over each target
- Parameters:
-
ep,: The Engrave_Program to get the targets from func,: The function to call for each target data,: User data
- Returns:
- Returns no value.
EAPI int engrave_program_targets_count | ( | Engrave_Program * | ep | ) |
engrave_program_targets_count - count the number of targets
- Parameters:
-
ep,: The Engrave_Program to check for targets
- Returns:
- Returns number of targets, 0 otherwise
EAPI void engrave_program_transition_get | ( | Engrave_Program * | ep, | |
Engrave_Transition * | trans, | |||
double * | duration | |||
) |
engrave_program_transition_get - Get the programs transition information
- Parameters:
-
ep,: The Engrave_Progarm to get the transition information from trans,: Where to store the transition setting duration,: Where to store the duration setting
- Returns:
- Returns no value.
EAPI void engrave_program_transition_set | ( | Engrave_Program * | ep, | |
Engrave_Transition | trans, | |||
double | duration | |||
) |
engrave_program_transition_set - set the transition on the program
- Parameters:
-
ep,: The Engrave_Program to set the transition on. trans,: The Engrave_Transition to set on the program. duration,: The duration of the given transition.
- Returns:
- Returns no value.