]> Pileus Git - ~andy/gtk/blob - gdk/gdkpixbuf-drawable.c
Inclusion cleanups in sources
[~andy/gtk] / gdk / gdkpixbuf-drawable.c
1 /* GdkPixbuf library - convert X drawable information to RGB
2  *
3  * Copyright (C) 1999 Michael Zucchi
4  *
5  * Authors: Michael Zucchi <zucchi@zedzone.mmc.com.au>
6  *          Cody Russell <bratsche@dfw.net>
7  *          Federico Mena-Quintero <federico@gimp.org>
8  *
9  * This library is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Lesser General Public
11  * License as published by the Free Software Foundation; either
12  * version 2 of the License, or (at your option) any later version.
13  *
14  * This library is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public
20  * License along with this library; if not, write to the
21  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22  * Boston, MA 02111-1307, USA.
23  */
24
25 #include "config.h"
26
27 #include "gdkpixbuf.h"
28
29 #include "gdkcolor.h"
30 #include "gdkwindow.h"
31 #include "gdkinternals.h"
32
33 #include <gdk-pixbuf/gdk-pixbuf.h>
34
35 /**
36  * SECTION:pixbufs
37  * @Short_description: Functions for rendering pixbufs on drawables
38  * @Title: Pixbufs
39  *
40  * These functions allow to render pixbufs on drawables. Pixbufs are
41  * client-side images. For details on how to create and manipulate
42  * pixbufs, see the #GdkPixbuf API documentation.
43  */
44
45
46 /**
47  * gdk_pixbuf_get_from_window:
48  * @window: Source window
49  * @src_x: Source X coordinate within @window
50  * @src_y: Source Y coordinate within @window
51  * @width: Width in pixels of region to get
52  * @height: Height in pixels of region to get
53  *
54  * Transfers image data from a #GdkWindow and converts it to an RGB(A)
55  * representation inside a #GdkPixbuf. In other words, copies
56  * image data from a server-side drawable to a client-side RGB(A) buffer.
57  * This allows you to efficiently read individual pixels on the client side.
58  * 
59  * This function will create an RGB pixbuf with 8 bits per channel with
60  * the same size specified by the @width and @height arguments. The pixbuf
61  * will contain an alpha channel if the @window contains one.
62  *
63  * If the window is off the screen, then there is no image data in the
64  * obscured/offscreen regions to be placed in the pixbuf. The contents of
65  * portions of the pixbuf corresponding to the offscreen region are undefined.
66  *
67  * If the window you're obtaining data from is partially obscured by
68  * other windows, then the contents of the pixbuf areas corresponding
69  * to the obscured regions are undefined.
70  *
71  * If the window is not mapped (typically because it's iconified/minimized
72  * or not on the current workspace), then %NULL will be returned.
73  *
74  * If memory can't be allocated for the return value, %NULL will be returned
75  * instead.
76  *
77  * (In short, there are several ways this function can fail, and if it fails
78  *  it returns %NULL; so check the return value.)
79  *
80  * Return value: (transfer full): A newly-created pixbuf with a reference
81  * count of 1, or %NULL on error
82  **/
83 GdkPixbuf *
84 gdk_pixbuf_get_from_window (GdkWindow   *src,
85                             int src_x,  int src_y,
86                             int width,  int height)
87 {
88   cairo_surface_t *surface;
89   GdkPixbuf *dest;
90   
91   g_return_val_if_fail (GDK_IS_WINDOW (src), NULL);
92   g_return_val_if_fail (gdk_window_is_viewable (src), NULL);
93
94   surface = _gdk_drawable_ref_cairo_surface (src);
95   dest = gdk_pixbuf_get_from_surface (surface,
96                                       src_x, src_y,
97                                       width, height);
98   cairo_surface_destroy (surface);
99
100   return dest;
101 }
102         
103 static cairo_format_t
104 gdk_cairo_format_for_content (cairo_content_t content)
105 {
106   switch (content)
107     {
108     case CAIRO_CONTENT_COLOR:
109       return CAIRO_FORMAT_RGB24;
110     case CAIRO_CONTENT_ALPHA:
111       return CAIRO_FORMAT_A8;
112     case CAIRO_CONTENT_COLOR_ALPHA:
113     default:
114       return CAIRO_FORMAT_ARGB32;
115     }
116 }
117
118 static cairo_surface_t *
119 gdk_cairo_surface_coerce_to_image (cairo_surface_t *surface,
120                                    cairo_content_t content,
121                                    int width,
122                                    int height)
123 {
124   cairo_surface_t *copy;
125   cairo_t *cr;
126
127   if (cairo_surface_get_type (surface) == CAIRO_SURFACE_TYPE_IMAGE &&
128       cairo_surface_get_content (surface) == content &&
129       cairo_image_surface_get_width (surface) >= width &&
130       cairo_image_surface_get_height (surface) >= height)
131     return cairo_surface_reference (surface);
132
133   copy = cairo_image_surface_create (gdk_cairo_format_for_content (content),
134                                      width,
135                                      height);
136
137   cr = cairo_create (copy);
138   cairo_set_operator (cr, CAIRO_OPERATOR_SOURCE);
139   cairo_set_source_surface (cr, surface, 0, 0);
140   cairo_paint (cr);
141   cairo_destroy (cr);
142
143   return copy;
144 }
145
146 static void
147 convert_alpha (guchar  *dest_data,
148                int      dest_stride,
149                guchar  *src_data,
150                int      src_stride,
151                int      src_x,
152                int      src_y,
153                int      width,
154                int      height)
155 {
156   int x, y;
157
158   src_data += src_stride * src_y + src_x * 4;
159
160   for (y = 0; y < height; y++) {
161     guint32 *src = (guint32 *) src_data;
162
163     for (x = 0; x < width; x++) {
164       guint alpha = src[x] >> 24;
165
166       if (alpha == 0)
167         {
168           dest_data[x * 4 + 0] = 0;
169           dest_data[x * 4 + 1] = 0;
170           dest_data[x * 4 + 2] = 0;
171         }
172       else
173         {
174           dest_data[x * 4 + 0] = (((src[x] & 0xff0000) >> 16) * 255 + alpha / 2) / alpha;
175           dest_data[x * 4 + 1] = (((src[x] & 0x00ff00) >>  8) * 255 + alpha / 2) / alpha;
176           dest_data[x * 4 + 2] = (((src[x] & 0x0000ff) >>  0) * 255 + alpha / 2) / alpha;
177         }
178       dest_data[x * 4 + 3] = alpha;
179     }
180
181     src_data += src_stride;
182     dest_data += dest_stride;
183   }
184 }
185
186 static void
187 convert_no_alpha (guchar  *dest_data,
188                   int      dest_stride,
189                   guchar  *src_data,
190                   int      src_stride,
191                   int      src_x,
192                   int      src_y,
193                   int      width,
194                   int      height)
195 {
196   int x, y;
197
198   src_data += src_stride * src_y + src_x * 4;
199
200   for (y = 0; y < height; y++) {
201     guint32 *src = (guint32 *) src_data;
202
203     for (x = 0; x < width; x++) {
204       dest_data[x * 3 + 0] = src[x] >> 16;
205       dest_data[x * 3 + 1] = src[x] >>  8;
206       dest_data[x * 3 + 2] = src[x];
207     }
208
209     src_data += src_stride;
210     dest_data += dest_stride;
211   }
212 }
213
214 /**
215  * gdk_pixbuf_get_from_surface:
216  * @surface: surface to copy from
217  * @src_x: Source X coordinate within @surface
218  * @src_y: Source Y coordinate within @surface
219  * @width: Width in pixels of region to get
220  * @height: Height in pixels of region to get
221  *
222  * Transfers image data from a #cairo_surface_t and converts it to an RGB(A)
223  * representation inside a #GdkPixbuf. This allows you to efficiently read
224  * individual pixels from cairo surfaces. For #GdkWindows, use
225  * gdk_pixbuf_get_from_window() instead.
226  *
227  * This function will create an RGB pixbuf with 8 bits per channel. The pixbuf
228  * will contain an alpha channel if the @surface contains one.
229  *
230  * Return value: (transfer full): A newly-created pixbuf with a reference count
231  * of 1, or %NULL on error
232  **/
233 GdkPixbuf *
234 gdk_pixbuf_get_from_surface  (cairo_surface_t *surface,
235                               int              src_x,
236                               int              src_y,
237                               int              width,
238                               int              height)
239 {
240   cairo_content_t content;
241   GdkPixbuf *dest;
242   
243   /* General sanity checks */
244   g_return_val_if_fail (surface != NULL, NULL);
245   g_return_val_if_fail (src_x >= 0 && src_y >= 0, NULL);
246   g_return_val_if_fail (width > 0 && height > 0, NULL);
247
248   content = cairo_surface_get_content (surface) | CAIRO_CONTENT_COLOR;
249   dest = gdk_pixbuf_new (GDK_COLORSPACE_RGB,
250                          !!(content & CAIRO_CONTENT_ALPHA),
251                          8,
252                          width, height);
253
254   surface = gdk_cairo_surface_coerce_to_image (surface, content, src_x + width, src_y + height);
255   cairo_surface_flush (surface);
256   if (cairo_surface_status (surface) || dest == NULL)
257     {
258       cairo_surface_destroy (surface);
259       return NULL;
260     }
261
262   if (gdk_pixbuf_get_has_alpha (dest))
263     convert_alpha (gdk_pixbuf_get_pixels (dest),
264                    gdk_pixbuf_get_rowstride (dest),
265                    cairo_image_surface_get_data (surface),
266                    cairo_image_surface_get_stride (surface),
267                    src_x, src_y,
268                    width, height);
269   else
270     convert_no_alpha (gdk_pixbuf_get_pixels (dest),
271                       gdk_pixbuf_get_rowstride (dest),
272                       cairo_image_surface_get_data (surface),
273                       cairo_image_surface_get_stride (surface),
274                       src_x, src_y,
275                       width, height);
276
277   cairo_surface_destroy (surface);
278   return dest;
279 }
280