gmerlin
Data Fields

bg_ov_callbacks_s Struct Reference

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:
dataThe data member of this bg_ov_callbacks_s struct
idThe accelerator ID
int(* bg_ov_callbacks_s::key_callback)(void *data, int key, int mask)

Keyboard callback.

Parameters:
dataThe data member of this bg_ov_callbacks_s struct
keyKey code (see System independent keycode definitions)
maskModifier 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:
dataThe data member of this bg_ov_callbacks_s struct
keyKey code (see System independent keycode definitions)
maskModifier 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:
dataThe data member of this bg_ov_callbacks_s struct
xHorizontal cursor position in image coordinates
yVertical cursor position in image coordinates
buttonNumber of the mouse button, which was pressed (starting with 1)
maskState 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:
dataThe data member of this bg_ov_callbacks_s struct
xHorizontal cursor position in image coordinates
yVertical cursor position in image coordinates
buttonNumber of the mouse button, which was pressed (starting with 1)
maskState 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:
dataThe data member of this bg_ov_callbacks_s struct
xHorizontal cursor position in image coordinates
yVertical cursor position in image coordinates
maskState mask
Returns:
1 if the event should further be processed, 0 else
void(* bg_ov_callbacks_s::show_window)(void *data, int show)

Show/hide callback.

Parameters:
dataThe data member of this bg_ov_callbacks_s struct
show1 if the window is shown now, 0 if it is hidden.
void(* bg_ov_callbacks_s::brightness_callback)(void *data, float val)

Brightness change callback.

Parameters:
dataThe data member of this bg_ov_callbacks_s struct
valNew value (0.0..1.0)

This callback can be used to update OSD when the brightness changed.

void(* bg_ov_callbacks_s::saturation_callback)(void *data, float val)

Saturation change callback.

Parameters:
dataThe data member of this bg_ov_callbacks_s struct
valNew value (0.0..1.0)

This callback can be used to update OSD when the saturation changed.

void(* bg_ov_callbacks_s::contrast_callback)(void *data, float val)

Contrast change callback.

Parameters:
dataThe data member of this bg_ov_callbacks_s struct
valNew value (0.0..1.0)

This callback can be used to update OSD when the contrast changed.

void(* bg_ov_callbacks_s::hue_callback)(void *data, float val)

Hue change callback.

Parameters:
dataThe data member of this bg_ov_callbacks_s struct
valNew value (0.0..1.0)

This callback can be used to update OSD when the hue changed.

Application specific data passed as the first argument to all callbacks.


The documentation for this struct was generated from the following file: