gp_ev_feedback.h File Reference

An input event feedback, e.g. keyboard leds. More...

#include <stdint.h>
#include <input/gp_types.h>

Go to the source code of this file.

Enumerations
enum	gp_ev_feedback_val_leds {   GP_KBD_LED_NUM_LOCK = 0x01 , GP_KBD_LED_CAPS_LOCK = 0x02 , GP_KBD_LED_SCROLL_LOCK = 0x04 , GP_KBD_LED_COMPOSE = 0x08 ,   GP_KBD_LED_KANA = 0x10 }
	A bitfield of keyboard leds to manipulate. More...
enum	gp_ev_feedback_op_type { GP_EV_LEDS_ON , GP_EV_LEDS_OFF , GP_EV_LEDS_GET }
	A feedback operation to be done. More...

Functions
void	gp_ev_feedback_set_all (gp_ev_feedback *root, gp_ev_feedback_op *op)
	Passes an opeartion to all registered feedbacks.
void	gp_ev_feedback_register (gp_ev_feedback **root, gp_ev_feedback *self)
	Adds a feedback to a feedback queue.
void	gp_ev_feedback_unregister (gp_ev_feedback **root, gp_ev_feedback *self)
	Removes a feedback from a feedback queue.

Detailed Description

An input event feedback, e.g. keyboard leds.

Implements input device feedback, currently keyboard leds but can be modified to include force feedback in joysticks as well.

Definition in file gp_ev_feedback.h.

Enumeration Type Documentation

gp_ev_feedback_op_type

enum gp_ev_feedback_op_type

A feedback operation to be done.

This is passed in the op field of the gp_ev_feedback_op structure.

Enumerator
GP_EV_LEDS_ON	Turns on leds in the val mask.
GP_EV_LEDS_OFF	Turns off leds in the val mask.
GP_EV_LEDS_GET	Returns leds status in the val field.

Definition at line 43 of file gp_ev_feedback.h.

gp_ev_feedback_val_leds

enum gp_ev_feedback_val_leds

A bitfield of keyboard leds to manipulate.

This is passed in the val field of the gp_ev_feedback_op structure.

Enumerator
GP_KBD_LED_NUM_LOCK	A num lock led.
GP_KBD_LED_CAPS_LOCK	A caps lock led.
GP_KBD_LED_SCROLL_LOCK	A scroll lock led.
GP_KBD_LED_COMPOSE	A compose led.
GP_KBD_LED_KANA	A kana led.

Definition at line 25 of file gp_ev_feedback.h.

Function Documentation

gp_ev_feedback_register()

void gp_ev_feedback_register	(	gp_ev_feedback **	root,
		gp_ev_feedback *	self
	)

Adds a feedback to a feedback queue.

Parameters

root	A pointer to a root of the feedbacks list.
self	A feedback to be registered.

Referenced by gp_ev_queue_feedback_register().

gp_ev_feedback_set_all()

void gp_ev_feedback_set_all	(	gp_ev_feedback *	root,
		gp_ev_feedback_op *	op
	)

Passes an opeartion to all registered feedbacks.

Parameters

root	A pointer to a root of the feedbacks list.
op	An operation.

Referenced by gp_ev_queue_feedback_set_all().

gp_ev_feedback_unregister()

void gp_ev_feedback_unregister	(	gp_ev_feedback **	root,
		gp_ev_feedback *	self
	)

Removes a feedback from a feedback queue.

Parameters

root	A pointer to a root of the feedbacks list.
self	A feedback to be unregistered.

Referenced by gp_ev_queue_feedback_unregister().