mirror of
https://gitlab.gnome.org/GNOME/gtk.git
synced 2024-11-11 03:10:09 +00:00
eacd03aef2
2001-10-02 Havoc Pennington <hp@redhat.com>
Throughout: assorted docs
* gdk/gdkwindow.h: deprecate gdk_window_set_hints(), it's broken,
gdk_window_set_geometry_hints() should be used instead.
* gdk/gdkimage.h: deprecate gdk_image_ref, gdk_image_unref, and
document them
* gdk/x11/gdkx.h: remove gdk_get_client_window() since it doesn't
seem to exist in any .c files
* gdk/x11/gdkcolor-x11.c (gdk_colormap_query_color): docs,
g_return_if_fail (pixel < colormap->size).
779 lines
22 KiB
C
779 lines
22 KiB
C
/* GDK - The GIMP Drawing Kit
|
|
* Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2 of the License, or (at your option) any later version.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, write to the
|
|
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
* Boston, MA 02111-1307, USA.
|
|
*/
|
|
|
|
/*
|
|
* Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
|
|
* file for a list of people on the GTK+ Team. See the ChangeLog
|
|
* files for a list of changes. These files are distributed with
|
|
* GTK+ at ftp://ftp.gtk.org/pub/gtk/.
|
|
*/
|
|
|
|
#include "gdkdrawable.h"
|
|
#include "gdkinternals.h"
|
|
#include "gdkwindow.h"
|
|
|
|
static GdkDrawable* gdk_drawable_real_get_composite_drawable (GdkDrawable *drawable,
|
|
gint x,
|
|
gint y,
|
|
gint width,
|
|
gint height,
|
|
gint *composite_x_offset,
|
|
gint *composite_y_offset);
|
|
static GdkRegion * gdk_drawable_real_get_visible_region (GdkDrawable *drawable);
|
|
|
|
static void gdk_drawable_class_init (GdkDrawableClass *klass);
|
|
|
|
GType
|
|
gdk_drawable_get_type (void)
|
|
{
|
|
static GType object_type = 0;
|
|
|
|
if (!object_type)
|
|
{
|
|
static const GTypeInfo object_info =
|
|
{
|
|
sizeof (GdkDrawableClass),
|
|
(GBaseInitFunc) NULL,
|
|
(GBaseFinalizeFunc) NULL,
|
|
(GClassInitFunc) gdk_drawable_class_init,
|
|
NULL, /* class_finalize */
|
|
NULL, /* class_data */
|
|
sizeof (GdkDrawable),
|
|
0, /* n_preallocs */
|
|
(GInstanceInitFunc) NULL,
|
|
};
|
|
|
|
object_type = g_type_register_static (G_TYPE_OBJECT,
|
|
"GdkDrawable",
|
|
&object_info, 0);
|
|
}
|
|
|
|
return object_type;
|
|
}
|
|
|
|
static void
|
|
gdk_drawable_class_init (GdkDrawableClass *klass)
|
|
{
|
|
klass->get_composite_drawable = gdk_drawable_real_get_composite_drawable;
|
|
/* Default implementation for clip and visible region is the same */
|
|
klass->get_clip_region = gdk_drawable_real_get_visible_region;
|
|
klass->get_visible_region = gdk_drawable_real_get_visible_region;
|
|
}
|
|
|
|
/* Manipulation of drawables
|
|
*/
|
|
|
|
/**
|
|
* gdk_drawable_set_data:
|
|
* @drawable: a #GdkDrawable
|
|
* @key: name to store the data under
|
|
* @data: arbitrary data
|
|
* @destroy_func: function to free @data, or %NULL
|
|
*
|
|
* This function is equivalent to g_object_set_data(),
|
|
* the #GObject variant should be used instead.
|
|
*
|
|
**/
|
|
void
|
|
gdk_drawable_set_data (GdkDrawable *drawable,
|
|
const gchar *key,
|
|
gpointer data,
|
|
GDestroyNotify destroy_func)
|
|
{
|
|
g_return_if_fail (GDK_IS_DRAWABLE (drawable));
|
|
|
|
g_object_set_qdata_full (G_OBJECT (drawable),
|
|
g_quark_from_string (key),
|
|
data,
|
|
destroy_func);
|
|
}
|
|
|
|
/**
|
|
* gdk_drawable_get_data:
|
|
* @drawable: a #GdkDrawable
|
|
* @key: name the data was stored under
|
|
*
|
|
* Equivalent to g_object_get_data(); the #GObject variant should be
|
|
* used instead.
|
|
*
|
|
* Return value: the data stored at @key
|
|
**/
|
|
gpointer
|
|
gdk_drawable_get_data (GdkDrawable *drawable,
|
|
const gchar *key)
|
|
{
|
|
g_return_val_if_fail (GDK_IS_DRAWABLE (drawable), NULL);
|
|
|
|
return g_object_get_qdata (G_OBJECT (drawable),
|
|
g_quark_try_string (key));
|
|
}
|
|
|
|
/**
|
|
* gdk_drawable_get_size:
|
|
* @drawable: a #GdkDrawable
|
|
* @width: location to store drawable's width, or %NULL
|
|
* @height: location to store drawable's height, or %NULL
|
|
*
|
|
* Fills *@width and *@height with the size of @drawable.
|
|
* @width or @height can be %NULL if you only want the other one.
|
|
*
|
|
* On the X11 platform, if @drawable is a #GdkWindow, the returned
|
|
* size is the size reported in the most-recently-processed configure
|
|
* event, rather than the current size on the X server.
|
|
*
|
|
**/
|
|
void
|
|
gdk_drawable_get_size (GdkDrawable *drawable,
|
|
gint *width,
|
|
gint *height)
|
|
{
|
|
g_return_if_fail (GDK_IS_DRAWABLE (drawable));
|
|
|
|
GDK_DRAWABLE_GET_CLASS (drawable)->get_size (drawable, width, height);
|
|
}
|
|
|
|
/**
|
|
* gdk_drawable_get_visual:
|
|
* @drawable: a #GdkDrawable
|
|
*
|
|
* Gets the #GdkVisual describing the pixel format of @drawable.
|
|
*
|
|
* Return value: a #GdkVisual
|
|
**/
|
|
GdkVisual*
|
|
gdk_drawable_get_visual (GdkDrawable *drawable)
|
|
{
|
|
g_return_val_if_fail (GDK_IS_DRAWABLE (drawable), NULL);
|
|
|
|
return GDK_DRAWABLE_GET_CLASS (drawable)->get_visual (drawable);
|
|
}
|
|
|
|
/**
|
|
* gdk_drawable_get_depth:
|
|
* @drawable: a #GdkDrawable
|
|
*
|
|
* Obtains the bit depth of the drawable, that is, the number of bits
|
|
* that make up a pixel in the drawable's visual. Examples are 8 bits
|
|
* per pixel, 24 bits per pixel, etc.
|
|
*
|
|
* Return value: number of bits per pixel
|
|
**/
|
|
gint
|
|
gdk_drawable_get_depth (GdkDrawable *drawable)
|
|
{
|
|
g_return_val_if_fail (GDK_IS_DRAWABLE (drawable), 0);
|
|
|
|
return GDK_DRAWABLE_GET_CLASS (drawable)->get_depth (drawable);
|
|
}
|
|
|
|
/**
|
|
* gdk_drawable_set_colormap:
|
|
* @drawable: a #GdkDrawable
|
|
* @colormap: a #GdkColormap
|
|
*
|
|
* Sets the colormap associated with @drawable. Normally this will
|
|
* happen automatically when the drawable is created; you only need to
|
|
* use this function if the drawable-creating function did not have a
|
|
* way to determine the colormap, and you then use drawable operations
|
|
* that require a colormap. The colormap for all drawables and
|
|
* graphics contexts you intend to use together should match. i.e.
|
|
* when using a #GdkGC to draw to a drawable, or copying one drawable
|
|
* to another, the colormaps should match.
|
|
*
|
|
**/
|
|
void
|
|
gdk_drawable_set_colormap (GdkDrawable *drawable,
|
|
GdkColormap *cmap)
|
|
{
|
|
g_return_if_fail (GDK_IS_DRAWABLE (drawable));
|
|
g_return_if_fail (cmap == NULL || gdk_drawable_get_depth (drawable)
|
|
== cmap->visual->depth);
|
|
|
|
GDK_DRAWABLE_GET_CLASS (drawable)->set_colormap (drawable, cmap);
|
|
}
|
|
|
|
/**
|
|
* gdk_drawable_get_colormap:
|
|
* @drawable: a #GdkDrawable
|
|
*
|
|
* Gets the colormap for @drawable, if one is set; returns
|
|
* %NULL otherwise.
|
|
*
|
|
* Return value: the colormap, or %NULL
|
|
**/
|
|
GdkColormap*
|
|
gdk_drawable_get_colormap (GdkDrawable *drawable)
|
|
{
|
|
g_return_val_if_fail (GDK_IS_DRAWABLE (drawable), NULL);
|
|
|
|
return GDK_DRAWABLE_GET_CLASS (drawable)->get_colormap (drawable);
|
|
}
|
|
|
|
/**
|
|
* gdk_drawable_ref:
|
|
* @drawable: a #GdkDrawable
|
|
*
|
|
* Deprecated equivalent of calling g_object_ref() on @drawable.
|
|
* (Drawables were not objects in previous versions of GDK.)
|
|
*
|
|
* Return value: the same @drawable passed in
|
|
**/
|
|
GdkDrawable*
|
|
gdk_drawable_ref (GdkDrawable *drawable)
|
|
{
|
|
return (GdkDrawable *) g_object_ref (G_OBJECT (drawable));
|
|
}
|
|
|
|
/**
|
|
* gdk_drawable_unref:
|
|
* @drawable: a #GdkDrawable
|
|
*
|
|
* Deprecated equivalent of calling g_object_unref() on @drawable.
|
|
*
|
|
**/
|
|
void
|
|
gdk_drawable_unref (GdkDrawable *drawable)
|
|
{
|
|
g_return_if_fail (GDK_IS_DRAWABLE (drawable));
|
|
|
|
g_object_unref (G_OBJECT (drawable));
|
|
}
|
|
|
|
/* Drawing
|
|
*/
|
|
void
|
|
gdk_draw_point (GdkDrawable *drawable,
|
|
GdkGC *gc,
|
|
gint x,
|
|
gint y)
|
|
{
|
|
GdkPoint point;
|
|
|
|
g_return_if_fail (GDK_IS_DRAWABLE (drawable));
|
|
g_return_if_fail (GDK_IS_GC (gc));
|
|
|
|
point.x = x;
|
|
point.y = y;
|
|
|
|
GDK_DRAWABLE_GET_CLASS (drawable)->draw_points (drawable, gc, &point, 1);
|
|
}
|
|
|
|
void
|
|
gdk_draw_line (GdkDrawable *drawable,
|
|
GdkGC *gc,
|
|
gint x1,
|
|
gint y1,
|
|
gint x2,
|
|
gint y2)
|
|
{
|
|
GdkSegment segment;
|
|
|
|
g_return_if_fail (drawable != NULL);
|
|
g_return_if_fail (gc != NULL);
|
|
g_return_if_fail (GDK_IS_DRAWABLE (drawable));
|
|
g_return_if_fail (GDK_IS_GC (gc));
|
|
|
|
segment.x1 = x1;
|
|
segment.y1 = y1;
|
|
segment.x2 = x2;
|
|
segment.y2 = y2;
|
|
GDK_DRAWABLE_GET_CLASS (drawable)->draw_segments (drawable, gc, &segment, 1);
|
|
}
|
|
|
|
void
|
|
gdk_draw_rectangle (GdkDrawable *drawable,
|
|
GdkGC *gc,
|
|
gint filled,
|
|
gint x,
|
|
gint y,
|
|
gint width,
|
|
gint height)
|
|
{
|
|
g_return_if_fail (GDK_IS_DRAWABLE (drawable));
|
|
g_return_if_fail (GDK_IS_GC (gc));
|
|
|
|
if (width < 0 || height < 0)
|
|
{
|
|
gint real_width;
|
|
gint real_height;
|
|
|
|
gdk_drawable_get_size (drawable, &real_width, &real_height);
|
|
|
|
if (width < 0)
|
|
width = real_width;
|
|
if (height < 0)
|
|
height = real_height;
|
|
}
|
|
|
|
GDK_DRAWABLE_GET_CLASS (drawable)->draw_rectangle (drawable, gc, filled, x, y,
|
|
width, height);
|
|
}
|
|
|
|
void
|
|
gdk_draw_arc (GdkDrawable *drawable,
|
|
GdkGC *gc,
|
|
gint filled,
|
|
gint x,
|
|
gint y,
|
|
gint width,
|
|
gint height,
|
|
gint angle1,
|
|
gint angle2)
|
|
{
|
|
g_return_if_fail (GDK_IS_DRAWABLE (drawable));
|
|
g_return_if_fail (GDK_IS_GC (gc));
|
|
|
|
if (width < 0 || height < 0)
|
|
{
|
|
gint real_width;
|
|
gint real_height;
|
|
|
|
gdk_drawable_get_size (drawable, &real_width, &real_height);
|
|
|
|
if (width < 0)
|
|
width = real_width;
|
|
if (height < 0)
|
|
height = real_height;
|
|
}
|
|
|
|
GDK_DRAWABLE_GET_CLASS (drawable)->draw_arc (drawable, gc, filled,
|
|
x, y, width, height, angle1, angle2);
|
|
}
|
|
|
|
void
|
|
gdk_draw_polygon (GdkDrawable *drawable,
|
|
GdkGC *gc,
|
|
gint filled,
|
|
GdkPoint *points,
|
|
gint npoints)
|
|
{
|
|
g_return_if_fail (GDK_IS_DRAWABLE (drawable));
|
|
g_return_if_fail (GDK_IS_GC (gc));
|
|
|
|
GDK_DRAWABLE_GET_CLASS (drawable)->draw_polygon (drawable, gc, filled,
|
|
points, npoints);
|
|
}
|
|
|
|
/* gdk_draw_string
|
|
*
|
|
* Modified by Li-Da Lho to draw 16 bits and Multibyte strings
|
|
*
|
|
* Interface changed: add "GdkFont *font" to specify font or fontset explicitely
|
|
*/
|
|
void
|
|
gdk_draw_string (GdkDrawable *drawable,
|
|
GdkFont *font,
|
|
GdkGC *gc,
|
|
gint x,
|
|
gint y,
|
|
const gchar *string)
|
|
{
|
|
gdk_draw_text (drawable, font, gc, x, y, string, _gdk_font_strlen (font, string));
|
|
}
|
|
|
|
/* gdk_draw_text
|
|
*
|
|
* Modified by Li-Da Lho to draw 16 bits and Multibyte strings
|
|
*
|
|
* Interface changed: add "GdkFont *font" to specify font or fontset explicitely
|
|
*/
|
|
void
|
|
gdk_draw_text (GdkDrawable *drawable,
|
|
GdkFont *font,
|
|
GdkGC *gc,
|
|
gint x,
|
|
gint y,
|
|
const gchar *text,
|
|
gint text_length)
|
|
{
|
|
g_return_if_fail (GDK_IS_DRAWABLE (drawable));
|
|
g_return_if_fail (font != NULL);
|
|
g_return_if_fail (GDK_IS_GC (gc));
|
|
g_return_if_fail (text != NULL);
|
|
|
|
GDK_DRAWABLE_GET_CLASS (drawable)->draw_text (drawable, font, gc, x, y, text, text_length);
|
|
}
|
|
|
|
void
|
|
gdk_draw_text_wc (GdkDrawable *drawable,
|
|
GdkFont *font,
|
|
GdkGC *gc,
|
|
gint x,
|
|
gint y,
|
|
const GdkWChar *text,
|
|
gint text_length)
|
|
{
|
|
g_return_if_fail (GDK_IS_DRAWABLE (drawable));
|
|
g_return_if_fail (font != NULL);
|
|
g_return_if_fail (GDK_IS_GC (gc));
|
|
g_return_if_fail (text != NULL);
|
|
|
|
GDK_DRAWABLE_GET_CLASS (drawable)->draw_text_wc (drawable, font, gc, x, y, text, text_length);
|
|
}
|
|
|
|
/**
|
|
* gdk_draw_drawable:
|
|
* @drawable: a #GdkDrawable
|
|
* @gc: a #GdkGC sharing the drawable's visual and colormap
|
|
* @src: another #GdkDrawable
|
|
* @xsrc: X position in @src of rectangle to draw
|
|
* @ysrc: Y position in @src of rectangle to draw
|
|
* @xdest: X position in @drawable where the rectangle should be drawn
|
|
* @ydest: Y position in @drawable where the rectangle should be drawn
|
|
* @width: width of rectangle to draw, or -1 for entire @src width
|
|
* @height: height of rectangle to draw, or -1 for entire @src height
|
|
*
|
|
* Copies the @width x @height region of @src at coordinates (@xsrc,
|
|
* @ysrc) to coordinates (@xdest, @ydest) in @drawable.
|
|
* @width and/or @height may be given as -1, in which case the entire
|
|
* @src drawable will be copied.
|
|
*
|
|
* Most fields in @gc are not used for this operation, but notably the
|
|
* clip mask or clip region will be honored.
|
|
*
|
|
* The source and destination drawables must have the same visual and
|
|
* colormap, or errors will result. (On X11, failure to match
|
|
* visual/colormap results in a BadMatch error from the X server.)
|
|
* A common cause of this problem is an attempt to draw a bitmap to
|
|
* a color drawable. The way to draw a bitmap is to set the
|
|
* bitmap as a clip mask on your #GdkGC, then use gdk_draw_rectangle()
|
|
* to draw a rectangle clipped to the bitmap.
|
|
**/
|
|
void
|
|
gdk_draw_drawable (GdkDrawable *drawable,
|
|
GdkGC *gc,
|
|
GdkDrawable *src,
|
|
gint xsrc,
|
|
gint ysrc,
|
|
gint xdest,
|
|
gint ydest,
|
|
gint width,
|
|
gint height)
|
|
{
|
|
GdkDrawable *composite;
|
|
gint composite_x_offset = 0;
|
|
gint composite_y_offset = 0;
|
|
|
|
g_return_if_fail (GDK_IS_DRAWABLE (drawable));
|
|
g_return_if_fail (src != NULL);
|
|
g_return_if_fail (GDK_IS_GC (gc));
|
|
|
|
if (width < 0 || height < 0)
|
|
{
|
|
gint real_width;
|
|
gint real_height;
|
|
|
|
gdk_drawable_get_size (src, &real_width, &real_height);
|
|
|
|
if (width < 0)
|
|
width = real_width;
|
|
if (height < 0)
|
|
height = real_height;
|
|
}
|
|
|
|
|
|
composite =
|
|
GDK_DRAWABLE_GET_CLASS (src)->get_composite_drawable (src,
|
|
xsrc, ysrc,
|
|
width, height,
|
|
&composite_x_offset,
|
|
&composite_y_offset);
|
|
|
|
|
|
GDK_DRAWABLE_GET_CLASS (drawable)->draw_drawable (drawable, gc, composite,
|
|
xsrc - composite_x_offset,
|
|
ysrc - composite_y_offset,
|
|
xdest, ydest,
|
|
width, height);
|
|
|
|
g_object_unref (G_OBJECT (composite));
|
|
}
|
|
|
|
void
|
|
gdk_draw_image (GdkDrawable *drawable,
|
|
GdkGC *gc,
|
|
GdkImage *image,
|
|
gint xsrc,
|
|
gint ysrc,
|
|
gint xdest,
|
|
gint ydest,
|
|
gint width,
|
|
gint height)
|
|
{
|
|
g_return_if_fail (GDK_IS_DRAWABLE (drawable));
|
|
g_return_if_fail (image != NULL);
|
|
g_return_if_fail (GDK_IS_GC (gc));
|
|
|
|
if (width == -1)
|
|
width = image->width;
|
|
if (height == -1)
|
|
height = image->height;
|
|
|
|
GDK_DRAWABLE_GET_CLASS (drawable)->draw_image (drawable, gc, image, xsrc, ysrc,
|
|
xdest, ydest, width, height);
|
|
}
|
|
|
|
void
|
|
gdk_draw_points (GdkDrawable *drawable,
|
|
GdkGC *gc,
|
|
GdkPoint *points,
|
|
gint npoints)
|
|
{
|
|
g_return_if_fail (GDK_IS_DRAWABLE (drawable));
|
|
g_return_if_fail ((points != NULL) && (npoints > 0));
|
|
g_return_if_fail (GDK_IS_GC (gc));
|
|
g_return_if_fail (npoints >= 0);
|
|
|
|
if (npoints == 0)
|
|
return;
|
|
|
|
GDK_DRAWABLE_GET_CLASS (drawable)->draw_points (drawable, gc, points, npoints);
|
|
}
|
|
|
|
void
|
|
gdk_draw_segments (GdkDrawable *drawable,
|
|
GdkGC *gc,
|
|
GdkSegment *segs,
|
|
gint nsegs)
|
|
{
|
|
g_return_if_fail (GDK_IS_DRAWABLE (drawable));
|
|
|
|
if (nsegs == 0)
|
|
return;
|
|
|
|
g_return_if_fail (segs != NULL);
|
|
g_return_if_fail (GDK_IS_GC (gc));
|
|
g_return_if_fail (nsegs >= 0);
|
|
|
|
GDK_DRAWABLE_GET_CLASS (drawable)->draw_segments (drawable, gc, segs, nsegs);
|
|
}
|
|
|
|
void
|
|
gdk_draw_lines (GdkDrawable *drawable,
|
|
GdkGC *gc,
|
|
GdkPoint *points,
|
|
gint npoints)
|
|
{
|
|
|
|
g_return_if_fail (GDK_IS_DRAWABLE (drawable));
|
|
g_return_if_fail (points != NULL);
|
|
g_return_if_fail (GDK_IS_GC (gc));
|
|
g_return_if_fail (npoints >= 0);
|
|
|
|
if (npoints == 0)
|
|
return;
|
|
|
|
GDK_DRAWABLE_GET_CLASS (drawable)->draw_lines (drawable, gc, points, npoints);
|
|
}
|
|
|
|
/**
|
|
* gdk_draw_glyphs:
|
|
* @drawable: a #GdkDrawable
|
|
* @gc: a #GdkGC
|
|
* @font: font to be used
|
|
* @x: X coordinate of baseline origin
|
|
* @y: Y coordinate of baseline origin
|
|
* @glyphs: glyphs to render
|
|
*
|
|
* This is a low-level function; 99% of text rendering should be done
|
|
* using gdk_draw_layout() instead.
|
|
*
|
|
* A glyph is a character in a font. This function draws a sequence of
|
|
* glyphs. To obtain a sequence of glyphs you have to understand a
|
|
* lot about internationalized text handling, which you don't want to
|
|
* understand; thus, use gdk_draw_layout() instead of this function,
|
|
* gdk_draw_layout() handles the details.
|
|
*
|
|
**/
|
|
void
|
|
gdk_draw_glyphs (GdkDrawable *drawable,
|
|
GdkGC *gc,
|
|
PangoFont *font,
|
|
gint x,
|
|
gint y,
|
|
PangoGlyphString *glyphs)
|
|
{
|
|
g_return_if_fail (GDK_IS_DRAWABLE (drawable));
|
|
g_return_if_fail (GDK_IS_GC (gc));
|
|
|
|
|
|
GDK_DRAWABLE_GET_CLASS (drawable)->draw_glyphs (drawable, gc, font, x, y, glyphs);
|
|
}
|
|
|
|
|
|
/**
|
|
* gdk_drawable_get_image:
|
|
* @drawable: a #GdkDrawable
|
|
* @x: x coordinate on @drawable
|
|
* @y: y coordinate on @drawable
|
|
* @width: width of region to get
|
|
* @height: height or region to get
|
|
*
|
|
* A #GdkImage stores client-side image data (pixels). In contrast,
|
|
* #GdkPixmap and #GdkWindow are server-side
|
|
* objects. gdk_drawable_get_image() obtains the pixels from a
|
|
* server-side drawable as a client-side #GdkImage. The format of a
|
|
* #GdkImage depends on the #GdkVisual of the current display, which
|
|
* makes manipulating #GdkImage extremely difficult; therefore, in
|
|
* most cases you should use gdk_pixbuf_get_from_drawable() instead of
|
|
* this lower-level function. A #GdkPixbuf contains image data in a
|
|
* canonicalized RGB format, rather than a display-dependent format.
|
|
* Of course, there's a convenience vs. speed tradeoff here, so you'll
|
|
* want to think about what makes sense for your application.
|
|
*
|
|
* @x, @y, @width, and @height define the region of @drawable to
|
|
* obtain as an image.
|
|
*
|
|
* You would usually copy image data to the client side if you intend
|
|
* to examine the values of individual pixels, for example to darken
|
|
* an image or add a red tint. It would be prohibitively slow to
|
|
* make a round-trip request to the windowing system for each pixel,
|
|
* so instead you get all of them at once, modify them, then copy
|
|
* them all back at once.
|
|
*
|
|
* If the X server or other windowing system backend is on the local
|
|
* machine, this function may use shared memory to avoid copying
|
|
* the image data.
|
|
*
|
|
* If the source drawable is a #GdkWindow and partially offscreen
|
|
* or obscured, then the obscured portions of the returned image
|
|
* will contain undefined data.
|
|
*
|
|
* Return value: a #GdkImage containing the contents of @drawable
|
|
**/
|
|
GdkImage*
|
|
gdk_drawable_get_image (GdkDrawable *drawable,
|
|
gint x,
|
|
gint y,
|
|
gint width,
|
|
gint height)
|
|
{
|
|
GdkDrawable *composite;
|
|
gint composite_x_offset = 0;
|
|
gint composite_y_offset = 0;
|
|
GdkImage *retval;
|
|
GdkColormap *cmap;
|
|
|
|
g_return_val_if_fail (GDK_IS_DRAWABLE (drawable), NULL);
|
|
g_return_val_if_fail (x >= 0, NULL);
|
|
g_return_val_if_fail (y >= 0, NULL);
|
|
|
|
/* FIXME? Note race condition since we get the size then
|
|
* get the image, and the size may have changed.
|
|
*/
|
|
|
|
if (width < 0 || height < 0)
|
|
gdk_drawable_get_size (drawable,
|
|
width < 0 ? &width : NULL,
|
|
height < 0 ? &height : NULL);
|
|
|
|
composite =
|
|
GDK_DRAWABLE_GET_CLASS (drawable)->get_composite_drawable (drawable,
|
|
x, y,
|
|
width, height,
|
|
&composite_x_offset,
|
|
&composite_y_offset);
|
|
|
|
retval = GDK_DRAWABLE_GET_CLASS (composite)->get_image (composite,
|
|
x - composite_x_offset,
|
|
y - composite_y_offset,
|
|
width, height);
|
|
|
|
g_object_unref (G_OBJECT (composite));
|
|
|
|
cmap = gdk_drawable_get_colormap (drawable);
|
|
|
|
if (retval && cmap)
|
|
gdk_image_set_colormap (retval, cmap);
|
|
|
|
return retval;
|
|
}
|
|
|
|
static GdkDrawable*
|
|
gdk_drawable_real_get_composite_drawable (GdkDrawable *drawable,
|
|
gint x,
|
|
gint y,
|
|
gint width,
|
|
gint height,
|
|
gint *composite_x_offset,
|
|
gint *composite_y_offset)
|
|
{
|
|
g_return_val_if_fail (GDK_IS_DRAWABLE (drawable), NULL);
|
|
|
|
*composite_x_offset = 0;
|
|
*composite_y_offset = 0;
|
|
|
|
return GDK_DRAWABLE (g_object_ref (G_OBJECT (drawable)));
|
|
}
|
|
|
|
/**
|
|
* gdk_drawable_get_clip_region:
|
|
* @drawable: a #GdkDrawable
|
|
*
|
|
* Computes the region of a drawable that potentially can be written
|
|
* to by drawing primitives. This region will not take into account
|
|
* the clip region for the GC, and may also not take into account
|
|
* other factors such as if the window is obscured by other windows,
|
|
* but no area outside of this region will be affected by drawing
|
|
* primitives.
|
|
*
|
|
* Return value: a #GdkRegion. This must be freed with gdk_region_destroy()
|
|
* when you are done.
|
|
**/
|
|
GdkRegion *
|
|
gdk_drawable_get_clip_region (GdkDrawable *drawable)
|
|
{
|
|
g_return_val_if_fail (GDK_IS_DRAWABLE (drawable), NULL);
|
|
|
|
return GDK_DRAWABLE_GET_CLASS (drawable)->get_clip_region (drawable);
|
|
}
|
|
|
|
/**
|
|
* gdk_drawable_get_visible_region:
|
|
* @drawable:
|
|
*
|
|
* Computes the region of a drawable that is potentially visible.
|
|
* This does not necessarily take into account if the window is
|
|
* obscured by other windows, but no area outside of this region
|
|
* is visible.
|
|
*
|
|
* Return value: a #GdkRegion. This must be freed with gdk_region_destroy()
|
|
* when you are done.
|
|
**/
|
|
GdkRegion *
|
|
gdk_drawable_get_visible_region (GdkDrawable *drawable)
|
|
{
|
|
g_return_val_if_fail (GDK_IS_DRAWABLE (drawable), NULL);
|
|
|
|
return GDK_DRAWABLE_GET_CLASS (drawable)->get_visible_region (drawable);
|
|
}
|
|
|
|
static GdkRegion *
|
|
gdk_drawable_real_get_visible_region (GdkDrawable *drawable)
|
|
{
|
|
GdkRectangle rect;
|
|
|
|
rect.x = 0;
|
|
rect.y = 0;
|
|
|
|
gdk_drawable_get_size (drawable, &rect.width, &rect.height);
|
|
|
|
return gdk_region_rectangle (&rect);
|
|
}
|