Scene Pool

Collaboration diagram for Scene Pool:

Modules
	Scene

Data Structures
struct	DMX512_scene_pool_s
	DMX512 scene pool structure object. More...

Functions
DMX512_scene_pool_s *	DMX512_scene_pool_new (void)
	Creates a new scene pool instance. More...
DMX512_engine_err_e	DMX512_scene_pool_add (DMX512_scene_pool_s *scene_pool, DMX512_scene_s scene)
	Adds a scene instance into the pool. More...
DMX512_engine_err_e	DMX512_scene_pool_del (DMX512_scene_pool_s *scene_pool, uint16_t id)
	Deletes a scene instance from the pool. More...
DMX512_engine_err_e	DMX512_scene_pool_get (DMX512_scene_pool_s *scene_pool, uint16_t id, DMX512_scene_s **scene)
	Gets a scene instance from the pool. More...
void	DMX512_scene_pool_manage (DMX512_scene_pool_s *scene_pool)
	Manages all scenes contained within the pool. More...
void	DMX512_scene_pool_free (DMX512_scene_pool_s *scene_pool)
	Safely Frees instance pool. More...

Detailed Description

Scene pools are used to store and manage a lists of pre-configured scenes. Up to 65535 DMX512 scenes may be stored per DMX512 universe.

Function Documentation

DMX512_scene_pool_add()

DMX512_engine_err_e DMX512_scene_pool_add	(	DMX512_scene_pool_s *	scene_pool,
		DMX512_scene_s	scene
	)

Adds a scene instance into the pool.

Parameters

*scene_pool	pointer to the scene pool instance to be referenced
scene	scene instance to be added into the pool

Returns

DMX512_engine_err_e error code following the function call

Definition at line 60 of file DMX512_scene_pool.c.

DMX512_scene_pool_del()

DMX512_engine_err_e DMX512_scene_pool_del	(	DMX512_scene_pool_s *	scene_pool,
		uint16_t	id
	)

Deletes a scene instance from the pool.

Parameters

*scene_pool	pointer to the scene pool instance to be referenced
id	the scene's idendifier

Returns

DMX512_engine_err_e error code following the function call

Definition at line 85 of file DMX512_scene_pool.c.

DMX512_scene_pool_free()

void DMX512_scene_pool_free

(

DMX512_scene_pool_s *

scene_pool

)

Safely Frees instance pool.

Parameters

*scene_pool

pointer to the scene pool instance to be freed

Definition at line 142 of file DMX512_scene_pool.c.

DMX512_scene_pool_get()

DMX512_engine_err_e DMX512_scene_pool_get	(	DMX512_scene_pool_s *	scene_pool,
		uint16_t	id,
		DMX512_scene_s **	scene
	)

Gets a scene instance from the pool.

Parameters

*scene_pool	pointer to the scene pool instance to be referenced
id	the scene's identifier

Returns

DMX512_scene_s* pointer to the scene instance

Definition at line 112 of file DMX512_scene_pool.c.

DMX512_scene_pool_manage()

void DMX512_scene_pool_manage

(

DMX512_scene_pool_s *

scene_pool

)

Manages all scenes contained within the pool.

Parameters

*scene_pool

pointer to the scene pool instance to be referenced

Definition at line 131 of file DMX512_scene_pool.c.

DMX512_scene_pool_new()

DMX512_scene_pool_s * DMX512_scene_pool_new

(

void

)

Creates a new scene pool instance.

Returns

DMX512_scene_pool_s* pointer to the created pool instance

Definition at line 46 of file DMX512_scene_pool.c.