GTK+ Reference Manual
<<< Previous Page | Home | Up | Next Page >>>

# GtkImage

## Name

GtkImage -- A widget displaying a graphical image

## Synopsis

    #include <gtk/gtk.h>

    struct      GtkImage;
    GtkWidget*  gtk_image_new                   (GdkImage *val,
                                                 GdkBitmap *mask);
    void        gtk_image_set                   (GtkImage *image,
                                                 GdkImage *val,
                                                 GdkBitmap *mask);
    void        gtk_image_get                   (GtkImage *image,
                                                 GdkImage **val,
                                                 GdkBitmap **mask);

## Object Hierarchy

      GtkObject
       +----GtkWidget
             +----GtkMisc
                   +----GtkImage

## Description

The GtkImage widget displays a graphical image. The image is typically created using gdk_image_new.

The pixels in a GtkImage may be manipulated by the application after creation, as GtkImage store the pixel data on the client side. If you wish to store the pixel data on the server side (thus not allowing manipulation of the data after creation) you should use GtkPixmap.

## Details

### struct GtkImage

    struct GtkImage;

This struct contain private data only and should be accessed by the functions below.

### gtk_image_new ()

    GtkWidget*  gtk_image_new                   (GdkImage *val,
                                                 GdkBitmap *mask);

Creates the new GtkImage using the value and the mask.

`val` : |
`mask` : | a GDKBitmap that indicates which parts of the image should be transparent.
Returns : | the GtkImage

### gtk_image_set ()

    void        gtk_image_set                   (GtkImage *image,
                                                 GdkImage *val,
                                                 GdkBitmap *mask);

Sets the GtkImage

`image` : | a GdkPixmap
`val` : |
`mask` : | a GDKBitmap that indicates which parts of the image should be transparent.

### gtk_image_get ()

    void        gtk_image_get                   (GtkImage *image,
                                                 GdkImage **val,
                                                 GdkBitmap **mask);

Gets the GtkImage

`image` : | a GdkPixmap
`val` : |
`mask` : | a GDKBitmap that indicates which parts of the image should be transparent.

## See Also

GtkPixmap, GdkRgb

<<< Previous Page | Home | Up | Next Page >>>
GtkHSeparator | GtkInputDialog