Fixture Preset

Collaboration diagram for Fixture Preset:

Data Structures
struct	DMX512_fixture_preset_s
	DMX512 fixture preset structure object. More...

Macros
#define	DMX512_FIXTURE_PRESET_DEFAULT   {NULL, 0, NULL, NULL, DMX512_FIXTURE_PRESET_UNINITIALISED}
	Fixture preset's default values. More...

Enumerations
enum	DMX512_fixture_preset_status {   DMX512_FIXTURE_PRESET_UNINITIALISED ,   DMX512_FIXTURE_PRESET_INITIALISED }
	Status of a fixture preset. More...

Functions
DMX512_fixture_preset_s	DMX512_fixture_preset_new (DMX512_fixture_s *fixture, uint16_t channel_count, uint16_t *channels, uint8_t *values)
	Creates a new scene fixture preset instance. More...
void	DMX512_fixture_preset_free (DMX512_fixture_preset_s *fixture_preset)
	Frees a fixture preset's dynamically allocated ressources and resets its values parameters to default. More...

Detailed Description

Fixture presets are used to define a scene's fixture channel values to be set into the DMX512 driver send buffer once the scene is triggered.

Macro Definition Documentation

DMX512_FIXTURE_PRESET_DEFAULT

#define DMX512_FIXTURE_PRESET_DEFAULT   {NULL, 0, NULL, NULL, DMX512_FIXTURE_PRESET_UNINITIALISED}

Fixture preset's default values.

Used during initialisation of a fixture preset instance, it lowers the risk of conflicts by ensuring that every parameters which will be set are correctly initialised.

Definition at line 23 of file DMX512_fixture_preset.h.

Enumeration Type Documentation

DMX512_fixture_preset_status

enum DMX512_fixture_preset_status

Status of a fixture preset.

Defines whether or not a fixture preset has been correctly initialised.

Enumerator
DMX512_FIXTURE_PRESET_UNINITIALISED	Fixture preset is initialised
DMX512_FIXTURE_PRESET_INITIALISED	Fixture preset is unititialised

Definition at line 32 of file DMX512_fixture_preset.h.

Function Documentation

DMX512_fixture_preset_free()

void DMX512_fixture_preset_free

(

DMX512_fixture_preset_s *

fixture_preset

)

Frees a fixture preset's dynamically allocated ressources and resets its values parameters to default.

Parameters

*DMX512_fixture_preset_s

pointer to the fixture preset instance to be reseted

Definition at line 84 of file DMX512_fixture_preset.c.

DMX512_fixture_preset_new()

DMX512_fixture_preset_s DMX512_fixture_preset_new	(	DMX512_fixture_s *	fixture,
		uint16_t	channel_count,
		uint16_t *	channels,
		uint8_t *	values
	)

Creates a new scene fixture preset instance.

Parameters

*fixture	pointer to the fixture instance to be referenced
channel_count	the fixture preset channel count
*channels	pointer to an array of channels
*values	pointer to an array of values ordered as defined in channels array

Returns

DMX512_fixture_preset_s the created fixture preset instance

Definition at line 56 of file DMX512_fixture_preset.c.