encoders.h File Reference

#include "plugins.h"

Go to the source code of this file.

Data Structures
union	encoder_event_t
union	encoder_caps_t
struct	encoder_cfg_t
struct	encoder_data_t
struct	encoder

Typedefs
typedef struct encoder	encoder_t
typedef void(*	encoder_on_event_ptr) (encoder_t *encoder, encoder_event_t *events, void *context)
	Pointer to callback function to receive encoder events. More...
typedef void(*	encoder_reset_ptr) (encoder_t *encoder)
	Pointer to function for resetting encoder data. More...
typedef bool(*	encoder_claim_ptr) (encoder_on_event_ptr event_handler, void *context)
	Pointer to function for claiming an encoder. More...
typedef encoder_data_t *(*	encoder_get_data_ptr) (encoder_t *encoder)
	Pointer to function for getting encoder data. More...
typedef bool(*	encoder_enumerate_callback_ptr) (encoder_t *encoder, void *data)
	Pointer to the callbak function to be called by encoders_enumerate(). More...
typedef bool(*	encoder_configure_ptr) (encoder_t *encoder, encoder_cfg_t *settings)
	Pointer to function for configuring an encoder. More...

Functions
void	encoder_register (encoder_t *encoder)
bool	encoders_enumerate (encoder_enumerate_callback_ptr callback, void *data)
uint8_t	encoders_get_num (void)

Typedef Documentation

encoder_claim_ptr

typedef bool(* encoder_claim_ptr) (encoder_on_event_ptr event_handler, void *context)

Pointer to function for claiming an encoder.

Parameters

event_handler	pointer to to the event handler callback.
context	pointer to the context to be passed to event handler.

Returns

true when claim was successful, false to otherwise.

encoder_configure_ptr

typedef bool(* encoder_configure_ptr) (encoder_t *encoder, encoder_cfg_t *settings)

Pointer to function for configuring an encoder.

Parameters

encoder	pointer to a encoder_t struct.
encoder	pointer to a encoder_cfg_t struct.

Returns

true when claim was successful, false to otherwise.

encoder_enumerate_callback_ptr

typedef bool(* encoder_enumerate_callback_ptr) (encoder_t *encoder, void *data)

Pointer to the callbak function to be called by encoders_enumerate().

Parameters

encoder

pointer to a encoder_t struct.

Returns

true to stop the enumeration and return true from encoders_enumerate(), false otherwise.

encoder_get_data_ptr

typedef encoder_data_t*(* encoder_get_data_ptr) (encoder_t *encoder)

Pointer to function for getting encoder data.

Parameters

encoder

pointer to a encoder_t struct.

Returns

pointer to a encoder_data_t struct containing the data.

encoder_on_event_ptr

typedef void(* encoder_on_event_ptr) (encoder_t *encoder, encoder_event_t *events, void *context)

Pointer to callback function to receive encoder events.

Parameters

encoder	pointer to a encoder_t struct.
events	pointer to a encoder_event_t struct.
context	pointer to the context passed to the encoders claim function.

encoder_reset_ptr

typedef void(* encoder_reset_ptr) (encoder_t *encoder)

Pointer to function for resetting encoder data.

Parameters

encoder

pointer to a encoder_t struct.

encoder_t

typedef struct encoder encoder_t

Function Documentation

encoder_register()

void encoder_register

(

encoder_t *

encoder

)

encoders_enumerate()

bool encoders_enumerate	(	encoder_enumerate_callback_ptr	callback,
		void *	data
	)

encoders_get_num()

uint8_t encoders_get_num

(

void

)