Callbacks for the video output plugin. More...

#include <plugin.h>

Data Fields
const bg_accelerator_map_t *	accel_map
	Accelerator map.
int(*	accel_callback )(void *data, int id)
	Keyboard callback.
int(*	key_callback )(void *data, int key, int mask)
	Keyboard callback.
int(*	key_release_callback )(void *data, int key, int mask)
	Keyboard release callback.
int(*	button_callback )(void *data, int x, int y, int button, int mask)
	Mouse button callback.
int(*	button_release_callback )(void *data, int x, int y, int button, int mask)
	Mouse button release callback.
int(*	motion_callback )(void *data, int x, int y, int mask)
	Motion callback.
void(*	show_window )(void *data, int show)
	Show/hide callback.
void(*	brightness_callback )(void *data, float val)
	Brightness change callback.
void(*	saturation_callback )(void *data, float val)
	Saturation change callback.
void(*	contrast_callback )(void *data, float val)
	Contrast change callback.
void(*	hue_callback )(void *data, float val)
	Hue change callback.
void *	data
	Application specific data passed as the first argument to all callbacks.

Detailed Description

Callbacks for the video output plugin.

Field Documentation

const bg_accelerator_map_t* bg_ov_callbacks_s::accel_map

Accelerator map.

These contain accelerator keys, which get reported through the accel_callback

int(* bg_ov_callbacks_s::accel_callback)(void *data, int id)

Keyboard callback.

Parameters:

data	The data member of this bg_ov_callbacks_s struct
id	The accelerator ID

int(* bg_ov_callbacks_s::key_callback)(void *data, int key, int mask)

Keyboard callback.

Parameters:

data	The data member of this bg_ov_callbacks_s struct
key	Key code (see System independent keycode definitions)
mask	Modifier mask (see System independent keycode definitions)

Returns:: 1 if the event should further be processed, 0 else

Although key_callback and accel_callback can be used at the same time, accelerator_callback is preferred, because it allows registering keyboard shortcuts in advance. This makes things more reliable, if different modules (e.g. embedded visualization plugins) also want to receive keybords events·

int(* bg_ov_callbacks_s::key_release_callback)(void *data, int key, int mask)

Keyboard release callback.

Parameters:

data	The data member of this bg_ov_callbacks_s struct
key	Key code (see System independent keycode definitions)
mask	Modifier mask (see System independent keycode definitions)

Returns:: 1 if the event should further be processed, 0 else

int(* bg_ov_callbacks_s::button_callback)(void *data, int x, int y, int button, int mask)

Mouse button callback.

Parameters:

data	The data member of this bg_ov_callbacks_s struct
x	Horizontal cursor position in image coordinates
y	Vertical cursor position in image coordinates
button	Number of the mouse button, which was pressed (starting with 1)
mask	State mask

Returns:: 1 if the event should further be processed, 0 else

int(* bg_ov_callbacks_s::button_release_callback)(void *data, int x, int y, int button, int mask)

Mouse button release callback.

Parameters:

data	The data member of this bg_ov_callbacks_s struct
x	Horizontal cursor position in image coordinates
y	Vertical cursor position in image coordinates
button	Number of the mouse button, which was pressed (starting with 1)
mask	State mask

Returns:: 1 if the event should further be processed, 0 else

int(* bg_ov_callbacks_s::motion_callback)(void *data, int x, int y, int mask)

Motion callback.

Parameters:

data	The data member of this bg_ov_callbacks_s struct
x	Horizontal cursor position in image coordinates
y	Vertical cursor position in image coordinates
mask	State mask