meta-shaped-texture.c 31.9 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 19 20 21 22 23
 *
 * 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
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 * 02111-1307, USA.
 */

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

30 31
#include <config.h>

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

36
#include "meta-shaped-texture-private.h"
37 38 39
#include "meta-wayland-private.h"
#include <cogl/cogl-wayland-server.h>

Thomas Wood's avatar
Thomas Wood committed
40
#include <clutter/clutter.h>
41
#include <cogl/cogl.h>
42
#include <cogl/cogl-texture-pixmap-x11.h>
43
#include <gdk/gdk.h> /* for gdk_rectangle_intersect() */
44

45
static void meta_shaped_texture_dispose  (GObject    *object);
46

47 48 49
static void meta_shaped_texture_paint (ClutterActor       *actor);
static void meta_shaped_texture_pick  (ClutterActor       *actor,
				       const ClutterColor *color);
50

51 52 53 54 55 56 57 58 59
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);
60

61 62
static gboolean meta_shaped_texture_get_paint_volume (ClutterActor *self, ClutterPaintVolume *volume);

63 64 65 66 67 68 69
typedef enum _MetaShapedTextureType
{
  META_SHAPED_TEXTURE_TYPE_X11_PIXMAP,
  META_SHAPED_TEXTURE_TYPE_WAYLAND_SURFACE,
} MetaShapedTextureType;


70
G_DEFINE_TYPE (MetaShapedTexture, meta_shaped_texture,
71
               CLUTTER_TYPE_ACTOR);
72

73 74 75
#define META_SHAPED_TEXTURE_GET_PRIVATE(obj) \
  (G_TYPE_INSTANCE_GET_PRIVATE ((obj), META_TYPE_SHAPED_TEXTURE, \
                                MetaShapedTexturePrivate))
76

77
struct _MetaShapedTexturePrivate
78
{
79
  MetaTextureTower *paint_tower;
80 81 82 83 84 85 86 87 88 89 90 91 92

  MetaShapedTextureType type;
  union {
    struct {
      Pixmap pixmap;
    } x11;
    struct {
      MetaWaylandSurface *surface;
    } wayland;
  };

  CoglTexture *texture;

93
  CoglTexture *mask_texture;
94

Owen W. Taylor's avatar
Owen W. Taylor committed
95
  cairo_region_t *clip_region;
96
  cairo_region_t *input_shape_region;
97
  cairo_region_t *opaque_region;
98

99
  guint tex_width, tex_height;
100

101
  guint create_mipmaps : 1;
102 103 104
};

static void
105
meta_shaped_texture_class_init (MetaShapedTextureClass *klass)
106 107 108 109
{
  GObjectClass *gobject_class = (GObjectClass *) klass;
  ClutterActorClass *actor_class = (ClutterActorClass *) klass;

110
  gobject_class->dispose = meta_shaped_texture_dispose;
111

112 113
  actor_class->get_preferred_width = meta_shaped_texture_get_preferred_width;
  actor_class->get_preferred_height = meta_shaped_texture_get_preferred_height;
114 115
  actor_class->paint = meta_shaped_texture_paint;
  actor_class->pick = meta_shaped_texture_pick;
116
  actor_class->get_paint_volume = meta_shaped_texture_get_paint_volume;
117

118
  g_type_class_add_private (klass, sizeof (MetaShapedTexturePrivate));
119 120 121
}

static void
122
meta_shaped_texture_init (MetaShapedTexture *self)
123
{
124
  MetaShapedTexturePrivate *priv;
125

126
  priv = self->priv = META_SHAPED_TEXTURE_GET_PRIVATE (self);
127

128
  priv->paint_tower = meta_texture_tower_new ();
129 130

  priv->type = META_SHAPED_TEXTURE_TYPE_X11_PIXMAP;
131
  priv->texture = NULL;
132

133
  priv->mask_texture = NULL;
134
  priv->create_mipmaps = TRUE;
135 136 137
}

static void
138
meta_shaped_texture_dispose (GObject *object)
139
{
140 141
  MetaShapedTexture *self = (MetaShapedTexture *) object;
  MetaShapedTexturePrivate *priv = self->priv;
142

143
  if (priv->paint_tower)
144
    meta_texture_tower_free (priv->paint_tower);
145 146
  priv->paint_tower = NULL;

147
  g_clear_pointer (&priv->texture, cogl_object_unref);
148
  g_clear_pointer (&priv->opaque_region, cairo_region_destroy);
149

150
  meta_shaped_texture_set_mask_texture (self, NULL);
151
  meta_shaped_texture_set_clip_region (self, NULL);
152

153
  G_OBJECT_CLASS (meta_shaped_texture_parent_class)->dispose (object);
154 155
}

156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
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);
}

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 214 215 216 217 218 219 220 221 222 223 224 225
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);

}


226 227 228 229 230 231 232 233 234 235 236 237 238 239
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);

240
  priv->texture = cogl_object_ref (cogl_tex);
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269

  if (cogl_tex != NULL)
    {
      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. */
}

270
static void
271
meta_shaped_texture_paint (ClutterActor *actor)
272
{
273 274
  MetaShapedTexture *stex = (MetaShapedTexture *) actor;
  MetaShapedTexturePrivate *priv = stex->priv;
275
  guint tex_width, tex_height;
276
  guchar opacity;
277
  CoglContext *ctx;
278 279 280 281
  CoglFramebuffer *fb;
  CoglPipeline *pipeline = NULL;
  CoglTexture *paint_tex;
  ClutterActorBox alloc;
282
  cairo_region_t *blended_region = NULL;
283

Owen W. Taylor's avatar
Owen W. Taylor committed
284
  if (priv->clip_region && cairo_region_is_empty (priv->clip_region))
285 286
    return;

287 288 289
  if (!CLUTTER_ACTOR_IS_REALIZED (CLUTTER_ACTOR (stex)))
    clutter_actor_realize (CLUTTER_ACTOR (stex));

290 291 292 293
  /* 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:
294
   *
295 296
   *  - Updating mipmaps that we don't need
   *  - Having to reallocate pixmaps on the server into larger buffers
297
   *
298 299 300 301 302 303
   * 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.
304
   */
305
  if (priv->create_mipmaps)
306
    paint_tex = meta_texture_tower_get_paint_texture (priv->paint_tower);
307
  else
308
    paint_tex = COGL_TEXTURE (priv->texture);
309

310
  if (paint_tex == NULL)
311
    return;
312

313 314
  tex_width = priv->tex_width;
  tex_height = priv->tex_height;
315

316
  if (tex_width == 0 || tex_height == 0) /* no contents yet */
317 318
    return;

319
  ctx = clutter_backend_get_cogl_context (clutter_get_default_backend ());
320
  fb = cogl_get_draw_framebuffer ();
321

322 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 349 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
  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);

      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;

380
  if (priv->mask_texture == NULL)
381
    {
382
      pipeline = get_unmasked_pipeline (ctx);
383 384
    }
  else
385
    {
386
      pipeline = get_masked_pipeline (ctx);
387
      cogl_pipeline_set_layer_texture (pipeline, 1, priv->mask_texture);
388 389
    }

390
  cogl_pipeline_set_layer_texture (pipeline, 0, paint_tex);
391

392 393
  {
    CoglColor color;
394
    cogl_color_init_from_4ub (&color, opacity, opacity, opacity, opacity);
395
    cogl_pipeline_set_color (pipeline, &color);
396
  }
397

398
  if (blended_region != NULL)
399 400 401 402 403 404 405
    {
      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

406
      n_rects = cairo_region_num_rectangles (blended_region);
Owen W. Taylor's avatar
Owen W. Taylor committed
407
      if (n_rects <= MAX_RECTS)
408
	{
409 410
          int i;
          cairo_rectangle_int_t tex_rect = { 0, 0, tex_width, tex_height };
411

412 413
	  for (i = 0; i < n_rects; i++)
	    {
Owen W. Taylor's avatar
Owen W. Taylor committed
414
	      cairo_rectangle_int_t rect;
415

416
	      cairo_region_get_rectangle (blended_region, i, &rect);
417

418 419 420
	      if (!gdk_rectangle_intersect (&tex_rect, &rect, &rect))
		continue;

421
              paint_clipped_rectangle (fb, pipeline, &rect, &alloc);
422
            }
423

424
          goto out;
425 426 427
	}
    }

428 429 430 431
  cogl_framebuffer_draw_rectangle (fb, pipeline,
                                   0, 0,
                                   alloc.x2 - alloc.x1,
                                   alloc.y2 - alloc.y1);
432 433

 out:
434 435
  if (pipeline != NULL)
    cogl_object_unref (pipeline);
436 437
  if (blended_region != NULL)
    cairo_region_destroy (blended_region);
438 439 440
}

static void
441 442
meta_shaped_texture_pick (ClutterActor       *actor,
			  const ClutterColor *color)
443
{
444 445
  MetaShapedTexture *stex = (MetaShapedTexture *) actor;
  MetaShapedTexturePrivate *priv = stex->priv;
446

447 448 449 450
  if (!clutter_actor_should_pick_paint (actor) ||
      (priv->clip_region && cairo_region_is_empty (priv->clip_region)))
    return;

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

464 465 466 467 468 469 470 471 472 473
      /* 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.
       */
474

475
      n_rects = cairo_region_num_rectangles (priv->input_shape_region);
476
      rectangles = g_alloca (sizeof (float) * 4 * n_rects);
477

478 479 480 481
      for (i = 0; i < n_rects; i++)
        {
          cairo_rectangle_int_t rect;
          int pos = i * 4;
482

483
          cairo_region_get_rectangle (priv->input_shape_region, i, &rect);
484

485 486 487 488 489
          rectangles[pos] = rect.x;
          rectangles[pos + 1] = rect.y;
          rectangles[pos + 2] = rect.x + rect.width;
          rectangles[pos + 3] = rect.y + rect.height;
        }
490

491 492 493 494 495 496 497
      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);
498

499 500 501
      cogl_framebuffer_draw_rectangles (fb, pipeline,
                                        rectangles, n_rects);
      cogl_object_unref (pipeline);
502 503 504
    }
}

505
static void
506 507 508 509
meta_shaped_texture_get_preferred_width (ClutterActor *self,
                                         gfloat        for_height,
                                         gfloat       *min_width_p,
                                         gfloat       *natural_width_p)
510
{
511
  MetaShapedTexturePrivate *priv;
512

513
  g_return_if_fail (META_IS_SHAPED_TEXTURE (self));
514

515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540
  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;
541 542
}

543 544 545 546 547 548 549
static gboolean
meta_shaped_texture_get_paint_volume (ClutterActor *self,
                                      ClutterPaintVolume *volume)
{
  return clutter_paint_volume_set_from_allocation (volume, self);
}

550
ClutterActor *
551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568
meta_shaped_texture_new_with_wayland_surface (MetaWaylandSurface *surface)
{
  ClutterActor *actor = g_object_new (META_TYPE_SHAPED_TEXTURE, NULL);
  MetaShapedTexturePrivate *priv = META_SHAPED_TEXTURE (actor)->priv;

  /* XXX: it could probably be better to have a "type" construct-only
   * property or create wayland/x11 subclasses */
  priv->type = META_SHAPED_TEXTURE_TYPE_WAYLAND_SURFACE;

  meta_shaped_texture_set_wayland_surface (META_SHAPED_TEXTURE (actor),
                                           surface);

  return actor;
}

void
meta_shaped_texture_set_wayland_surface (MetaShapedTexture *stex,
                                         MetaWaylandSurface *surface)
569
{
570 571 572
  MetaShapedTexturePrivate *priv = stex->priv;

  priv->wayland.surface = surface;
573

574 575 576 577 578 579 580 581 582 583 584 585 586 587 588
  if (surface && surface->buffer_ref.buffer)
    meta_shaped_texture_attach_wayland_buffer (stex,
                                               surface->buffer_ref.buffer);
}

MetaWaylandSurface *
meta_shaped_texture_get_wayland_surface (MetaShapedTexture *stex)
{
  MetaShapedTexturePrivate *priv = stex->priv;
  return priv->wayland.surface;
}

ClutterActor *
meta_shaped_texture_new_with_xwindow (Window xwindow)
{
589
  return g_object_new (META_TYPE_SHAPED_TEXTURE, NULL);
590 591
}

592
void
593 594
meta_shaped_texture_set_create_mipmaps (MetaShapedTexture *stex,
					gboolean           create_mipmaps)
595
{
596
  MetaShapedTexturePrivate *priv;
597

598
  g_return_if_fail (META_IS_SHAPED_TEXTURE (stex));
599 600 601 602 603 604 605

  priv = stex->priv;

  create_mipmaps = create_mipmaps != FALSE;

  if (create_mipmaps != priv->create_mipmaps)
    {
606
      CoglTexture *base_texture;
607
      priv->create_mipmaps = create_mipmaps;
608
      base_texture = create_mipmaps ? priv->texture : NULL;
609
      meta_texture_tower_set_base_texture (priv->paint_tower, base_texture);
610 611 612
    }
}

613
void
614
meta_shaped_texture_set_mask_texture (MetaShapedTexture *stex,
615
                                      CoglTexture       *mask_texture)
616
{
617
  MetaShapedTexturePrivate *priv;
618

619
  g_return_if_fail (META_IS_SHAPED_TEXTURE (stex));
620 621 622

  priv = stex->priv;

623
  g_clear_pointer (&priv->mask_texture, cogl_object_unref);
624

625
  if (mask_texture != NULL)
626
    {
627
      priv->mask_texture = mask_texture;
628
      cogl_object_ref (priv->mask_texture);
629
    }
630

631
  clutter_actor_queue_redraw (CLUTTER_ACTOR (stex));
632 633
}

634 635 636 637 638 639
static void
wayland_surface_update_area (MetaShapedTexture *stex,
                             int                x,
                             int                y,
                             int                width,
                             int                height)
640
{
641
  MetaShapedTexturePrivate *priv;
642
  MetaWaylandBuffer *buffer;
643 644 645

  priv = stex->priv;

646 647
  g_return_if_fail (priv->type == META_SHAPED_TEXTURE_TYPE_WAYLAND_SURFACE);
  g_return_if_fail (priv->texture != NULL);
648

649
  buffer = priv->wayland.surface->buffer_ref.buffer;
650

651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680
  if (buffer)
    {
      struct wl_resource *resource = buffer->resource;
      struct wl_shm_buffer *shm_buffer = wl_shm_buffer_get (resource);

      if (shm_buffer)
        {
          CoglPixelFormat format;

          switch (wl_shm_buffer_get_format (shm_buffer))
            {
#if G_BYTE_ORDER == G_BIG_ENDIAN
            case WL_SHM_FORMAT_ARGB8888:
              format = COGL_PIXEL_FORMAT_ARGB_8888_PRE;
              break;
            case WL_SHM_FORMAT_XRGB8888:
              format = COGL_PIXEL_FORMAT_ARGB_8888;
              break;
#elif G_BYTE_ORDER == G_LITTLE_ENDIAN
            case WL_SHM_FORMAT_ARGB8888:
              format = COGL_PIXEL_FORMAT_BGRA_8888_PRE;
              break;
            case WL_SHM_FORMAT_XRGB8888:
              format = COGL_PIXEL_FORMAT_BGRA_8888;
              break;
#endif
            default:
              g_warn_if_reached ();
              format = COGL_PIXEL_FORMAT_ARGB_8888;
            }
681

682 683 684 685 686 687 688 689 690 691
          cogl_texture_set_region (priv->texture,
                                   x, y,
                                   x, y,
                                   width, height,
                                   width, height,
                                   format,
                                   wl_shm_buffer_get_stride (shm_buffer),
                                   wl_shm_buffer_get_data (shm_buffer));
        }
    }
692 693
}

694
static gboolean
695 696 697 698 699 700
get_clip (MetaShapedTexture *stex,
          int x,
          int y,
          int width,
          int height,
          cairo_rectangle_int_t *clip)
701
{
702
  ClutterActor *self = CLUTTER_ACTOR (stex);
703
  MetaShapedTexturePrivate *priv;
704 705 706 707 708 709 710 711
  ClutterActorBox allocation;
  float scale_x;
  float scale_y;

  /* 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...
   */
712

713 714 715 716 717 718 719
  /* 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))
720
    return FALSE;
721 722 723

  priv = stex->priv;

724
  if (priv->tex_width == 0 || priv->tex_height == 0)
725
    return FALSE;
726

727
  clutter_actor_get_allocation_box (self, &allocation);
728

729 730
  scale_x = (allocation.x2 - allocation.x1) / priv->tex_width;
  scale_y = (allocation.y2 - allocation.y1) / priv->tex_height;
731

732 733 734 735
  clip->x = x * scale_x;
  clip->y = y * scale_y;
  clip->width = width * scale_x;
  clip->height = height * scale_y;
736 737

  return TRUE;
738
}
739

740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758
/**
 * 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
 * and queues a redraw for the intersection @visibible_region and
 * the damage area. If @visibible_region is %NULL a redraw will always
 * get queued.
 *
 * Return value: Whether a redraw have been queued or not
 */
gboolean
759
meta_shaped_texture_update_area (MetaShapedTexture *stex,
760 761 762 763 764
				 int                x,
				 int                y,
				 int                width,
				 int                height,
				 cairo_region_t    *unobscured_region)
765 766
{
  MetaShapedTexturePrivate *priv;
767
  cairo_rectangle_int_t clip;
768
  gboolean has_clip;
769

770
  priv = stex->priv;
771

772
  if (priv->texture == NULL)
773
    return FALSE;
774 775

  switch (priv->type)
776
    {
777 778 779 780 781 782 783
    case META_SHAPED_TEXTURE_TYPE_X11_PIXMAP:
      cogl_texture_pixmap_x11_update_area (COGL_TEXTURE_PIXMAP_X11 (priv->texture),
                                           x, y, width, height);
      break;
    case META_SHAPED_TEXTURE_TYPE_WAYLAND_SURFACE:
      wayland_surface_update_area (stex, x, y, width, height);
      break;
784
    }
785

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

788
  has_clip = get_clip (stex, x, y, width, height, &clip);
789

790 791 792 793 794 795 796 797
  if (unobscured_region)
    {
      cairo_region_t *intersection;

      if (cairo_region_is_empty (unobscured_region))
        return FALSE;

      intersection = cairo_region_copy (unobscured_region);
798 799
      if (has_clip)
	cairo_region_intersect_rectangle (intersection, &clip);
800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815

      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;
    }

816 817 818 819
  if (has_clip)
    clutter_actor_queue_redraw_with_clip (CLUTTER_ACTOR (stex), &clip);
  else
    clutter_actor_queue_redraw (CLUTTER_ACTOR (stex));
820 821

  return TRUE;
822
}
823

824 825 826 827 828 829 830 831 832 833 834 835 836 837 838
/**
 * meta_shaped_texture_set_pixmap:
 * @stex: The #MetaShapedTexture
 * @pixmap: The pixmap you want the stex to assume
 */
void
meta_shaped_texture_set_pixmap (MetaShapedTexture *stex,
                                Pixmap             pixmap)
{
  MetaShapedTexturePrivate *priv;

  g_return_if_fail (META_IS_SHAPED_TEXTURE (stex));

  priv = stex->priv;

839
  if (priv->x11.pixmap == pixmap)
840 841
    return;

842
  priv->x11.pixmap = pixmap;
843 844

  if (pixmap != None)
845 846 847
    {
      CoglContext *ctx =
        clutter_backend_get_cogl_context (clutter_get_default_backend ());
848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877
      CoglTexture *texture =
        COGL_TEXTURE (cogl_texture_pixmap_x11_new (ctx, pixmap, FALSE, NULL));
      set_cogl_texture (stex, texture);
    }
  else
    set_cogl_texture (stex, NULL);

  if (priv->create_mipmaps)
    meta_texture_tower_set_base_texture (priv->paint_tower,
                                         COGL_TEXTURE (priv->texture));
}

void
meta_shaped_texture_attach_wayland_buffer (MetaShapedTexture  *stex,
                                           MetaWaylandBuffer  *buffer)
{
  MetaShapedTexturePrivate *priv;

  g_return_if_fail (META_IS_SHAPED_TEXTURE (stex));

  priv = stex->priv;

  /* TODO: we should change this api to be something like
   * meta_shaped_texture_notify_buffer_attach() since we now maintain
   * a reference to the MetaWaylandSurface where we can access the
   * buffer without it being explicitly passed as an argument.
   */
  g_return_if_fail (priv->wayland.surface->buffer_ref.buffer == buffer);

  if (buffer)
878
    set_cogl_texture (stex, buffer->texture);
879
  else
880
    set_cogl_texture (stex, NULL);
881 882

  if (priv->create_mipmaps)
883 884
    meta_texture_tower_set_base_texture (priv->paint_tower,
                                         COGL_TEXTURE (priv->texture));
885 886 887 888 889 890 891 892
}

/**
 * meta_shaped_texture_get_texture:
 * @stex: The #MetaShapedTexture
 *
 * Returns: (transfer none): the unshaped texture
 */
893
CoglTexture *
894 895
meta_shaped_texture_get_texture (MetaShapedTexture *stex)
{
896 897
  g_return_val_if_fail (META_IS_SHAPED_TEXTURE (stex), NULL);
  return COGL_TEXTURE (stex->priv->texture);
898 899
}

900 901 902 903 904 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
/**
 * 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));
}

935
/**
936
 * meta_shaped_texture_set_clip_region:
937
 * @stex: a #MetaShapedTexture
938 939
 * @clip_region: the region of the texture that is visible and
 *   should be painted.
940 941 942 943 944 945 946 947 948 949
 *
 * Provides a hint to the texture about what areas of the texture
 * are not completely obscured and thus need to be painted. This
 * is an optimization and is not supposed to have any effect on
 * the output.
 *
 * Typically a parent container will set the clip region before
 * painting its children, and then unset it afterwards.
 */
void
950 951
meta_shaped_texture_set_clip_region (MetaShapedTexture *stex,
				     cairo_region_t    *clip_region)
952
{
953
  MetaShapedTexturePrivate *priv;
954

955
  g_return_if_fail (META_IS_SHAPED_TEXTURE (stex));
956 957 958 959

  priv = stex->priv;

  if (priv->clip_region)
960
    cairo_region_destroy (priv->clip_region);
961

962 963 964 965
  if (clip_region)
    priv->clip_region = cairo_region_copy (clip_region);
  else
    priv->clip_region = NULL;
966
}
967

968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997
/**
 * 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;
}

998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015
/**
 * 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)
{
1016
  CoglTexture *texture, *mask_texture;
1017 1018 1019 1020 1021
  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);

1022
  texture = COGL_TEXTURE (stex->priv->texture);
1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058

  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;
1059
  if (mask_texture != NULL)
1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094
    {
      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;
}