Blame docs/reference/gdk/html/gdk2-Pixbufs.html

Packit Service fb6fa5
Packit Service fb6fa5
<html>
Packit Service fb6fa5
<head>
Packit Service fb6fa5
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit Service fb6fa5
<title>Pixbufs: GDK 2 Reference Manual</title>
Packit Service fb6fa5
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
Packit Service fb6fa5
<link rel="home" href="index.html" title="GDK 2 Reference Manual">
Packit Service fb6fa5
<link rel="up" href="reference.html" title="API Reference">
Packit Service fb6fa5
<link rel="prev" href="gdk2-Images.html" title="Images">
Packit Service fb6fa5
<link rel="next" href="gdk2-Colormaps-and-Colors.html" title="Colormaps and Colors">
Packit Service fb6fa5
<meta name="generator" content="GTK-Doc V1.26.1 (XML mode)">
Packit Service fb6fa5
<link rel="stylesheet" href="style.css" type="text/css">
Packit Service fb6fa5
</head>
Packit Service fb6fa5
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Top  | 
Packit Service fb6fa5
                  Description
Packit Service fb6fa5
Packit Service fb6fa5
Home
Packit Service fb6fa5
Up
Packit Service fb6fa5
Prev
Packit Service fb6fa5
Next
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

Pixbufs

Packit Service fb6fa5

Pixbufs

Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

Functions

Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
void
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
gdk_pixbuf_render_threshold_alpha ()
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
void
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
gdk_pixbuf_render_to_drawable ()
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
void
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
gdk_pixbuf_render_to_drawable_alpha ()
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
void
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
gdk_pixbuf_render_pixmap_and_mask ()
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
void
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
gdk_pixbuf_render_pixmap_and_mask_for_colormap ()
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
GdkPixbuf *
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
gdk_pixbuf_get_from_drawable ()
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
GdkPixbuf *
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
gdk_pixbuf_get_from_image ()
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

Includes

Packit Service fb6fa5
#include <gdk/gdk.h>
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

Description

Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

Functions

Packit Service fb6fa5
Packit Service fb6fa5

gdk_pixbuf_render_threshold_alpha ()

Packit Service fb6fa5
void
Packit Service fb6fa5
gdk_pixbuf_render_threshold_alpha (GdkPixbuf *pixbuf,
Packit Service fb6fa5
                                   GdkBitmap *bitmap,
Packit Service fb6fa5
                                   int src_x,
Packit Service fb6fa5
                                   int src_y,
Packit Service fb6fa5
                                   int dest_x,
Packit Service fb6fa5
                                   int dest_y,
Packit Service fb6fa5
                                   int width,
Packit Service fb6fa5
                                   int height,
Packit Service fb6fa5
                                   int alpha_threshold);
Packit Service fb6fa5

Takes the opacity values in a rectangular portion of a pixbuf and thresholds

Packit Service fb6fa5
them to produce a bi-level alpha mask that can be used as a clipping mask for
Packit Service fb6fa5
a drawable.

Packit Service fb6fa5
Packit Service fb6fa5

Parameters

Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

pixbuf

Packit Service fb6fa5

A pixbuf.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

bitmap

Packit Service fb6fa5

Bitmap where the bilevel mask will be painted to.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

src_x

Packit Service fb6fa5

Source X coordinate.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

src_y

Packit Service fb6fa5

source Y coordinate.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

dest_x

Packit Service fb6fa5

Destination X coordinate.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

dest_y

Packit Service fb6fa5

Destination Y coordinate.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

width

Packit Service fb6fa5

Width of region to threshold, or -1 to use pixbuf width

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

height

Packit Service fb6fa5

Height of region to threshold, or -1 to use pixbuf height

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

alpha_threshold

Packit Service fb6fa5

Opacity values below this will be painted as zero; all

Packit Service fb6fa5
other values will be painted as one.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

Packit Service fb6fa5
Packit Service fb6fa5

gdk_pixbuf_render_to_drawable ()

Packit Service fb6fa5
void
Packit Service fb6fa5
gdk_pixbuf_render_to_drawable (GdkPixbuf *pixbuf,
Packit Service fb6fa5
                               GdkDrawable *drawable,
Packit Service fb6fa5
                               GdkGC *gc,
Packit Service fb6fa5
                               int src_x,
Packit Service fb6fa5
                               int src_y,
Packit Service fb6fa5
                               int dest_x,
Packit Service fb6fa5
                               int dest_y,
Packit Service fb6fa5
                               int width,
Packit Service fb6fa5
                               int height,
Packit Service fb6fa5
                               GdkRgbDither dither,
Packit Service fb6fa5
                               int x_dither,
Packit Service fb6fa5
                               int y_dither);
Packit Service fb6fa5
Packit Service fb6fa5

gdk_pixbuf_render_to_drawable has been deprecated since version 2.4 and should not be used in newly-written code.

Packit Service fb6fa5

This function is obsolete. Use gdk_draw_pixbuf() instead.

Packit Service fb6fa5
Packit Service fb6fa5

Renders a rectangular portion of a pixbuf to a drawable while using the

Packit Service fb6fa5
specified GC.  This is done using GdkRGB, so the specified drawable must have
Packit Service fb6fa5
the GdkRGB visual and colormap.  Note that this function will ignore the
Packit Service fb6fa5
opacity information for images with an alpha channel; the GC must already
Packit Service fb6fa5
have the clipping mask set if you want transparent regions to show through.

Packit Service fb6fa5

For an explanation of dither offsets, see the GdkRGB documentation. In

Packit Service fb6fa5
brief, the dither offset is important when re-rendering partial regions of an
Packit Service fb6fa5
image to a rendered version of the full image, or for when the offsets to a
Packit Service fb6fa5
base position change, as in scrolling.  The dither matrix has to be shifted
Packit Service fb6fa5
for consistent visual results.  If you do not have any of these cases, the
Packit Service fb6fa5
dither offsets can be both zero.

Packit Service fb6fa5
Packit Service fb6fa5

Parameters

Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

pixbuf

Packit Service fb6fa5

A pixbuf.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

drawable

Packit Service fb6fa5

Destination drawable.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

gc

Packit Service fb6fa5

GC used for rendering.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

src_x

Packit Service fb6fa5

Source X coordinate within pixbuf.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

src_y

Packit Service fb6fa5

Source Y coordinate within pixbuf.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

dest_x

Packit Service fb6fa5

Destination X coordinate within drawable.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

dest_y

Packit Service fb6fa5

Destination Y coordinate within drawable.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

width

Packit Service fb6fa5

Width of region to render, in pixels, or -1 to use pixbuf width

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

height

Packit Service fb6fa5

Height of region to render, in pixels, or -1 to use pixbuf height

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

dither

Packit Service fb6fa5

Dithering mode for GdkRGB.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

x_dither

Packit Service fb6fa5

X offset for dither.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

y_dither

Packit Service fb6fa5

Y offset for dither.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

Packit Service fb6fa5
Packit Service fb6fa5

gdk_pixbuf_render_to_drawable_alpha ()

Packit Service fb6fa5
void
Packit Service fb6fa5
gdk_pixbuf_render_to_drawable_alpha (GdkPixbuf *pixbuf,
Packit Service fb6fa5
                                     GdkDrawable *drawable,
Packit Service fb6fa5
                                     int src_x,
Packit Service fb6fa5
                                     int src_y,
Packit Service fb6fa5
                                     int dest_x,
Packit Service fb6fa5
                                     int dest_y,
Packit Service fb6fa5
                                     int width,
Packit Service fb6fa5
                                     int height,
Packit Service fb6fa5
                                     GdkPixbufAlphaMode alpha_mode,
Packit Service fb6fa5
                                     int alpha_threshold,
Packit Service fb6fa5
                                     GdkRgbDither dither,
Packit Service fb6fa5
                                     int x_dither,
Packit Service fb6fa5
                                     int y_dither);
Packit Service fb6fa5
Packit Service fb6fa5

gdk_pixbuf_render_to_drawable_alpha has been deprecated since version 2.4 and should not be used in newly-written code.

Packit Service fb6fa5

This function is obsolete. Use gdk_draw_pixbuf() instead.

Packit Service fb6fa5
Packit Service fb6fa5

Renders a rectangular portion of a pixbuf to a drawable. The destination

Packit Service fb6fa5
drawable must have a colormap. All windows have a colormap, however, pixmaps
Packit Service fb6fa5
only have colormap by default if they were created with a non-NULL window argument.
Packit Service fb6fa5
Otherwise a colormap must be set on them with gdk_drawable_set_colormap.

Packit Service fb6fa5

On older X servers, rendering pixbufs with an alpha channel involves round trips

Packit Service fb6fa5
to the X server, and may be somewhat slow.

Packit Service fb6fa5
Packit Service fb6fa5

Parameters

Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

pixbuf

Packit Service fb6fa5

A pixbuf.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

drawable

Packit Service fb6fa5

Destination drawable.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

src_x

Packit Service fb6fa5

Source X coordinate within pixbuf.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

src_y

Packit Service fb6fa5

Source Y coordinates within pixbuf.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

dest_x

Packit Service fb6fa5

Destination X coordinate within drawable.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

dest_y

Packit Service fb6fa5

Destination Y coordinate within drawable.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

width

Packit Service fb6fa5

Width of region to render, in pixels, or -1 to use pixbuf width.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

height

Packit Service fb6fa5

Height of region to render, in pixels, or -1 to use pixbuf height.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

alpha_mode

Packit Service fb6fa5

Ignored. Present for backwards compatibility.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

alpha_threshold

Packit Service fb6fa5

Ignored. Present for backwards compatibility

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

dither

Packit Service fb6fa5

Dithering mode for GdkRGB.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

x_dither

Packit Service fb6fa5

X offset for dither.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

y_dither

Packit Service fb6fa5

Y offset for dither.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

Packit Service fb6fa5
Packit Service fb6fa5

gdk_pixbuf_render_pixmap_and_mask ()

Packit Service fb6fa5
void
Packit Service fb6fa5
gdk_pixbuf_render_pixmap_and_mask (GdkPixbuf *pixbuf,
Packit Service fb6fa5
                                   GdkPixmap **pixmap_return,
Packit Service fb6fa5
                                   GdkBitmap **mask_return,
Packit Service fb6fa5
                                   int alpha_threshold);
Packit Service fb6fa5

Creates a pixmap and a mask bitmap which are returned in the pixmap_return

Packit Service fb6fa5
Packit Service fb6fa5
and mask_return
Packit Service fb6fa5
 arguments, respectively, and renders a pixbuf and its
Packit Service fb6fa5
corresponding thresholded alpha mask to them.  This is merely a convenience
Packit Service fb6fa5
function; applications that need to render pixbufs with dither offsets or to
Packit Service fb6fa5
given drawables should use gdk_draw_pixbuf() and gdk_pixbuf_render_threshold_alpha().

Packit Service fb6fa5

The pixmap that is created is created for the colormap returned

Packit Service fb6fa5
by gdk_rgb_get_colormap(). You normally will want to instead use
Packit Service fb6fa5
the actual colormap for a widget, and use
Packit Service fb6fa5
gdk_pixbuf_render_pixmap_and_mask_for_colormap().

Packit Service fb6fa5

If the pixbuf does not have an alpha channel, then *mask_return

Packit Service fb6fa5
 will be set
Packit Service fb6fa5
to NULL.

Packit Service fb6fa5
Packit Service fb6fa5

Parameters

Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

pixbuf

Packit Service fb6fa5

A pixbuf.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

pixmap_return

Packit Service fb6fa5

Location to store a pointer to the created pixmap,

Packit Service fb6fa5
or NULL if the pixmap is not needed.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

mask_return

Packit Service fb6fa5

Location to store a pointer to the created mask,

Packit Service fb6fa5
or NULL if the mask is not needed.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

alpha_threshold

Packit Service fb6fa5

Threshold value for opacity values.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

Packit Service fb6fa5
Packit Service fb6fa5

gdk_pixbuf_render_pixmap_and_mask_for_colormap ()

Packit Service fb6fa5
void
Packit Service fb6fa5
gdk_pixbuf_render_pixmap_and_mask_for_colormap
Packit Service fb6fa5
                               (GdkPixbuf *pixbuf,
Packit Service fb6fa5
                                GdkColormap *colormap,
Packit Service fb6fa5
                                GdkPixmap **pixmap_return,
Packit Service fb6fa5
                                GdkBitmap **mask_return,
Packit Service fb6fa5
                                int alpha_threshold);
Packit Service fb6fa5

gdk_pixbuf_render_pixmap_and_mask_for_colormap is deprecated and should not be used in newly-written code.

Packit Service fb6fa5

Creates a pixmap and a mask bitmap which are returned in the pixmap_return

Packit Service fb6fa5
Packit Service fb6fa5
and mask_return
Packit Service fb6fa5
 arguments, respectively, and renders a pixbuf and its
Packit Service fb6fa5
corresponding tresholded alpha mask to them.  This is merely a convenience
Packit Service fb6fa5
function; applications that need to render pixbufs with dither offsets or to
Packit Service fb6fa5
given drawables should use gdk_draw_pixbuf(), and gdk_pixbuf_render_threshold_alpha().

Packit Service fb6fa5

The pixmap that is created uses the GdkColormap specified by colormap

Packit Service fb6fa5
.
Packit Service fb6fa5
This colormap must match the colormap of the window where the pixmap
Packit Service fb6fa5
will eventually be used or an error will result.

Packit Service fb6fa5

If the pixbuf does not have an alpha channel, then *mask_return

Packit Service fb6fa5
 will be set
Packit Service fb6fa5
to NULL.

Packit Service fb6fa5
Packit Service fb6fa5

Parameters

Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

pixbuf

Packit Service fb6fa5

A pixbuf.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

colormap

Packit Service fb6fa5

A GdkColormap

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

pixmap_return

Packit Service fb6fa5

Location to store a pointer to the created pixmap,

Packit Service fb6fa5
or NULL if the pixmap is not needed.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

mask_return

Packit Service fb6fa5

Location to store a pointer to the created mask,

Packit Service fb6fa5
or NULL if the mask is not needed.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

alpha_threshold

Packit Service fb6fa5

Threshold value for opacity values.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

Packit Service fb6fa5
Packit Service fb6fa5

gdk_pixbuf_get_from_drawable ()

Packit Service fb6fa5
GdkPixbuf *
Packit Service fb6fa5
gdk_pixbuf_get_from_drawable (GdkPixbuf *dest,
Packit Service fb6fa5
                              GdkDrawable *src,
Packit Service fb6fa5
                              GdkColormap *cmap,
Packit Service fb6fa5
                              int src_x,
Packit Service fb6fa5
                              int src_y,
Packit Service fb6fa5
                              int dest_x,
Packit Service fb6fa5
                              int dest_y,
Packit Service fb6fa5
                              int width,
Packit Service fb6fa5
                              int height);
Packit Service fb6fa5

Transfers image data from a GdkDrawable and converts it to an RGB(A)

Packit Service fb6fa5
representation inside a GdkPixbuf. In other words, copies
Packit Service fb6fa5
image data from a server-side drawable to a client-side RGB(A) buffer.
Packit Service fb6fa5
This allows you to efficiently read individual pixels on the client side.

Packit Service fb6fa5

If the drawable src

Packit Service fb6fa5
 has no colormap (gdk_drawable_get_colormap()
Packit Service fb6fa5
returns NULL), then a suitable colormap must be specified.
Packit Service fb6fa5
Typically a GdkWindow or a pixmap created by passing a GdkWindow
Packit Service fb6fa5
to gdk_pixmap_new() will already have a colormap associated with
Packit Service fb6fa5
it.  If the drawable has a colormap, the cmap
Packit Service fb6fa5
 argument will be
Packit Service fb6fa5
ignored.  If the drawable is a bitmap (1 bit per pixel pixmap),
Packit Service fb6fa5
then a colormap is not required; pixels with a value of 1 are
Packit Service fb6fa5
assumed to be white, and pixels with a value of 0 are assumed to be
Packit Service fb6fa5
black. For taking screenshots, gdk_colormap_get_system() returns
Packit Service fb6fa5
the correct colormap to use.

Packit Service fb6fa5

If the specified destination pixbuf dest

Packit Service fb6fa5
 is NULL, then this
Packit Service fb6fa5
function will create an RGB pixbuf with 8 bits per channel and no
Packit Service fb6fa5
alpha, with the same size specified by the width
Packit Service fb6fa5
 and height
Packit Service fb6fa5
Packit Service fb6fa5
arguments.  In this case, the dest_x
Packit Service fb6fa5
 and dest_y
Packit Service fb6fa5
 arguments must be
Packit Service fb6fa5
specified as 0.  If the specified destination pixbuf is not NULL
Packit Service fb6fa5
and it contains alpha information, then the filled pixels will be
Packit Service fb6fa5
set to full opacity (alpha = 255).

Packit Service fb6fa5

If the specified drawable is a pixmap, then the requested source

Packit Service fb6fa5
rectangle must be completely contained within the pixmap, otherwise
Packit Service fb6fa5
the function will return NULL. For pixmaps only (not for windows)
Packit Service fb6fa5
passing -1 for width or height is allowed to mean the full width
Packit Service fb6fa5
or height of the pixmap.

Packit Service fb6fa5

If the specified drawable is a window, and the window is off the

Packit Service fb6fa5
screen, then there is no image data in the obscured/offscreen
Packit Service fb6fa5
regions to be placed in the pixbuf. The contents of portions of the
Packit Service fb6fa5
pixbuf corresponding to the offscreen region are undefined.

Packit Service fb6fa5

If the window you're obtaining data from is partially obscured by

Packit Service fb6fa5
other windows, then the contents of the pixbuf areas corresponding
Packit Service fb6fa5
to the obscured regions are undefined.

Packit Service fb6fa5

If the target drawable is not mapped (typically because it's

Packit Service fb6fa5
iconified/minimized or not on the current workspace), then NULL
Packit Service fb6fa5
will be returned.

Packit Service fb6fa5

If memory can't be allocated for the return value, NULL will be returned

Packit Service fb6fa5
instead.

Packit Service fb6fa5

(In short, there are several ways this function can fail, and if it fails

Packit Service fb6fa5
 it returns NULL; so check the return value.)

Packit Service fb6fa5

This function calls gdk_drawable_get_image() internally and

Packit Service fb6fa5
converts the resulting image to a GdkPixbuf, so the
Packit Service fb6fa5
documentation for gdk_drawable_get_image() may also be relevant.

Packit Service fb6fa5
Packit Service fb6fa5

Parameters

Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

dest

Packit Service fb6fa5

Destination pixbuf, or NULL if a new pixbuf should be created.

Packit Service fb6fa5
[allow-none]
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

src

Packit Service fb6fa5

Source drawable.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

cmap

Packit Service fb6fa5

A colormap if src

Packit Service fb6fa5
doesn't have one set.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

src_x

Packit Service fb6fa5

Source X coordinate within drawable.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

src_y

Packit Service fb6fa5

Source Y coordinate within drawable.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

dest_x

Packit Service fb6fa5

Destination X coordinate in pixbuf, or 0 if dest

Packit Service fb6fa5
is NULL.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

dest_y

Packit Service fb6fa5

Destination Y coordinate in pixbuf, or 0 if dest

Packit Service fb6fa5
is NULL.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

width

Packit Service fb6fa5

Width in pixels of region to get.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

height

Packit Service fb6fa5

Height in pixels of region to get.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

Returns

Packit Service fb6fa5

The same pixbuf as dest

Packit Service fb6fa5
if it was non-NULL, or a newly-created
Packit Service fb6fa5
pixbuf with a reference count of 1 if no destination pixbuf was specified, or NULL on error

Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

Packit Service fb6fa5
Packit Service fb6fa5

gdk_pixbuf_get_from_image ()

Packit Service fb6fa5
GdkPixbuf *
Packit Service fb6fa5
gdk_pixbuf_get_from_image (GdkPixbuf *dest,
Packit Service fb6fa5
                           GdkImage *src,
Packit Service fb6fa5
                           GdkColormap *cmap,
Packit Service fb6fa5
                           int src_x,
Packit Service fb6fa5
                           int src_y,
Packit Service fb6fa5
                           int dest_x,
Packit Service fb6fa5
                           int dest_y,
Packit Service fb6fa5
                           int width,
Packit Service fb6fa5
                           int height);
Packit Service fb6fa5

Same as gdk_pixbuf_get_from_drawable() but gets the pixbuf from

Packit Service fb6fa5
an image.

Packit Service fb6fa5
Packit Service fb6fa5

Parameters

Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

dest

Packit Service fb6fa5

Destination pixbuf, or NULL if a new pixbuf should be created.

Packit Service fb6fa5
[allow-none]
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

src

Packit Service fb6fa5

Source GdkImage.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

cmap

Packit Service fb6fa5

A colormap, or NULL to use the one for src

Packit Service fb6fa5
. 

Packit Service fb6fa5
[allow-none]
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

src_x

Packit Service fb6fa5

Source X coordinate within drawable.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

src_y

Packit Service fb6fa5

Source Y coordinate within drawable.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

dest_x

Packit Service fb6fa5

Destination X coordinate in pixbuf, or 0 if dest

Packit Service fb6fa5
is NULL.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

dest_y

Packit Service fb6fa5

Destination Y coordinate in pixbuf, or 0 if dest

Packit Service fb6fa5
is NULL.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

width

Packit Service fb6fa5

Width in pixels of region to get.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

height

Packit Service fb6fa5

Height in pixels of region to get.

Packit Service fb6fa5
 
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

Returns

Packit Service fb6fa5

dest

Packit Service fb6fa5
, newly-created pixbuf if dest
Packit Service fb6fa5
was NULL, NULL on error

Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

Types and Values

Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5
Packit Service fb6fa5

Generated by GTK-Doc V1.26.1
Packit Service fb6fa5
</body>
Packit Service fb6fa5
</html>