RGtk2 (version 2.20.31)

gdkPixbufRenderPixmapAndMaskForColormap: gdkPixbufRenderPixmapAndMaskForColormap

Description

Creates a pixmap and a mask bitmap which are returned in the pixmap.return and mask.return arguments, respectively, and renders a pixbuf and its corresponding tresholded alpha mask to them. This is merely a convenience function; applications that need to render pixbufs with dither offsets or to given drawables should use gdkDrawPixbuf, and gdkPixbufRenderThresholdAlpha.

Usage

gdkPixbufRenderPixmapAndMaskForColormap(object, colormap, alpha.threshold = 127)

Arguments

object
A pixbuf.
colormap
alpha.threshold
Threshold value for opacity values.

Value

A list containing the following elements:
pixmap.return
Location to store a pointer to the created pixmap, or NULL if the pixmap is not needed.
mask.return
Location to store a pointer to the created mask, or NULL if the mask is not needed.

Details

The pixmap that is created uses the GdkColormap specified by colormap. This colormap must match the colormap of the window where the pixmap will eventually be used or an error will result. If the pixbuf does not have an alpha channel, then *mask.return will be set to NULL.