struct BColor

struct BColor {

  guchar  a;
  guchar  r;
  guchar  g;
  guchar  b;
};

The BColor struct is used to store a single color. The color channels have values in the range from 0 to 255.

struct BRectangle

struct BRectangle {

  gint    x;
  gint    y;
  gint    w;
  gint    h;
};

The BRectangle struct is used to store a rectangle. The coordinates are pixel values. The x coordinate advances from left to right, the y coordinate from top to bottom.

struct BWindow

struct BWindow {

  gint        value;
  gint        row;
  gint        column;
  gint        src_x;
  gint        src_y;
  BRectangle  rect;
};

The BWindow struct defines a single overlay window used in a BTheme.

B_WINDOW_VALUE_ALL

#define B_WINDOW_VALUE_ALL 0

A special value used to indicate that the window definition is valid for all possible values.

struct BOverlay

struct BOverlay {

  gchar       *image;
  BColor       color;

  GList       *windows;
};

The BOverlay struct defines a set of overlay windows used in a BTheme.

struct BTheme

struct BTheme;

The BTheme object defines the dimensions and the look of a Blinkenlights installation.

b_theme_new_from_file ()

BTheme*     b_theme_new_from_file           (const gchar *filename,
                                             gboolean lazy_load,
                                             GError **error);

Tries to load a BTheme from the file pointed to by filename. If lazy_load is TRUE, only the header is loaded.

b_theme_new_from_scratch ()

BTheme*     b_theme_new_from_scratch        (const gchar *title,
                                             const gchar *type,
                                             gint rows,
                                             gint columns,
                                             gint channels,
                                             gint maxval,
                                             gint width,
                                             gint height);

Creates a new BTheme object from scratch. This may be useful if you want to quickly test a movie for a layout you don't have a theme for. You need to call b_theme_load() before you can use the new theme.

b_theme_load ()

gboolean    b_theme_load                    (BTheme *theme,
                                             GError **error);

Loads all data into the theme. You only need to call this if you lazy-loaded the theme or called b_theme_unload() before.

b_theme_unload ()

void        b_theme_unload                  (BTheme *theme);

Frees all data of a BTheme except the meta information stored in the header.

struct BThemesQuery

struct BThemesQuery {

  BThemesQueryFlags  flags;

  const gchar       *name;
  const gchar       *type;
  gint               rows;
  gint               columns;
  gint               width;
  gint               height;
};

A structure that defines a query on the installed themes. Used by b_themes_query().

enum BThemesQueryFlags

typedef enum
{
  B_THEMES_QUERY_NONE    = 0,
  B_THEMES_QUERY_NAME    = 1 << 0,
  B_THEMES_QUERY_TYPE    = 1 << 1,
  B_THEMES_QUERY_ROWS    = 1 << 2,
  B_THEMES_QUERY_COLUMNS = 1 << 3,
  B_THEMES_QUERY_WIDTH   = 1 << 4,
  B_THEMES_QUERY_HEIGHT  = 1 << 5
} BThemesQueryFlags;

Flags that define which values of a BThemesQuery are valid.

b_themes_query ()

GList*      b_themes_query                  (const gchar *themepath,
                                             BThemesQuery *query);

Looks for themes as defined by query. If themepath is not specified the default path is used. The default path can be overridden by setting the environment variable B_THEME_PATH.

Each theme that matches the query is lazy-loaded.

BThemesForeachFunc ()

gboolean    (*BThemesForeachFunc)           (BTheme *theme,
                                             gpointer callback_data);

This function is called for each theme found by b_themes_foreach().

b_themes_foreach ()

void        b_themes_foreach                (const gchar *themepath,
                                             BThemesForeachFunc callback,
                                             gpointer callback_data);

This function iterates over all themes in the themepath, lazy-loads them, runs callback on the theme and unrefs it again. The iteration is stopped if a callback returns FALSE.

If themepath is not specified, the default path is used. The default path can be overridden by setting the environment variable B_THEME_PATH.

b_themes_foreach_theme ()

void        b_themes_foreach_theme          (const gchar *themepath,
                                             GHFunc callback,
                                             gpointer callback_data);

Shouldn't be used in new code, use b_themes_foreach() instead.

b_themes_lookup_theme ()

BTheme*     b_themes_lookup_theme           (const gchar *name,
                                             const gchar *themepath,
                                             GError **error);

Shouldn't be used in new code, use b_themes_query() instead.

b_theme_frame_diff_boundary ()

gboolean    b_theme_frame_diff_boundary     (BTheme *theme,
                                             const guchar *prev_data,
                                             const guchar *frame_data,
                                             BRectangle *bbox);

Computes the bounding box of the difference image between two frames.