BViewPixbuf

BViewPixbuf —

Synopsis




struct      BViewPixbuf;
BViewPixbuf* b_view_pixbuf_new              (gint rows,
                                             gint columns,
                                             gint channels,
                                             GError **error);
BViewPixbuf* b_view_pixbuf_new_theme        (BTheme *theme,
                                             gboolean image_preload,
                                             GError **error);
const GdkPixbuf* b_view_pixbuf_load_image   (BViewPixbuf *view,
                                             const gchar *filename,
                                             GError **error);
const GdkPixbuf* b_view_pixbuf_render       (BViewPixbuf *view,
                                             const guchar *frame_data,
                                             const BRectangle *clip,
                                             GError **error);

Object Hierarchy


  GObject
   +----BViewPixbuf

Description

Details

struct BViewPixbuf

struct BViewPixbuf;


b_view_pixbuf_new ()

BViewPixbuf* b_view_pixbuf_new              (gint rows,
                                             gint columns,
                                             gint channels,
                                             GError **error);

Creates a new BViewPixbuf for the given parameters. This is a simple version that renders a grayscale pixel for every window.

rows :
columns :
channels :
error : location to store the error occuring, or NULL to ignore errors
Returns : a new view or NULL in case of an error

b_view_pixbuf_new_theme ()

BViewPixbuf* b_view_pixbuf_new_theme        (BTheme *theme,
                                             gboolean image_preload,
                                             GError **error);

Creates a pixbuf renderer for Blinkenlights frames using the theme. When image_preload is enabled, all images refered to by the theme are loaded. If an error occurs loading the images, b_view_pixbuf_new() will fail and return NULL. If a view is created with preloaded images, calling b_view_pixbuf_render() on it will always succeed so you can skip error checking later.

theme : a BTheme object
image_preload : whether to preload all images
error : location to store the error occuring, or NULL to ignore errors
Returns : a new view or NULL in case of an error

b_view_pixbuf_load_image ()

const GdkPixbuf* b_view_pixbuf_load_image   (BViewPixbuf *view,
                                             const gchar *filename,
                                             GError **error);

Renders a frame on the view and returns a pointer to a GdkPixbuf holding the rendered image. The pixbuf is owned by the view, you may only read from it.

The view expects frame_data in the range of 0 to 255.

view : a BViewPixbuf object
filename : the filename of the image to load
error : location to store the error occuring, or NULL to ignore errors
Returns : a pointer to a GdkPixbuf with the rendered frame

b_view_pixbuf_render ()

const GdkPixbuf* b_view_pixbuf_render       (BViewPixbuf *view,
                                             const guchar *frame_data,
                                             const BRectangle *clip,
                                             GError **error);

Renders a frame on the view. The view expects frame_data in the range of 0 to 255.

view : a BViewPixbuf object
frame_data : the frame data to display
clip : clipping rectangle (or NULL)
error : location to store the error occuring, or NULL to ignore errors
Returns : a reference to a GdkPixbuf with the rendered frame.