gtkpixelcache.c 14.7 KB
Newer Older
Alexander Larsson's avatar
Alexander Larsson committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
/* GTK - The GIMP Toolkit
 * Copyright (C) 2013 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
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
 */

#include "config.h"

20
#include "gtkdebug.h"
Alexander Larsson's avatar
Alexander Larsson committed
21 22
#include "gtkpixelcacheprivate.h"

23 24
#define BLOW_CACHE_TIMEOUT_SEC 20

Alexander Larsson's avatar
Alexander Larsson committed
25 26
/* The extra size of the offscreen surface we allocate
   to make scrolling more efficient */
27
#define DEFAULT_EXTRA_SIZE 64
Alexander Larsson's avatar
Alexander Larsson committed
28

29
/* When resizing viewport we allow this extra
Alexander Larsson's avatar
Alexander Larsson committed
30
   size to avoid constantly reallocating when resizing */
31
#define ALLOW_SMALLER_SIZE 32
Alexander Larsson's avatar
Alexander Larsson committed
32 33 34 35
#define ALLOW_LARGER_SIZE 32

struct _GtkPixelCache {
  cairo_surface_t *surface;
36
  cairo_content_t content;
Alexander Larsson's avatar
Alexander Larsson committed
37 38 39 40 41 42

  /* Valid if surface != NULL */
  int surface_x;
  int surface_y;
  int surface_w;
  int surface_h;
43
  double surface_scale;
Alexander Larsson's avatar
Alexander Larsson committed
44 45 46

  /* may be null if not dirty */
  cairo_region_t *surface_dirty;
47 48

  guint timeout_tag;
49 50 51

  guint extra_width;
  guint extra_height;
52 53

  guint always_cache : 1;
Alexander Larsson's avatar
Alexander Larsson committed
54 55 56 57 58 59 60 61
};

GtkPixelCache *
_gtk_pixel_cache_new ()
{
  GtkPixelCache *cache;

  cache = g_new0 (GtkPixelCache, 1);
62 63
  cache->extra_width = DEFAULT_EXTRA_SIZE;
  cache->extra_height = DEFAULT_EXTRA_SIZE;
Alexander Larsson's avatar
Alexander Larsson committed
64 65 66 67 68 69 70 71 72 73

  return cache;
}

void
_gtk_pixel_cache_free (GtkPixelCache *cache)
{
  if (cache == NULL)
    return;

74 75 76 77 78 79 80 81
  if (cache->timeout_tag ||
      cache->surface ||
      cache->surface_dirty)
    {
      g_warning ("pixel cache freed that wasn't unmapped: tag %u surface %p sirty %p",
                 cache->timeout_tag, cache->surface, cache->surface_dirty);
    }

82 83 84
  if (cache->timeout_tag)
    g_source_remove (cache->timeout_tag);

Alexander Larsson's avatar
Alexander Larsson committed
85 86 87 88 89 90 91 92 93
  if (cache->surface != NULL)
    cairo_surface_destroy (cache->surface);

  if (cache->surface_dirty != NULL)
    cairo_region_destroy (cache->surface_dirty);

  g_free (cache);
}

94 95 96 97 98 99 100 101 102
void
_gtk_pixel_cache_set_extra_size (GtkPixelCache *cache,
                                 guint          extra_width,
                                 guint          extra_height)
{
  cache->extra_width = extra_width ? extra_width : DEFAULT_EXTRA_SIZE;
  cache->extra_height = extra_height ? extra_height : DEFAULT_EXTRA_SIZE;
}

103 104 105 106 107 108 109 110 111 112 113 114
void
_gtk_pixel_cache_get_extra_size (GtkPixelCache *cache,
                                 guint         *extra_width,
                                 guint         *extra_height)
{
  if (extra_width)
    *extra_width = cache->extra_width;

  if (extra_height)
    *extra_height = cache->extra_height;
}

115 116
void
_gtk_pixel_cache_set_content (GtkPixelCache   *cache,
117
                              cairo_content_t  content)
118 119 120 121 122
{
  cache->content = content;
  _gtk_pixel_cache_invalidate (cache, NULL);
}

Alexander Larsson's avatar
Alexander Larsson committed
123 124
/* Region is in canvas coordinates */
void
125 126
_gtk_pixel_cache_invalidate (GtkPixelCache  *cache,
                             cairo_region_t *region)
Alexander Larsson's avatar
Alexander Larsson committed
127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142
{
  cairo_rectangle_int_t r;
  cairo_region_t *free_region = NULL;

  if (cache->surface == NULL ||
      (region != NULL && cairo_region_is_empty (region)))
    return;

  if (region == NULL)
    {
      r.x = cache->surface_x;
      r.y = cache->surface_y;
      r.width = cache->surface_w;
      r.height = cache->surface_h;

      free_region = region =
143
        cairo_region_create_rectangle (&r);
Alexander Larsson's avatar
Alexander Larsson committed
144 145 146 147 148 149
    }

  if (cache->surface_dirty == NULL)
    {
      cache->surface_dirty = cairo_region_copy (region);
      cairo_region_translate (cache->surface_dirty,
150 151
                              -cache->surface_x,
                              -cache->surface_y);
Alexander Larsson's avatar
Alexander Larsson committed
152 153 154 155
    }
  else
    {
      cairo_region_translate (region,
156 157
                              -cache->surface_x,
                              -cache->surface_y);
Alexander Larsson's avatar
Alexander Larsson committed
158 159
      cairo_region_union (cache->surface_dirty, region);
      cairo_region_translate (region,
160 161
                              cache->surface_x,
                              cache->surface_y);
Alexander Larsson's avatar
Alexander Larsson committed
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
    }

  if (free_region)
    cairo_region_destroy (free_region);

  r.x = 0;
  r.y = 0;
  r.width = cache->surface_w;
  r.height = cache->surface_h;

  cairo_region_intersect_rectangle (cache->surface_dirty, &r);
}

static void
_gtk_pixel_cache_create_surface_if_needed (GtkPixelCache         *cache,
177 178 179
                                           GdkWindow             *window,
                                           cairo_rectangle_int_t *view_rect,
                                           cairo_rectangle_int_t *canvas_rect)
Alexander Larsson's avatar
Alexander Larsson committed
180 181 182 183 184 185 186
{
  cairo_rectangle_int_t rect;
  int surface_w, surface_h;
  cairo_content_t content;
  cairo_pattern_t *bg;
  double red, green, blue, alpha;

187
#ifdef G_ENABLE_DEBUG
188
  if (GTK_DEBUG_CHECK (NO_PIXEL_CACHE))
189 190 191
    return;
#endif

192 193 194 195 196 197 198 199 200 201 202
  content = cache->content;
  if (!content)
    {
      content = CAIRO_CONTENT_COLOR_ALPHA;
      bg = gdk_window_get_background_pattern (window);
      if (bg != NULL &&
          cairo_pattern_get_type (bg) == CAIRO_PATTERN_TYPE_SOLID &&
          cairo_pattern_get_rgba (bg, &red, &green, &blue, &alpha) == CAIRO_STATUS_SUCCESS &&
          alpha == 1.0)
        content = CAIRO_CONTENT_COLOR;
    }
Alexander Larsson's avatar
Alexander Larsson committed
203 204 205

  surface_w = view_rect->width;
  if (canvas_rect->width > surface_w)
206
    surface_w = MIN (surface_w + cache->extra_width, canvas_rect->width);
Alexander Larsson's avatar
Alexander Larsson committed
207 208 209

  surface_h = view_rect->height;
  if (canvas_rect->height > surface_h)
210
    surface_h = MIN (surface_h + cache->extra_height, canvas_rect->height);
Alexander Larsson's avatar
Alexander Larsson committed
211 212 213 214

  /* If current surface can't fit view_rect or is too large, kill it */
  if (cache->surface != NULL &&
      (cairo_surface_get_content (cache->surface) != content ||
215
       cache->surface_w < MAX(view_rect->width, surface_w - ALLOW_SMALLER_SIZE) ||
Alexander Larsson's avatar
Alexander Larsson committed
216
       cache->surface_w > surface_w + ALLOW_LARGER_SIZE ||
217
       cache->surface_h < MAX(view_rect->height, surface_h - ALLOW_SMALLER_SIZE) ||
218 219
       cache->surface_h > surface_h + ALLOW_LARGER_SIZE ||
       cache->surface_scale != gdk_window_get_scale_factor (window)))
Alexander Larsson's avatar
Alexander Larsson committed
220 221 222 223
    {
      cairo_surface_destroy (cache->surface);
      cache->surface = NULL;
      if (cache->surface_dirty)
224
        cairo_region_destroy (cache->surface_dirty);
Alexander Larsson's avatar
Alexander Larsson committed
225 226 227 228
      cache->surface_dirty = NULL;
    }

  /* Don't allocate a surface if view >= canvas, as we won't
229 230
   * be scrolling then anyway, unless the widget requested it.
   */
Alexander Larsson's avatar
Alexander Larsson committed
231
  if (cache->surface == NULL &&
232 233 234
      (cache->always_cache ||
       (view_rect->width < canvas_rect->width ||
        view_rect->height < canvas_rect->height)))
Alexander Larsson's avatar
Alexander Larsson committed
235 236 237 238 239
    {
      cache->surface_x = -canvas_rect->x;
      cache->surface_y = -canvas_rect->y;
      cache->surface_w = surface_w;
      cache->surface_h = surface_h;
240
      cache->surface_scale = gdk_window_get_scale_factor (window);
Alexander Larsson's avatar
Alexander Larsson committed
241 242

      cache->surface =
243 244
        gdk_window_create_similar_surface (window, content,
                                           surface_w, surface_h);
Alexander Larsson's avatar
Alexander Larsson committed
245 246 247 248 249
      rect.x = 0;
      rect.y = 0;
      rect.width = surface_w;
      rect.height = surface_h;
      cache->surface_dirty =
250
        cairo_region_create_rectangle (&rect);
Alexander Larsson's avatar
Alexander Larsson committed
251 252 253
    }
}

254
static void
Alexander Larsson's avatar
Alexander Larsson committed
255
_gtk_pixel_cache_set_position (GtkPixelCache         *cache,
256 257
                               cairo_rectangle_int_t *view_rect,
                               cairo_rectangle_int_t *canvas_rect)
Alexander Larsson's avatar
Alexander Larsson committed
258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274
{
  cairo_rectangle_int_t r, view_pos;
  cairo_region_t *copy_region;
  int new_surf_x, new_surf_y;
  cairo_t *backing_cr;

  if (cache->surface == NULL)
    return;

  /* Position of view inside canvas */
  view_pos.x = -canvas_rect->x;
  view_pos.y = -canvas_rect->y;
  view_pos.width = view_rect->width;
  view_pos.height = view_rect->height;

  /* Reposition so all is visible */
  if (view_pos.x < cache->surface_x ||
275
      view_pos.x + view_pos.width > cache->surface_x + cache->surface_w ||
Alexander Larsson's avatar
Alexander Larsson committed
276
      view_pos.y < cache->surface_y ||
277
      view_pos.y + view_pos.height > cache->surface_y + cache->surface_h)
Alexander Larsson's avatar
Alexander Larsson committed
278 279 280
    {
      new_surf_x = cache->surface_x;
      if (view_pos.x < cache->surface_x)
281
        new_surf_x = MAX (view_pos.x + view_pos.width - cache->surface_w, 0);
Alexander Larsson's avatar
Alexander Larsson committed
282
      else if (view_pos.x + view_pos.width >
283 284
               cache->surface_x + cache->surface_w)
        new_surf_x = MIN (view_pos.x, canvas_rect->width - cache->surface_w);
Alexander Larsson's avatar
Alexander Larsson committed
285 286 287

      new_surf_y = cache->surface_y;
      if (view_pos.y < cache->surface_y)
288
        new_surf_y = MAX (view_pos.y + view_pos.height - cache->surface_h, 0);
Alexander Larsson's avatar
Alexander Larsson committed
289
      else if (view_pos.y + view_pos.height >
290 291
               cache->surface_y + cache->surface_h)
        new_surf_y = MIN (view_pos.y, canvas_rect->height - cache->surface_h);
Alexander Larsson's avatar
Alexander Larsson committed
292 293 294 295 296 297 298 299

      r.x = 0;
      r.y = 0;
      r.width = cache->surface_w;
      r.height = cache->surface_h;
      copy_region = cairo_region_create_rectangle (&r);

      if (cache->surface_dirty)
300 301 302 303 304
        {
          cairo_region_subtract (copy_region, cache->surface_dirty);
          cairo_region_destroy (cache->surface_dirty);
          cache->surface_dirty = NULL;
        }
Alexander Larsson's avatar
Alexander Larsson committed
305 306

      cairo_region_translate (copy_region,
307 308
                              cache->surface_x - new_surf_x,
                              cache->surface_y - new_surf_y);
Alexander Larsson's avatar
Alexander Larsson committed
309 310 311 312 313 314 315 316
      cairo_region_intersect_rectangle (copy_region, &r);

      backing_cr = cairo_create (cache->surface);
      gdk_cairo_region (backing_cr, copy_region);
      cairo_set_operator (backing_cr, CAIRO_OPERATOR_SOURCE);
      cairo_clip (backing_cr);
      cairo_push_group (backing_cr);
      cairo_set_source_surface (backing_cr, cache->surface,
317 318
                                cache->surface_x - new_surf_x,
                                cache->surface_y - new_surf_y);
Alexander Larsson's avatar
Alexander Larsson committed
319 320 321 322 323 324 325 326 327 328 329 330 331
      cairo_paint (backing_cr);
      cairo_pop_group_to_source (backing_cr);
      cairo_paint (backing_cr);
      cairo_destroy (backing_cr);

      cache->surface_x = new_surf_x;
      cache->surface_y = new_surf_y;

      cairo_region_xor_rectangle (copy_region, &r);
      cache->surface_dirty = copy_region;
    }
}

332 333 334 335 336 337
static void
_gtk_pixel_cache_repaint (GtkPixelCache         *cache,
                          GtkPixelCacheDrawFunc  draw,
                          cairo_rectangle_int_t *view_rect,
                          cairo_rectangle_int_t *canvas_rect,
                          gpointer               user_data)
Alexander Larsson's avatar
Alexander Larsson committed
338 339
{
  cairo_t *backing_cr;
340 341
  cairo_region_t *region_dirty = cache->surface_dirty;
  cache->surface_dirty = NULL;
Alexander Larsson's avatar
Alexander Larsson committed
342 343

  if (cache->surface &&
344 345
      region_dirty &&
      !cairo_region_is_empty (region_dirty))
Alexander Larsson's avatar
Alexander Larsson committed
346 347
    {
      backing_cr = cairo_create (cache->surface);
348
      gdk_cairo_region (backing_cr, region_dirty);
Alexander Larsson's avatar
Alexander Larsson committed
349 350
      cairo_clip (backing_cr);
      cairo_translate (backing_cr,
351 352
                       -cache->surface_x - canvas_rect->x - view_rect->x,
                       -cache->surface_y - canvas_rect->y - view_rect->y);
353 354

      cairo_save (backing_cr);
Alexander Larsson's avatar
Alexander Larsson committed
355
      cairo_set_source_rgba (backing_cr,
356
                             0.0, 0, 0, 0.0);
Alexander Larsson's avatar
Alexander Larsson committed
357 358
      cairo_set_operator (backing_cr, CAIRO_OPERATOR_SOURCE);
      cairo_paint (backing_cr);
359
      cairo_restore (backing_cr);
Alexander Larsson's avatar
Alexander Larsson committed
360

361
      cairo_save (backing_cr);
Alexander Larsson's avatar
Alexander Larsson committed
362
      draw (backing_cr, user_data);
363 364 365
      cairo_restore (backing_cr);

#ifdef G_ENABLE_DEBUG
366
      if (GTK_DEBUG_CHECK (PIXEL_CACHE))
367 368 369 370 371 372 373 374 375 376 377 378 379 380
        {
          GdkRGBA colors[] = {
            { 1, 0, 0, 0.08},
            { 0, 1, 0, 0.08},
            { 0, 0, 1, 0.08},
            { 1, 0, 1, 0.08},
            { 1, 1, 0, 0.08},
            { 0, 1, 1, 0.08},
          };
          static int current_color = 0;

          gdk_cairo_set_source_rgba (backing_cr, &colors[(current_color++) % G_N_ELEMENTS (colors)]);
          cairo_paint (backing_cr);
        }
381
#endif
Alexander Larsson's avatar
Alexander Larsson committed
382 383 384 385

      cairo_destroy (backing_cr);
    }

386 387
  if (region_dirty)
    cairo_region_destroy (region_dirty);
Alexander Larsson's avatar
Alexander Larsson committed
388 389
}

390 391
static void
gtk_pixel_cache_blow_cache (GtkPixelCache *cache)
392
{
393 394 395 396 397
  if (cache->timeout_tag)
    {
      g_source_remove (cache->timeout_tag);
      cache->timeout_tag = 0;
    }
398 399 400 401 402 403

  if (cache->surface)
    {
      cairo_surface_destroy (cache->surface);
      cache->surface = NULL;
      if (cache->surface_dirty)
404
        cairo_region_destroy (cache->surface_dirty);
405 406
      cache->surface_dirty = NULL;
    }
407 408 409 410 411 412 413 414 415 416
}

static gboolean
blow_cache_cb  (gpointer user_data)
{
  GtkPixelCache *cache = user_data;

  cache->timeout_tag = 0;

  gtk_pixel_cache_blow_cache (cache);
417 418 419 420

  return G_SOURCE_REMOVE;
}

421 422 423 424 425 426 427 428 429 430 431 432 433
static gboolean
context_is_unscaled (cairo_t *cr)
{
  cairo_matrix_t matrix;
  gdouble x, y;

  x = y = 1;
  cairo_get_matrix (cr, &matrix);
  cairo_matrix_transform_distance (&matrix, &x, &y);

  return x == 1 && y == 1;
}

434

Alexander Larsson's avatar
Alexander Larsson committed
435
void
436 437 438 439 440 441 442
_gtk_pixel_cache_draw (GtkPixelCache         *cache,
                       cairo_t               *cr,
                       GdkWindow             *window,
                       cairo_rectangle_int_t *view_rect,   /* View position in widget coords */
                       cairo_rectangle_int_t *canvas_rect, /* Size and position of canvas in view coords */
                       GtkPixelCacheDrawFunc  draw,
                       gpointer               user_data)
Alexander Larsson's avatar
Alexander Larsson committed
443
{
444 445 446 447
  if (cache->timeout_tag)
    g_source_remove (cache->timeout_tag);

  cache->timeout_tag = g_timeout_add_seconds (BLOW_CACHE_TIMEOUT_SEC,
448
                                              blow_cache_cb, cache);
449
  g_source_set_name_by_id (cache->timeout_tag, "[gtk+] blow_cache_cb");
450

Alexander Larsson's avatar
Alexander Larsson committed
451
  _gtk_pixel_cache_create_surface_if_needed (cache, window,
452
                                             view_rect, canvas_rect);
Alexander Larsson's avatar
Alexander Larsson committed
453 454 455
  _gtk_pixel_cache_set_position (cache, view_rect, canvas_rect);
  _gtk_pixel_cache_repaint (cache, draw, view_rect, canvas_rect, user_data);

456
  if (cache->surface && context_is_unscaled (cr) &&
Alexander Larsson's avatar
Alexander Larsson committed
457 458 459 460 461
      /* Don't use backing surface if rendering elsewhere */
      cairo_surface_get_type (cache->surface) == cairo_surface_get_type (cairo_get_target (cr)))
    {
      cairo_save (cr);
      cairo_set_source_surface (cr, cache->surface,
462 463
                                cache->surface_x + view_rect->x + canvas_rect->x,
                                cache->surface_y + view_rect->y + canvas_rect->y);
Alexander Larsson's avatar
Alexander Larsson committed
464
      cairo_rectangle (cr, view_rect->x, view_rect->y,
465
                       view_rect->width, view_rect->height);
Alexander Larsson's avatar
Alexander Larsson committed
466 467 468 469 470 471
      cairo_fill (cr);
      cairo_restore (cr);
    }
  else
    {
      cairo_rectangle (cr,
472 473
                       view_rect->x, view_rect->y,
                       view_rect->width, view_rect->height);
Alexander Larsson's avatar
Alexander Larsson committed
474 475 476 477
      cairo_clip (cr);
      draw (cr, user_data);
    }
}
478 479 480 481 482 483 484 485 486 487 488 489

void
_gtk_pixel_cache_map (GtkPixelCache *cache)
{
  _gtk_pixel_cache_invalidate (cache, NULL);
}

void
_gtk_pixel_cache_unmap (GtkPixelCache *cache)
{
  gtk_pixel_cache_blow_cache (cache);
}
490 491 492 493 494 495 496 497 498 499 500 501 502

gboolean
_gtk_pixel_cache_get_always_cache (GtkPixelCache *cache)
{
  return cache->always_cache;
}

void
_gtk_pixel_cache_set_always_cache (GtkPixelCache *cache,
                                   gboolean       always_cache)
{
  cache->always_cache = !!always_cache;
}