gdkcairo.c 15.5 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GDK - The GIMP Drawing Kit
2 3 4 5 6 7 8 9 10
 * Copyright (C) 2005 Red Hat, Inc. 
 *
 * 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
11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12 13 14
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
Javier Jardón's avatar
Javier Jardón committed
15
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
16 17
 */

18
#include "config.h"
19

20
#include "gdkcairo.h"
21

22
#include "gdkinternals.h"
23

24
#include <math.h>
25

26 27
/**
 * SECTION:cairo_interaction
28
 * @Short_description: Functions to support using cairo
29 30
 * @Title: Cairo Interaction
 *
31
 * [Cairo](http://cairographics.org) is a graphics
32
 * library that supports vector graphics and image compositing that
33
 * can be used with GDK. GTK+ does all of its drawing using cairo.
34
 *
35
 * GDK does not wrap the cairo API, instead it allows to create cairo
36 37
 * contexts which can be used to draw on #GdkWindows. Additional
 * functions allow use #GdkRectangles with cairo and to use #GdkColors,
38 39
 * #GdkRGBAs, #GdkPixbufs and #GdkWindows as sources for drawing
 * operations.
40 41 42
 */


43 44 45 46 47
/**
 * gdk_cairo_get_clip_rectangle:
 * @cr: a cairo context
 * @rect: (out) (allow-none): return location for the clip, or %NULL
 *
48 49 50
 * This is a convenience function around cairo_clip_extents().
 * It rounds the clip extents to integer coordinates and returns
 * a boolean indicating if a clip area exists.
51 52
 *
 * Returns: %TRUE if a clip rectangle exists, %FALSE if all of @cr is
53 54
 *     clipped and all drawing can be skipped
 */
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81
gboolean
gdk_cairo_get_clip_rectangle (cairo_t      *cr,
                              GdkRectangle *rect)
{
  double x1, y1, x2, y2;
  gboolean clip_exists;

  cairo_clip_extents (cr, &x1, &y1, &x2, &y2);

  clip_exists = x1 < x2 && y1 < y2;

  if (rect)
    {
      x1 = floor (x1);
      y1 = floor (y1);
      x2 = ceil (x2);
      y2 = ceil (y2);

      rect->x      = CLAMP (x1,      G_MININT, G_MAXINT);
      rect->y      = CLAMP (y1,      G_MININT, G_MAXINT);
      rect->width  = CLAMP (x2 - x1, G_MININT, G_MAXINT);
      rect->height = CLAMP (y2 - y1, G_MININT, G_MAXINT);
    }

  return clip_exists;
}

82 83
/**
 * gdk_cairo_set_source_color:
84
 * @cr: a cairo context
85
 * @color: a #GdkColor
86
 *
87 88 89
 * Sets the specified #GdkColor as the source color of @cr.
 *
 * Since: 2.8
90 91
 *
 * Deprecated: 3.4: Use gdk_cairo_set_source_rgba() instead
92
 */
93
void
94
gdk_cairo_set_source_color (cairo_t        *cr,
95
                            const GdkColor *color)
96 97 98 99 100
{
  g_return_if_fail (cr != NULL);
  g_return_if_fail (color != NULL);
    
  cairo_set_source_rgb (cr,
101 102 103
                        color->red / 65535.,
                        color->green / 65535.,
                        color->blue / 65535.);
104 105
}

106 107
/**
 * gdk_cairo_set_source_rgba:
108
 * @cr: a cairo context
109 110 111 112 113
 * @rgba: a #GdkRGBA
 *
 * Sets the specified #GdkRGBA as the source color of @cr.
 *
 * Since: 3.0
114
 */
115 116 117 118 119 120 121 122 123 124 125 126 127 128
void
gdk_cairo_set_source_rgba (cairo_t       *cr,
                           const GdkRGBA *rgba)
{
  g_return_if_fail (cr != NULL);
  g_return_if_fail (rgba != NULL);

  cairo_set_source_rgba (cr,
                         rgba->red,
                         rgba->green,
                         rgba->blue,
                         rgba->alpha);
}

129 130
/**
 * gdk_cairo_rectangle:
131
 * @cr: a cairo context
132
 * @rectangle: a #GdkRectangle
133
 *
134
 * Adds the given rectangle to the current path of @cr.
Matthias Clasen's avatar
Matthias Clasen committed
135 136
 *
 * Since: 2.8
137
 */
138
void
139
gdk_cairo_rectangle (cairo_t            *cr,
140
                     const GdkRectangle *rectangle)
141 142 143 144 145
{
  g_return_if_fail (cr != NULL);
  g_return_if_fail (rectangle != NULL);

  cairo_rectangle (cr,
146 147
                   rectangle->x,     rectangle->y,
                   rectangle->width, rectangle->height);
148 149 150 151
}

/**
 * gdk_cairo_region:
152
 * @cr: a cairo context
153
 * @region: a #cairo_region_t
154
 *
155
 * Adds the given region to the current path of @cr.
Matthias Clasen's avatar
Matthias Clasen committed
156 157
 *
 * Since: 2.8
158
 */
159
void
Matthias Clasen's avatar
Matthias Clasen committed
160
gdk_cairo_region (cairo_t              *cr,
161
                  const cairo_region_t *region)
162
{
163
  cairo_rectangle_int_t box;
164 165 166 167 168
  gint n_boxes, i;

  g_return_if_fail (cr != NULL);
  g_return_if_fail (region != NULL);

169
  n_boxes = cairo_region_num_rectangles (region);
170 171

  for (i = 0; i < n_boxes; i++)
172 173 174 175
    {
      cairo_region_get_rectangle (region, i, &box);
      cairo_rectangle (cr, box.x, box.y, box.width, box.height);
    }
176 177
}

178 179 180
static void
gdk_cairo_surface_paint_pixbuf (cairo_surface_t *surface,
                                const GdkPixbuf *pixbuf)
181
{
182 183 184 185
  gint width, height;
  guchar *gdk_pixels, *cairo_pixels;
  int gdk_rowstride, cairo_stride;
  int n_channels;
186 187
  int j;

188 189 190
  if (cairo_surface_status (surface) != CAIRO_STATUS_SUCCESS)
    return;

191 192
  /* This function can't just copy any pixbuf to any surface, be
   * sure to read the invariants here before calling it */
193

194 195 196 197 198 199 200 201 202 203 204 205 206
  g_assert (cairo_surface_get_type (surface) == CAIRO_SURFACE_TYPE_IMAGE);
  g_assert (cairo_image_surface_get_format (surface) == CAIRO_FORMAT_RGB24 ||
            cairo_image_surface_get_format (surface) == CAIRO_FORMAT_ARGB32);
  g_assert (cairo_image_surface_get_width (surface) == gdk_pixbuf_get_width (pixbuf));
  g_assert (cairo_image_surface_get_height (surface) == gdk_pixbuf_get_height (pixbuf));

  cairo_surface_flush (surface);

  width = gdk_pixbuf_get_width (pixbuf);
  height = gdk_pixbuf_get_height (pixbuf);
  gdk_pixels = gdk_pixbuf_get_pixels (pixbuf);
  gdk_rowstride = gdk_pixbuf_get_rowstride (pixbuf);
  n_channels = gdk_pixbuf_get_n_channels (pixbuf);
207 208
  cairo_stride = cairo_image_surface_get_stride (surface);
  cairo_pixels = cairo_image_surface_get_data (surface);
209 210 211 212 213 214 215

  for (j = height; j; j--)
    {
      guchar *p = gdk_pixels;
      guchar *q = cairo_pixels;

      if (n_channels == 3)
216 217 218 219 220
        {
          guchar *end = p + 3 * width;

          while (p < end)
            {
221
#if G_BYTE_ORDER == G_LITTLE_ENDIAN
222 223 224 225 226 227 228
              q[0] = p[2];
              q[1] = p[1];
              q[2] = p[0];
#else
              q[1] = p[0];
              q[2] = p[1];
              q[3] = p[2];
229
#endif
230 231 232 233
              p += 3;
              q += 4;
            }
        }
234
      else
235 236 237 238
        {
          guchar *end = p + 4 * width;
          guint t1,t2,t3;

239
#define MULT(d,c,a,t) G_STMT_START { t = c * a + 0x80; d = ((t >> 8) + t) >> 8; } G_STMT_END
240

241 242
          while (p < end)
            {
243
#if G_BYTE_ORDER == G_LITTLE_ENDIAN
244 245 246 247 248 249 250 251 252
              MULT(q[0], p[2], p[3], t1);
              MULT(q[1], p[1], p[3], t2);
              MULT(q[2], p[0], p[3], t3);
              q[3] = p[3];
#else
              q[0] = p[3];
              MULT(q[1], p[0], p[3], t1);
              MULT(q[2], p[1], p[3], t2);
              MULT(q[3], p[2], p[3], t3);
253
#endif
254 255 256 257 258

              p += 4;
              q += 4;
            }

259
#undef MULT
260
        }
261 262

      gdk_pixels += gdk_rowstride;
263
      cairo_pixels += cairo_stride;
264 265
    }

266
  cairo_surface_mark_dirty (surface);
267 268 269 270 271 272
}

/**
 * gdk_cairo_surface_create_from_pixbuf:
 * @pixbuf: a #GdkPixbuf
 * @scale: the scale of the new surface, or 0 to use same as @window
273
 * @for_window: (allow-none): The window this will be drawn to, or %NULL
274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289
 *
 * Creates an image surface with the same contents as
 * the pixbuf.
 *
 * Returns: a new cairo surface, must be freed with cairo_surface_destroy()
 *
 * Since: 3.10
 */
cairo_surface_t *
gdk_cairo_surface_create_from_pixbuf (const GdkPixbuf *pixbuf,
                                      int              scale,
                                      GdkWindow       *for_window)
{
  cairo_format_t format;
  cairo_surface_t *surface;

290
  g_return_val_if_fail (GDK_IS_PIXBUF (pixbuf), NULL);
291
  g_return_val_if_fail (scale >= 0, NULL);
292 293
  g_return_val_if_fail (for_window == NULL || GDK_IS_WINDOW (for_window), NULL);

294 295 296 297 298 299 300 301 302 303 304 305 306 307
  if (gdk_pixbuf_get_n_channels (pixbuf) == 3)
    format = CAIRO_FORMAT_RGB24;
  else
    format = CAIRO_FORMAT_ARGB32;

  surface =
     gdk_window_create_similar_image_surface (for_window,
					      format,
                                              gdk_pixbuf_get_width (pixbuf),
                                              gdk_pixbuf_get_height (pixbuf),
					      scale);

  gdk_cairo_surface_paint_pixbuf (surface, pixbuf);

308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330
  return surface;
}

/**
 * gdk_cairo_set_source_pixbuf:
 * @cr: a cairo context
 * @pixbuf: a #GdkPixbuf
 * @pixbuf_x: X coordinate of location to place upper left corner of @pixbuf
 * @pixbuf_y: Y coordinate of location to place upper left corner of @pixbuf
 *
 * Sets the given pixbuf as the source pattern for @cr.
 *
 * The pattern has an extend mode of %CAIRO_EXTEND_NONE and is aligned
 * so that the origin of @pixbuf is @pixbuf_x, @pixbuf_y.
 *
 * Since: 2.8
 */
void
gdk_cairo_set_source_pixbuf (cairo_t         *cr,
                             const GdkPixbuf *pixbuf,
                             gdouble          pixbuf_x,
                             gdouble          pixbuf_y)
{
331
  cairo_format_t format;
332 333
  cairo_surface_t *surface;

334 335 336 337 338 339 340 341 342 343
  if (gdk_pixbuf_get_n_channels (pixbuf) == 3)
    format = CAIRO_FORMAT_RGB24;
  else
    format = CAIRO_FORMAT_ARGB32;

  surface = cairo_surface_create_similar_image (cairo_get_target (cr),
                                                format,
                                                gdk_pixbuf_get_width (pixbuf),
                                                gdk_pixbuf_get_height (pixbuf));

344 345
  gdk_cairo_surface_paint_pixbuf (surface, pixbuf);

346
  cairo_set_source_surface (cr, surface, pixbuf_x, pixbuf_y);
347
  cairo_surface_destroy (surface);
348 349
}

350
/**
351
 * gdk_cairo_set_source_window:
352
 * @cr: a cairo context
353 354 355
 * @window: a #GdkWindow
 * @x: X coordinate of location to place upper left corner of @window
 * @y: Y coordinate of location to place upper left corner of @window
Matthias Clasen's avatar
Matthias Clasen committed
356
 *
357 358
 * Sets the given window as the source pattern for @cr.
 *
359
 * The pattern has an extend mode of %CAIRO_EXTEND_NONE and is aligned
360 361
 * so that the origin of @window is @x, @y. The window contains all its
 * subwindows when rendering.
Matthias Clasen's avatar
Matthias Clasen committed
362
 *
363 364
 * Note that the contents of @window are undefined outside of the
 * visible part of @window, so use this function with care.
365
 *
Matthias Clasen's avatar
Matthias Clasen committed
366 367
 * Since: 2.24
 */
368
void
369
gdk_cairo_set_source_window (cairo_t   *cr,
Matthias Clasen's avatar
Matthias Clasen committed
370
                             GdkWindow *window,
371 372
                             gdouble    x,
                             gdouble    y)
373 374
{
  cairo_surface_t *surface;
375

376 377 378
  g_return_if_fail (cr != NULL);
  g_return_if_fail (GDK_IS_WINDOW (window));

379
  surface = _gdk_window_ref_cairo_surface (window);
380
  cairo_set_source_surface (cr, surface, x, y);
381 382
  cairo_surface_destroy (surface);
}
383

384
/*
385 386 387 388 389
 * _gdk_cairo_surface_extents:
 * @surface: surface to measure
 * @extents: (out): rectangle to put the extents
 *
 * Measures the area covered by @surface and puts it into @extents.
390
 *
391
 * Note that this function respects device offsets set on @surface.
392
 * If @surface is unbounded, the resulting extents will be empty and
393 394 395 396
 * not be a maximal sized rectangle. This is to avoid careless coding.
 * You must explicitly check the return value of you want to handle
 * that case.
 *
397 398
 * Returns: %TRUE if the extents fit in a #GdkRectangle, %FALSE if not
 */
399 400
gboolean
_gdk_cairo_surface_extents (cairo_surface_t *surface,
401
                            GdkRectangle    *extents)
402 403 404 405 406 407 408 409 410
{
  double x1, x2, y1, y2;
  cairo_t *cr;

  g_return_val_if_fail (surface != NULL, FALSE);
  g_return_val_if_fail (extents != NULL, FALSE);

  cr = cairo_create (surface);
  cairo_clip_extents (cr, &x1, &y1, &x2, &y2);
Xan Lopez's avatar
Xan Lopez committed
411
  cairo_destroy (cr);
412 413 414 415 416 417 418

  x1 = floor (x1);
  y1 = floor (y1);
  x2 = ceil (x2);
  y2 = ceil (y2);
  x2 -= x1;
  y2 -= y1;
419

420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
  if (x1 < G_MININT || x1 > G_MAXINT ||
      y1 < G_MININT || y1 > G_MAXINT ||
      x2 > G_MAXINT || y2 > G_MAXINT)
    {
      extents->x = extents->y = extents->width = extents->height = 0;
      return FALSE;
    }

  extents->x = x1;
  extents->y = y1;
  extents->width = x2;
  extents->height = y2;

  return TRUE;
}

/* This function originally from Jean-Edouard Lachand-Robert, and
 * available at www.codeguru.com. Simplified for our needs, not sure
 * how much of the original code left any longer. Now handles just
 * one-bit deep bitmaps (in Window parlance, ie those that GDK calls
 * bitmaps (and not pixmaps), with zero pixels being transparent.
 */
/**
 * gdk_cairo_region_create_from_surface:
444
 * @surface: a cairo surface
445
 *
446 447
 * Creates region that describes covers the area where the given
 * @surface is more than 50% opaque.
448
 *
449 450 451 452
 * This function takes into account device offsets that might be
 * set with cairo_surface_set_device_offset().
 *
 * Returns: A #cairo_region_t; must be freed with cairo_region_destroy()
453
 */
454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475
cairo_region_t *
gdk_cairo_region_create_from_surface (cairo_surface_t *surface)
{
  cairo_region_t *region;
  GdkRectangle extents, rect;
  cairo_surface_t *image;
  cairo_t *cr;
  gint x, y, stride;
  guchar *data;

  _gdk_cairo_surface_extents (surface, &extents);

  if (cairo_surface_get_content (surface) == CAIRO_CONTENT_COLOR)
    return cairo_region_create_rectangle (&extents);

  if (cairo_surface_get_type (surface) != CAIRO_SURFACE_TYPE_IMAGE ||
      cairo_image_surface_get_format (surface) != CAIRO_FORMAT_A1)
    {
      /* coerce to an A1 image */
      image = cairo_image_surface_create (CAIRO_FORMAT_A1,
                                          extents.width, extents.height);
      cr = cairo_create (image);
476
      cairo_set_source_surface (cr, surface, -extents.x, -extents.y);
477 478 479 480 481 482
      cairo_paint (cr);
      cairo_destroy (cr);
    }
  else
    image = cairo_surface_reference (surface);

483 484 485
  /* Flush the surface to make sure that the rendering is up to date. */
  cairo_surface_flush (image);

486 487 488 489 490 491 492 493
  data = cairo_image_surface_get_data (image);
  stride = cairo_image_surface_get_stride (image);

  region = cairo_region_create ();

  for (y = 0; y < extents.height; y++)
    {
      for (x = 0; x < extents.width; x++)
494 495 496 497 498
        {
          /* Search for a continuous range of "non transparent pixels"*/
          gint x0 = x;
          while (x < extents.width)
            {
499
#if G_BYTE_ORDER == G_LITTLE_ENDIAN
500
              if (((data[x / 8] >> (x%8)) & 1) == 0)
501 502 503
#else
              if (((data[x / 8] >> (7-(x%8))) & 1) == 0)
#endif
504 505 506 507 508 509 510 511 512 513
                /* This pixel is "transparent"*/
                break;
              x++;
            }

          if (x > x0)
            {
              /* Add the pixels (x0, y) to (x, y+1) as a new rectangle
               * in the region
               */
514 515 516 517 518 519
              rect.x = x0;
              rect.width = x - x0;
              rect.y = y;
              rect.height = 1;

              cairo_region_union_rectangle (region, &rect);
520 521
            }
        }
522 523 524 525
      data += stride;
    }

  cairo_surface_destroy (image);
526

527 528 529 530
  cairo_region_translate (region, extents.x, extents.y);

  return region;
}
531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565

cairo_region_t *
gdk_cairo_region_from_clip (cairo_t *cr)
{
  cairo_rectangle_list_t *rectangles;
  cairo_region_t *region;
  int i;

  rectangles = cairo_copy_clip_rectangle_list (cr);

  if (rectangles->status != CAIRO_STATUS_SUCCESS)
    return NULL;

  region = cairo_region_create ();
  for (i = 0; i < rectangles->num_rectangles; i++)
    {
      cairo_rectangle_int_t clip_rect;
      cairo_rectangle_t *rect;

      rect = &rectangles->rectangles[i];

      /* Here we assume clip rects are ints for direct targets, which
         is true for cairo */
      clip_rect.x = (int)rect->x;
      clip_rect.y = (int)rect->y;
      clip_rect.width = (int)rect->width;
      clip_rect.height = (int)rect->height;

      cairo_region_union_rectangle (region, &clip_rect);
    }

  cairo_rectangle_list_destroy (rectangles);

  return region;
}