meta-shaped-texture.c 27.7 KB
Newer Older
1 2
/*
 * Authored By Neil Roberts  <neil@linux.intel.com>
3
 * and Jasper St. Pierre <jstpierre@mecheye.net>
4 5
 *
 * Copyright (C) 2008 Intel Corporation
6
 * Copyright (C) 2012 Red Hat, Inc.
7 8 9 10 11 12 13 14 15 16 17 18
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 *
 * This program 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
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
19
 * along with this program; if not, see <http://www.gnu.org/licenses/>.
20 21
 */

22 23 24 25 26 27
/**
 * SECTION:meta-shaped-texture
 * @title: MetaShapedTexture
 * @short_description: An actor to draw a masked texture.
 */

28 29
#include <config.h>

30
#include <meta/meta-shaped-texture.h>
31
#include <meta/util.h>
32
#include "clutter-utils.h"
33
#include "meta-texture-tower.h"
Thomas Wood's avatar
Thomas Wood committed
34

35
#include "meta-shaped-texture-private.h"
36

Thomas Wood's avatar
Thomas Wood committed
37
#include <clutter/clutter.h>
38
#include <cogl/cogl.h>
39
#include <gdk/gdk.h> /* for gdk_rectangle_intersect() */
40
#include "meta-cullable.h"
41

42
static void meta_shaped_texture_dispose  (GObject    *object);
43

44 45 46
static void meta_shaped_texture_paint (ClutterActor       *actor);
static void meta_shaped_texture_pick  (ClutterActor       *actor,
				       const ClutterColor *color);
47

48 49 50 51 52 53 54 55 56
static void meta_shaped_texture_get_preferred_width (ClutterActor *self,
                                                     gfloat        for_height,
                                                     gfloat       *min_width_p,
                                                     gfloat       *natural_width_p);

static void meta_shaped_texture_get_preferred_height (ClutterActor *self,
                                                      gfloat        for_width,
                                                      gfloat       *min_height_p,
                                                      gfloat       *natural_height_p);
57

58 59
static gboolean meta_shaped_texture_get_paint_volume (ClutterActor *self, ClutterPaintVolume *volume);

60 61 62 63
static void cullable_iface_init (MetaCullableInterface *iface);

G_DEFINE_TYPE_WITH_CODE (MetaShapedTexture, meta_shaped_texture, CLUTTER_TYPE_ACTOR,
                         G_IMPLEMENT_INTERFACE (META_TYPE_CULLABLE, cullable_iface_init));
64

65 66 67
#define META_SHAPED_TEXTURE_GET_PRIVATE(obj) \
  (G_TYPE_INSTANCE_GET_PRIVATE ((obj), META_TYPE_SHAPED_TEXTURE, \
                                MetaShapedTexturePrivate))
68

69
struct _MetaShapedTexturePrivate
70
{
71
  MetaTextureTower *paint_tower;
72 73

  CoglTexture *texture;
74
  CoglTexture *mask_texture;
75

Owen W. Taylor's avatar
Owen W. Taylor committed
76
  cairo_region_t *clip_region;
77
  cairo_region_t *input_shape_region;
78
  cairo_region_t *opaque_region;
79

80
  guint tex_width, tex_height;
81

82
  guint create_mipmaps : 1;
83 84 85
};

static void
86
meta_shaped_texture_class_init (MetaShapedTextureClass *klass)
87 88 89 90
{
  GObjectClass *gobject_class = (GObjectClass *) klass;
  ClutterActorClass *actor_class = (ClutterActorClass *) klass;

91
  gobject_class->dispose = meta_shaped_texture_dispose;
92

93 94
  actor_class->get_preferred_width = meta_shaped_texture_get_preferred_width;
  actor_class->get_preferred_height = meta_shaped_texture_get_preferred_height;
95 96
  actor_class->paint = meta_shaped_texture_paint;
  actor_class->pick = meta_shaped_texture_pick;
97
  actor_class->get_paint_volume = meta_shaped_texture_get_paint_volume;
98

99
  g_type_class_add_private (klass, sizeof (MetaShapedTexturePrivate));
100 101 102
}

static void
103
meta_shaped_texture_init (MetaShapedTexture *self)
104
{
105
  MetaShapedTexturePrivate *priv;
106

107
  priv = self->priv = META_SHAPED_TEXTURE_GET_PRIVATE (self);
108

109
  priv->paint_tower = meta_texture_tower_new ();
110

111 112
  priv->texture = NULL;
  priv->mask_texture = NULL;
113
  priv->create_mipmaps = TRUE;
114 115
}

116 117 118 119 120 121 122 123 124 125 126
static void
set_clip_region (MetaShapedTexture *self,
                 cairo_region_t    *clip_region)
{
  MetaShapedTexturePrivate *priv = self->priv;

  g_clear_pointer (&priv->clip_region, (GDestroyNotify) cairo_region_destroy);
  if (clip_region)
    priv->clip_region = cairo_region_copy (clip_region);
}

127
static void
128
meta_shaped_texture_dispose (GObject *object)
129
{
130 131
  MetaShapedTexture *self = (MetaShapedTexture *) object;
  MetaShapedTexturePrivate *priv = self->priv;
132

133
  if (priv->paint_tower)
134
    meta_texture_tower_free (priv->paint_tower);
135 136
  priv->paint_tower = NULL;

137
  g_clear_pointer (&priv->texture, cogl_object_unref);
138
  g_clear_pointer (&priv->opaque_region, cairo_region_destroy);
139

140
  meta_shaped_texture_set_mask_texture (self, NULL);
141
  set_clip_region (self, NULL);
142

143
  G_OBJECT_CLASS (meta_shaped_texture_parent_class)->dispose (object);
144 145
}

146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
static CoglPipeline *
get_unmasked_pipeline (CoglContext *ctx)
{
  return cogl_pipeline_new (ctx);
}

static CoglPipeline *
get_masked_pipeline (CoglContext *ctx)
{
  static CoglPipeline *template = NULL;
  if (G_UNLIKELY (template == NULL))
    {
      template = cogl_pipeline_new (ctx);
      cogl_pipeline_set_layer_combine (template, 1,
                                       "RGBA = MODULATE (PREVIOUS, TEXTURE[A])",
                                       NULL);
    }

  return cogl_pipeline_copy (template);
}

167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
static CoglPipeline *
get_unblended_pipeline (CoglContext *ctx)
{
  static CoglPipeline *template = NULL;
  if (G_UNLIKELY (template == NULL))
    {
      CoglColor color;
      template = cogl_pipeline_new (ctx);
      cogl_color_init_from_4ub (&color, 255, 255, 255, 255);
      cogl_pipeline_set_blend (template,
                               "RGBA = ADD (SRC_COLOR, 0)",
                               NULL);
      cogl_pipeline_set_color (template, &color);
    }

  return cogl_pipeline_copy (template);
}

static void
paint_clipped_rectangle (CoglFramebuffer       *fb,
                         CoglPipeline          *pipeline,
                         cairo_rectangle_int_t *rect,
                         ClutterActorBox       *alloc)
{
  float coords[8];
  float x1, y1, x2, y2;

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

  coords[0] = rect->x / (alloc->x2 - alloc->x1);
  coords[1] = rect->y / (alloc->y2 - alloc->y1);
  coords[2] = (rect->x + rect->width) / (alloc->x2 - alloc->x1);
  coords[3] = (rect->y + rect->height) / (alloc->y2 - alloc->y1);

  coords[4] = coords[0];
  coords[5] = coords[1];
  coords[6] = coords[2];
  coords[7] = coords[3];

  cogl_framebuffer_draw_multitextured_rectangle (fb, pipeline,
                                                 x1, y1, x2, y2,
                                                 &coords[0], 8);
}

214 215 216 217 218 219 220 221 222 223 224 225 226 227
static void
set_cogl_texture (MetaShapedTexture *stex,
                  CoglTexture       *cogl_tex)
{
  MetaShapedTexturePrivate *priv;
  guint width, height;

  g_return_if_fail (META_IS_SHAPED_TEXTURE (stex));

  priv = stex->priv;

  if (priv->texture)
    cogl_object_unref (priv->texture);

228
  priv->texture = cogl_tex;
229 230 231

  if (cogl_tex != NULL)
    {
232
      cogl_object_ref (cogl_tex);
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256
      width = cogl_texture_get_width (COGL_TEXTURE (cogl_tex));
      height = cogl_texture_get_height (COGL_TEXTURE (cogl_tex));

      if (width != priv->tex_width ||
          height != priv->tex_height)
        {
          priv->tex_width = width;
          priv->tex_height = height;

          clutter_actor_queue_relayout (CLUTTER_ACTOR (stex));
        }
    }
  else
    {
      /* size changed to 0 going to an invalid handle */
      priv->tex_width = 0;
      priv->tex_height = 0;
      clutter_actor_queue_relayout (CLUTTER_ACTOR (stex));
    }

  /* NB: We don't queue a redraw of the actor here because we don't
   * know how much of the buffer has changed with respect to the
   * previous buffer. We only queue a redraw in response to surface
   * damage. */
257 258 259

  if (priv->create_mipmaps)
    meta_texture_tower_set_base_texture (priv->paint_tower, cogl_tex);
260 261
}

262
static void
263
meta_shaped_texture_paint (ClutterActor *actor)
264
{
265 266
  MetaShapedTexture *stex = (MetaShapedTexture *) actor;
  MetaShapedTexturePrivate *priv = stex->priv;
267
  guint tex_width, tex_height;
268
  guchar opacity;
269
  CoglContext *ctx;
270 271 272 273
  CoglFramebuffer *fb;
  CoglPipeline *pipeline = NULL;
  CoglTexture *paint_tex;
  ClutterActorBox alloc;
274
  cairo_region_t *blended_region = NULL;
275
  CoglPipelineFilter filter;
276

Owen W. Taylor's avatar
Owen W. Taylor committed
277
  if (priv->clip_region && cairo_region_is_empty (priv->clip_region))
278 279
    return;

280 281 282
  if (!CLUTTER_ACTOR_IS_REALIZED (CLUTTER_ACTOR (stex)))
    clutter_actor_realize (CLUTTER_ACTOR (stex));

283 284 285 286
  /* The GL EXT_texture_from_pixmap extension does allow for it to be
   * used together with SGIS_generate_mipmap, however this is very
   * rarely supported. Also, even when it is supported there
   * are distinct performance implications from:
287
   *
288 289
   *  - Updating mipmaps that we don't need
   *  - Having to reallocate pixmaps on the server into larger buffers
290
   *
291 292 293 294 295 296
   * So, we just unconditionally use our mipmap emulation code. If we
   * wanted to use SGIS_generate_mipmap, we'd have to  query COGL to
   * see if it was supported (no API currently), and then if and only
   * if that was the case, set the clutter texture quality to HIGH.
   * Setting the texture quality to high without SGIS_generate_mipmap
   * support for TFP textures will result in fallbacks to XGetImage.
297
   */
298
  if (priv->create_mipmaps)
299
    paint_tex = meta_texture_tower_get_paint_texture (priv->paint_tower);
300
  else
301
    paint_tex = COGL_TEXTURE (priv->texture);
302

303
  if (paint_tex == NULL)
304
    return;
305

306 307
  tex_width = priv->tex_width;
  tex_height = priv->tex_height;
308

309
  if (tex_width == 0 || tex_height == 0) /* no contents yet */
310 311
    return;

312 313 314 315 316 317
  /* Use nearest-pixel interpolation if the texture is unscaled. This
   * improves performance, especially with software rendering.
   */

  filter = COGL_PIPELINE_FILTER_LINEAR;

318 319
  if (!clutter_actor_is_in_clone_paint (actor) && meta_actor_is_untransformed (actor, NULL, NULL))
    filter = COGL_PIPELINE_FILTER_NEAREST;
320

321
  ctx = clutter_backend_get_cogl_context (clutter_get_default_backend ());
322
  fb = cogl_get_draw_framebuffer ();
323

324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348
  opacity = clutter_actor_get_paint_opacity (actor);
  clutter_actor_get_allocation_box (actor, &alloc);

  if (priv->opaque_region != NULL && opacity == 255)
    {
      CoglPipeline *opaque_pipeline;
      cairo_region_t *region;
      int n_rects;
      int i;

      if (priv->clip_region != NULL)
        {
          region = cairo_region_copy (priv->clip_region);
          cairo_region_intersect (region, priv->opaque_region);
        }
      else
        {
          region = cairo_region_reference (priv->opaque_region);
        }

      if (cairo_region_is_empty (region))
        goto paint_blended;

      opaque_pipeline = get_unblended_pipeline (ctx);
      cogl_pipeline_set_layer_texture (opaque_pipeline, 0, paint_tex);
349
      cogl_pipeline_set_layer_filters (opaque_pipeline, 0, filter, filter);
350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382

      n_rects = cairo_region_num_rectangles (region);
      for (i = 0; i < n_rects; i++)
        {
          cairo_rectangle_int_t rect;
          cairo_region_get_rectangle (region, i, &rect);
          paint_clipped_rectangle (fb, opaque_pipeline, &rect, &alloc);
        }

      cogl_object_unref (opaque_pipeline);

      if (priv->clip_region != NULL)
        {
          blended_region = cairo_region_copy (priv->clip_region);
        }
      else
        {
          cairo_rectangle_int_t rect = { 0, 0, tex_width, tex_height };
          blended_region = cairo_region_create_rectangle (&rect);
        }

      cairo_region_subtract (blended_region, priv->opaque_region);

    paint_blended:
      cairo_region_destroy (region);
    }

  if (blended_region == NULL && priv->clip_region != NULL)
    blended_region = cairo_region_reference (priv->clip_region);

  if (blended_region != NULL && cairo_region_is_empty (blended_region))
    goto out;

383
  if (priv->mask_texture == NULL)
384
    {
385
      pipeline = get_unmasked_pipeline (ctx);
386 387
    }
  else
388
    {
389
      pipeline = get_masked_pipeline (ctx);
390
      cogl_pipeline_set_layer_texture (pipeline, 1, priv->mask_texture);
391
      cogl_pipeline_set_layer_filters (pipeline, 1, filter, filter);
392 393
    }

394
  cogl_pipeline_set_layer_texture (pipeline, 0, paint_tex);
395
  cogl_pipeline_set_layer_filters (pipeline, 0, filter, filter);
396

397 398
  {
    CoglColor color;
399
    cogl_color_init_from_4ub (&color, opacity, opacity, opacity, opacity);
400
    cogl_pipeline_set_color (pipeline, &color);
401
  }
402

403
  if (blended_region != NULL)
404 405 406 407 408 409 410
    {
      int n_rects;

      /* Limit to how many separate rectangles we'll draw; beyond this just
       * fall back and draw the whole thing */
#     define MAX_RECTS 16

411
      n_rects = cairo_region_num_rectangles (blended_region);
Owen W. Taylor's avatar
Owen W. Taylor committed
412
      if (n_rects <= MAX_RECTS)
413
	{
414 415
          int i;
          cairo_rectangle_int_t tex_rect = { 0, 0, tex_width, tex_height };
416

417 418
	  for (i = 0; i < n_rects; i++)
	    {
Owen W. Taylor's avatar
Owen W. Taylor committed
419
	      cairo_rectangle_int_t rect;
420

421
	      cairo_region_get_rectangle (blended_region, i, &rect);
422

423 424 425
	      if (!gdk_rectangle_intersect (&tex_rect, &rect, &rect))
		continue;

426
              paint_clipped_rectangle (fb, pipeline, &rect, &alloc);
427
            }
428

429
          goto out;
430 431 432
	}
    }

433 434 435 436
  cogl_framebuffer_draw_rectangle (fb, pipeline,
                                   0, 0,
                                   alloc.x2 - alloc.x1,
                                   alloc.y2 - alloc.y1);
437 438

 out:
439 440
  if (pipeline != NULL)
    cogl_object_unref (pipeline);
441 442
  if (blended_region != NULL)
    cairo_region_destroy (blended_region);
443 444 445
}

static void
446 447
meta_shaped_texture_pick (ClutterActor       *actor,
			  const ClutterColor *color)
448
{
449 450
  MetaShapedTexture *stex = (MetaShapedTexture *) actor;
  MetaShapedTexturePrivate *priv = stex->priv;
451

452 453 454 455
  if (!clutter_actor_should_pick_paint (actor) ||
      (priv->clip_region && cairo_region_is_empty (priv->clip_region)))
    return;

456
  /* If there is no region then use the regular pick */
457
  if (priv->input_shape_region == NULL)
458
    CLUTTER_ACTOR_CLASS (meta_shaped_texture_parent_class)->pick (actor, color);
459
  else
460
    {
461 462 463
      int n_rects;
      float *rectangles;
      int i;
464 465 466 467
      CoglPipeline *pipeline;
      CoglContext *ctx;
      CoglFramebuffer *fb;
      CoglColor cogl_color;
468

469 470 471 472 473 474 475 476 477 478
      /* Note: We don't bother trying to intersect the pick and clip regions
       * since needing to copy the region, do the intersection, and probably
       * increase the number of rectangles seems more likely to have a negative
       * effect.
       *
       * NB: Most of the time when just using rectangles for picking then
       * picking shouldn't involve any rendering, and minimizing the number of
       * rectangles has more benefit than reducing the area of the pick
       * region.
       */
479

480
      n_rects = cairo_region_num_rectangles (priv->input_shape_region);
481
      rectangles = g_alloca (sizeof (float) * 4 * n_rects);
482

483 484 485 486
      for (i = 0; i < n_rects; i++)
        {
          cairo_rectangle_int_t rect;
          int pos = i * 4;
487

488
          cairo_region_get_rectangle (priv->input_shape_region, i, &rect);
489

490 491 492 493 494
          rectangles[pos] = rect.x;
          rectangles[pos + 1] = rect.y;
          rectangles[pos + 2] = rect.x + rect.width;
          rectangles[pos + 3] = rect.y + rect.height;
        }
495

496 497 498 499 500 501 502
      ctx = clutter_backend_get_cogl_context (clutter_get_default_backend ());
      fb = cogl_get_draw_framebuffer ();

      cogl_color_init_from_4ub (&cogl_color, color->red, color->green, color->blue, color->alpha);

      pipeline = cogl_pipeline_new (ctx);
      cogl_pipeline_set_color (pipeline, &cogl_color);
503

504 505 506
      cogl_framebuffer_draw_rectangles (fb, pipeline,
                                        rectangles, n_rects);
      cogl_object_unref (pipeline);
507 508 509
    }
}

510
static void
511 512 513 514
meta_shaped_texture_get_preferred_width (ClutterActor *self,
                                         gfloat        for_height,
                                         gfloat       *min_width_p,
                                         gfloat       *natural_width_p)
515
{
516
  MetaShapedTexturePrivate *priv;
517

518
  g_return_if_fail (META_IS_SHAPED_TEXTURE (self));
519

520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545
  priv = META_SHAPED_TEXTURE (self)->priv;

  if (min_width_p)
    *min_width_p = 0;

  if (natural_width_p)
    *natural_width_p = priv->tex_width;
}

static void
meta_shaped_texture_get_preferred_height (ClutterActor *self,
                                          gfloat        for_width,
                                          gfloat       *min_height_p,
                                          gfloat       *natural_height_p)
{
  MetaShapedTexturePrivate *priv;

  g_return_if_fail (META_IS_SHAPED_TEXTURE (self));

  priv = META_SHAPED_TEXTURE (self)->priv;

  if (min_height_p)
    *min_height_p = 0;

  if (natural_height_p)
    *natural_height_p = priv->tex_height;
546 547
}

548 549 550 551 552 553 554
static gboolean
meta_shaped_texture_get_paint_volume (ClutterActor *self,
                                      ClutterPaintVolume *volume)
{
  return clutter_paint_volume_set_from_allocation (volume, self);
}

555
void
556 557
meta_shaped_texture_set_create_mipmaps (MetaShapedTexture *stex,
					gboolean           create_mipmaps)
558
{
559
  MetaShapedTexturePrivate *priv;
560

561
  g_return_if_fail (META_IS_SHAPED_TEXTURE (stex));
562 563 564 565 566 567 568

  priv = stex->priv;

  create_mipmaps = create_mipmaps != FALSE;

  if (create_mipmaps != priv->create_mipmaps)
    {
569
      CoglTexture *base_texture;
570
      priv->create_mipmaps = create_mipmaps;
571
      base_texture = create_mipmaps ? priv->texture : NULL;
572
      meta_texture_tower_set_base_texture (priv->paint_tower, base_texture);
573 574 575
    }
}

576
void
577
meta_shaped_texture_set_mask_texture (MetaShapedTexture *stex,
578
                                      CoglTexture       *mask_texture)
579
{
580
  MetaShapedTexturePrivate *priv;
581

582
  g_return_if_fail (META_IS_SHAPED_TEXTURE (stex));
583 584 585

  priv = stex->priv;

586
  g_clear_pointer (&priv->mask_texture, cogl_object_unref);
587

588
  if (mask_texture != NULL)
589
    {
590
      priv->mask_texture = mask_texture;
591
      cogl_object_ref (priv->mask_texture);
592
    }
593

594
  clutter_actor_queue_redraw (CLUTTER_ACTOR (stex));
595 596
}

597
static gboolean
598 599 600 601 602 603
get_clip (MetaShapedTexture *stex,
          int x,
          int y,
          int width,
          int height,
          cairo_rectangle_int_t *clip)
604
{
605
  ClutterActor *self = CLUTTER_ACTOR (stex);
606
  MetaShapedTexturePrivate *priv;
607
  ClutterActorBox allocation;
608 609
  double scale_x;
  double scale_y;
610 611 612 613 614

  /* NB: clutter_actor_queue_redraw_with_clip expects a box in the actor's
   * coordinate space so we need to convert from surface coordinates to
   * actor coordinates...
   */
615

616 617 618 619 620 621 622
  /* Calling clutter_actor_get_allocation_box() is enormously expensive
   * if the actor has an out-of-date allocation, since it triggers
   * a full redraw. clutter_actor_queue_redraw_with_clip() would redraw
   * the whole stage anyways in that case, so just go ahead and do
   * it here.
   */
  if (!clutter_actor_has_allocation (self))
623
    return FALSE;
624 625 626

  priv = stex->priv;

627
  if (priv->tex_width == 0 || priv->tex_height == 0)
628
    return FALSE;
629

630
  clutter_actor_get_allocation_box (self, &allocation);
631

632 633
  scale_x = (allocation.x2 - allocation.x1) / priv->tex_width;
  scale_y = (allocation.y2 - allocation.y1) / priv->tex_height;
634

635 636 637 638
  clip->x = x * scale_x;
  clip->y = y * scale_y;
  clip->width = width * scale_x;
  clip->height = height * scale_y;
639 640

  return TRUE;
641
}
642

643 644 645 646 647 648 649 650 651 652 653 654
/**
 * meta_shaped_texture_update_area:
 * @stex: #MetaShapedTexture
 * @x: the x coordinate of the damaged area
 * @y: the y coordinate of the damaged area
 * @width: the width of the damaged area
 * @height: the height of the damaged area
 * @unobscured_region: The unobscured region of the window or %NULL if
 * there is no valid one (like when the actor is transformed or
 * has a mapped clone)
 *
 * Repairs the damaged area indicated by @x, @y, @width and @height
655 656
 * and queues a redraw for the intersection @unobscured_region and
 * the damage area. If @unobscured_region is %NULL a redraw will always
657 658 659 660 661
 * get queued.
 *
 * Return value: Whether a redraw have been queued or not
 */
gboolean
662
meta_shaped_texture_update_area (MetaShapedTexture *stex,
663 664 665 666 667
				 int                x,
				 int                y,
				 int                width,
				 int                height,
				 cairo_region_t    *unobscured_region)
668 669
{
  MetaShapedTexturePrivate *priv;
670
  cairo_rectangle_int_t clip;
671
  gboolean has_clip;
672

673
  priv = stex->priv;
674

675
  if (priv->texture == NULL)
676
    return FALSE;
677 678 679

  meta_texture_tower_update_area (priv->paint_tower, x, y, width, height);

680
  has_clip = get_clip (stex, x, y, width, height, &clip);
681

682 683 684 685 686 687 688 689
  if (unobscured_region)
    {
      cairo_region_t *intersection;

      if (cairo_region_is_empty (unobscured_region))
        return FALSE;

      intersection = cairo_region_copy (unobscured_region);
690 691
      if (has_clip)
	cairo_region_intersect_rectangle (intersection, &clip);
692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707

      if (!cairo_region_is_empty (intersection))
        {
          cairo_rectangle_int_t damage_rect;
          cairo_region_get_extents (intersection, &damage_rect);
          clutter_actor_queue_redraw_with_clip (CLUTTER_ACTOR (stex), &damage_rect);
          cairo_region_destroy (intersection);

          return TRUE;
        }

      cairo_region_destroy (intersection);

      return FALSE;
    }

708 709 710 711
  if (has_clip)
    clutter_actor_queue_redraw_with_clip (CLUTTER_ACTOR (stex), &clip);
  else
    clutter_actor_queue_redraw (CLUTTER_ACTOR (stex));
712 713

  return TRUE;
714
}
715

716
/**
717
 * meta_shaped_texture_set_texture:
718
 * @stex: The #MetaShapedTexture
719
 * @pixmap: The #CoglTexture to display
720 721
 */
void
722 723
meta_shaped_texture_set_texture (MetaShapedTexture *stex,
                                 CoglTexture       *texture)
724 725 726
{
  g_return_if_fail (META_IS_SHAPED_TEXTURE (stex));

727
  set_cogl_texture (stex, texture);
728 729 730 731 732 733 734 735
}

/**
 * meta_shaped_texture_get_texture:
 * @stex: The #MetaShapedTexture
 *
 * Returns: (transfer none): the unshaped texture
 */
736
CoglTexture *
737 738
meta_shaped_texture_get_texture (MetaShapedTexture *stex)
{
739 740
  g_return_val_if_fail (META_IS_SHAPED_TEXTURE (stex), NULL);
  return COGL_TEXTURE (stex->priv->texture);
741 742
}

743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777
/**
 * meta_shaped_texture_set_input_shape_region:
 * @stex: a #MetaShapedTexture
 * @shape_region: the region of the texture that should respond to
 *    input.
 *
 * Determines what region of the texture should accept input. For
 * X based windows this is defined by the ShapeInput region of the
 * window.
 */
void
meta_shaped_texture_set_input_shape_region (MetaShapedTexture *stex,
                                            cairo_region_t    *shape_region)
{
  MetaShapedTexturePrivate *priv;

  g_return_if_fail (META_IS_SHAPED_TEXTURE (stex));

  priv = stex->priv;

  if (priv->input_shape_region != NULL)
    {
      cairo_region_destroy (priv->input_shape_region);
      priv->input_shape_region = NULL;
    }

  if (shape_region != NULL)
    {
      cairo_region_reference (shape_region);
      priv->input_shape_region = shape_region;
    }

  clutter_actor_queue_redraw (CLUTTER_ACTOR (stex));
}

778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807
/**
 * meta_shaped_texture_set_opaque_region:
 * @stex: a #MetaShapedTexture
 * @opaque_region: (transfer full): the region of the texture that
 *   can have blending turned off.
 *
 * As most windows have a large portion that does not require blending,
 * we can easily turn off blending if we know the areas that do not
 * require blending. This sets the region where we will not blend for
 * optimization purposes.
 */
void
meta_shaped_texture_set_opaque_region (MetaShapedTexture *stex,
                                       cairo_region_t    *opaque_region)
{
  MetaShapedTexturePrivate *priv;

  g_return_if_fail (META_IS_SHAPED_TEXTURE (stex));

  priv = stex->priv;

  if (priv->opaque_region)
    cairo_region_destroy (priv->opaque_region);

  if (opaque_region)
    priv->opaque_region = cairo_region_reference (opaque_region);
  else
    priv->opaque_region = NULL;
}

808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825
/**
 * meta_shaped_texture_get_image:
 * @stex: A #MetaShapedTexture
 * @clip: A clipping rectangle, to help prevent extra processing.
 * In the case that the clipping rectangle is partially or fully
 * outside the bounds of the texture, the rectangle will be clipped.
 *
 * Flattens the two layers of the shaped texture into one ARGB32
 * image by alpha blending the two images, and returns the flattened
 * image.
 *
 * Returns: (transfer full): a new cairo surface to be freed with
 * cairo_surface_destroy().
 */
cairo_surface_t *
meta_shaped_texture_get_image (MetaShapedTexture     *stex,
                               cairo_rectangle_int_t *clip)
{
826
  CoglTexture *texture, *mask_texture;
827 828 829 830 831
  cairo_rectangle_int_t texture_rect = { 0, 0, 0, 0 };
  cairo_surface_t *surface;

  g_return_val_if_fail (META_IS_SHAPED_TEXTURE (stex), NULL);

832
  texture = COGL_TEXTURE (stex->priv->texture);
833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868

  if (texture == NULL)
    return NULL;

  texture_rect.width = cogl_texture_get_width (texture);
  texture_rect.height = cogl_texture_get_height (texture);

  if (clip != NULL)
    {
      /* GdkRectangle is just a typedef of cairo_rectangle_int_t,
       * so we can use the gdk_rectangle_* APIs on these. */
      if (!gdk_rectangle_intersect (&texture_rect, clip, clip))
        return NULL;
    }

  if (clip != NULL)
    texture = cogl_texture_new_from_sub_texture (texture,
                                                 clip->x,
                                                 clip->y,
                                                 clip->width,
                                                 clip->height);

  surface = cairo_image_surface_create (CAIRO_FORMAT_ARGB32,
                                        cogl_texture_get_width (texture),
                                        cogl_texture_get_height (texture));

  cogl_texture_get_data (texture, CLUTTER_CAIRO_FORMAT_ARGB32,
                         cairo_image_surface_get_stride (surface),
                         cairo_image_surface_get_data (surface));

  cairo_surface_mark_dirty (surface);

  if (clip != NULL)
    cogl_object_unref (texture);

  mask_texture = stex->priv->mask_texture;
869
  if (mask_texture != NULL)
870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904
    {
      cairo_t *cr;
      cairo_surface_t *mask_surface;

      if (clip != NULL)
        mask_texture = cogl_texture_new_from_sub_texture (mask_texture,
                                                          clip->x,
                                                          clip->y,
                                                          clip->width,
                                                          clip->height);

      mask_surface = cairo_image_surface_create (CAIRO_FORMAT_A8,
                                                 cogl_texture_get_width (mask_texture),
                                                 cogl_texture_get_height (mask_texture));

      cogl_texture_get_data (mask_texture, COGL_PIXEL_FORMAT_A_8,
                             cairo_image_surface_get_stride (mask_surface),
                             cairo_image_surface_get_data (mask_surface));

      cairo_surface_mark_dirty (mask_surface);

      cr = cairo_create (surface);
      cairo_set_source_surface (cr, mask_surface, 0, 0);
      cairo_set_operator (cr, CAIRO_OPERATOR_DEST_IN);
      cairo_paint (cr);
      cairo_destroy (cr);

      cairo_surface_destroy (mask_surface);

      if (clip != NULL)
        cogl_object_unref (mask_texture);
    }

  return surface;
}
905

906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939
static void
meta_shaped_texture_cull_out (MetaCullable   *cullable,
                              cairo_region_t *unobscured_region,
                              cairo_region_t *clip_region)
{
  MetaShapedTexture *self = META_SHAPED_TEXTURE (cullable);
  MetaShapedTexturePrivate *priv = self->priv;

  set_clip_region (self, clip_region);

  if (clutter_actor_get_paint_opacity (CLUTTER_ACTOR (self)) == 0xff)
    {
      if (priv->opaque_region)
        {
          cairo_region_subtract (unobscured_region, priv->opaque_region);
          cairo_region_subtract (clip_region, priv->opaque_region);
        }
    }
}

static void
meta_shaped_texture_reset_culling (MetaCullable *cullable)
{
  MetaShapedTexture *self = META_SHAPED_TEXTURE (cullable);
  set_clip_region (self, NULL);
}

static void
cullable_iface_init (MetaCullableInterface *iface)
{
  iface->cull_out = meta_shaped_texture_cull_out;
  iface->reset_culling = meta_shaped_texture_reset_culling;
}

940 941 942 943 944
ClutterActor *
meta_shaped_texture_new (void)
{
  return g_object_new (META_TYPE_SHAPED_TEXTURE, NULL);
}