The gdk-pixbuf Library
<<< Previous Page | Home | Up | Next Page >>>

# The GdkPixbuf Structure

## Name

The GdkPixbuf Structure -- Information that describes an image.

## Synopsis

    #include <gdk-pixbuf/gdk-pixbuf.h>

    enum        GdkColorspace;
    GdkColorspace gdk_pixbuf_get_colorspace     (const GdkPixbuf *pixbuf);
    int         gdk_pixbuf_get_n_channels       (const GdkPixbuf *pixbuf);
    gboolean    gdk_pixbuf_get_has_alpha        (const GdkPixbuf *pixbuf);
    int         gdk_pixbuf_get_bits_per_sample  (const GdkPixbuf *pixbuf);
    guchar*     gdk_pixbuf_get_pixels           (const GdkPixbuf *pixbuf);
    int         gdk_pixbuf_get_width            (const GdkPixbuf *pixbuf);
    int         gdk_pixbuf_get_height           (const GdkPixbuf *pixbuf);
    int         gdk_pixbuf_get_rowstride        (const GdkPixbuf *pixbuf);

## Description

The GdkPixbuf structure contains information that describes an image in memory.

## Details

### enum GdkColorspace

    typedef enum {
    	GDK_COLORSPACE_RGB
    } GdkColorspace;

This enumeration defines the color spaces that are supported by the gdk-pixbuf library. Currently only RGB is supported.

`GDK_COLORSPACE_RGB` | Indicates a red/green/blue additive color space.

### gdk_pixbuf_get_colorspace ()

    GdkColorspace gdk_pixbuf_get_colorspace     (const GdkPixbuf *pixbuf);

Queries the color space of a pixbuf.

`pixbuf` : | A pixbuf.
Returns : | Color space.

### gdk_pixbuf_get_n_channels ()

    int         gdk_pixbuf_get_n_channels       (const GdkPixbuf *pixbuf);

Queries the number of channels of a pixbuf.

`pixbuf` : | A pixbuf.
Returns : | Number of channels.

### gdk_pixbuf_get_has_alpha ()

    gboolean    gdk_pixbuf_get_has_alpha        (const GdkPixbuf *pixbuf);

Queries whether a pixbuf has an alpha channel (opacity information).

`pixbuf` : | A pixbuf.
Returns : | TRUE if it has an alpha channel, FALSE otherwise.

### gdk_pixbuf_get_bits_per_sample ()

    int         gdk_pixbuf_get_bits_per_sample  (const GdkPixbuf *pixbuf);

Queries the number of bits per color sample in a pixbuf.

`pixbuf` : | A pixbuf.
Returns : | Number of bits per color sample.

### gdk_pixbuf_get_pixels ()

    guchar*     gdk_pixbuf_get_pixels           (const GdkPixbuf *pixbuf);

Queries a pointer to the pixel data of a pixbuf.

`pixbuf` : | A pixbuf.
Returns : | A pointer to the pixbuf's pixel data.

### gdk_pixbuf_get_width ()

    int         gdk_pixbuf_get_width            (const GdkPixbuf *pixbuf);

Queries the width of a pixbuf.

`pixbuf` : | A pixbuf.
Returns : | Width in pixels.

### gdk_pixbuf_get_height ()

    int         gdk_pixbuf_get_height           (const GdkPixbuf *pixbuf);

Queries the height of a pixbuf.

`pixbuf` : | A pixbuf.
Returns : | Height in pixels.

### gdk_pixbuf_get_rowstride ()

    int         gdk_pixbuf_get_rowstride        (const GdkPixbuf *pixbuf);

Queries the rowstride of a pixbuf, which is the number of bytes between rows.

`pixbuf` : | A pixbuf.
Returns : | Number of bytes between rows.

<<< Previous Page | Home | Up | Next Page >>>
API Reference | Reference Counting and Memory Mangement