pixman/pixman.h

   1 /***********************************************************
   2
   3 Copyright 1987, 1998  The Open Group
   4
   5 Permission to use, copy, modify, distribute, and sell this software and its
   6 documentation for any purpose is hereby granted without fee, provided that
   7 the above copyright notice appear in all copies and that both that
   8 copyright notice and this permission notice appear in supporting
   9 documentation.
  10
  11 The above copyright notice and this permission notice shall be included in
  12 all copies or substantial portions of the Software.
  13
  14 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
  17 OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
  18 AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  19 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  20
  21 Except as contained in this notice, the name of The Open Group shall not be
  22 used in advertising or otherwise to promote the sale, use or other dealings
  23 in this Software without prior written authorization from The Open Group.
  24
  25 Copyright 1987 by Digital Equipment Corporation, Maynard, Massachusetts.
  26
  27                         All Rights Reserved
  28
  29 Permission to use, copy, modify, and distribute this software and its
  30 documentation for any purpose and without fee is hereby granted,
  31 provided that the above copyright notice appear in all copies and that
  32 both that copyright notice and this permission notice appear in
  33 supporting documentation, and that the name of Digital not be
  34 used in advertising or publicity pertaining to distribution of the
  35 software without specific, written prior permission.
  36
  37 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
  38 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
  39 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
  40 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
  41 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
  42 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
  43 SOFTWARE.
  44
  45 ******************************************************************/
  46 /*
  47  * Copyright © 1998, 2004 Keith Packard
  48  * Copyright   2007 Red Hat, Inc.
  49  *
  50  * Permission to use, copy, modify, distribute, and sell this software and its
  51  * documentation for any purpose is hereby granted without fee, provided that
  52  * the above copyright notice appear in all copies and that both that
  53  * copyright notice and this permission notice appear in supporting
  54  * documentation, and that the name of Keith Packard not be used in
  55  * advertising or publicity pertaining to distribution of the software without
  56  * specific, written prior permission.  Keith Packard makes no
  57  * representations about the suitability of this software for any purpose.  It
  58  * is provided "as is" without express or implied warranty.
  59  *
  60  * KEITH PACKARD DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
  61  * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
  62  * EVENT SHALL KEITH PACKARD BE LIABLE FOR ANY SPECIAL, INDIRECT OR
  63  * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
  64  * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  65  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  66  * PERFORMANCE OF THIS SOFTWARE.
  67  */
  68
  69 #ifndef PIXMAN_H__
  70 #define PIXMAN_H__
  71
  72 #include <pixman-version.h>
  73
  74 /*
  75  * Standard integers
  76  */
  77 #if defined (_SVR4) || defined (SVR4) || defined (__OpenBSD__) || defined (_sgi) || defined (__sun) || defined (sun) || defined (__digital__)
  78 #  include <inttypes.h>
  79 #elif defined (_MSC_VER)
  80 typedef __int8 int8_t;
  81 typedef unsigned __int8 uint8_t;
  82 typedef __int16 int16_t;
  83 typedef unsigned __int16 uint16_t;
  84 typedef __int32 int32_t;
  85 typedef unsigned __int32 uint32_t;
  86 typedef __int64 int64_t;
  87 typedef unsigned __int64 uint64_t;
  88 #elif defined (_AIX)
  89 #  include <sys/inttypes.h>
  90 #else
  91 #  include <stdint.h>
  92 #endif
  93
  94 /*
  95  * Boolean
  96  */
  97 typedef int pixman_bool_t;
  98
  99 /*
 100  * Fixpoint numbers
 101  */
 102 typedef int64_t                 pixman_fixed_32_32_t;
 103 typedef pixman_fixed_32_32_t    pixman_fixed_48_16_t;
 104 typedef uint32_t                pixman_fixed_1_31_t;
 105 typedef uint32_t                pixman_fixed_1_16_t;
 106 typedef int32_t                 pixman_fixed_16_16_t;
 107 typedef pixman_fixed_16_16_t    pixman_fixed_t;
 108
 109 #define pixman_fixed_e                  ((pixman_fixed_t) 1)
 110 #define pixman_fixed_1                  (pixman_int_to_fixed(1))
 111 #define pixman_fixed_1_minus_e          (pixman_fixed_1 - pixman_fixed_e)
 112 #define pixman_fixed_to_int(f)          ((int) ((f) >> 16))
 113 #define pixman_int_to_fixed(i)          ((pixman_fixed_t) ((i) << 16))
 114 #define pixman_fixed_to_double(f)       (double) ((f) / (double) pixman_fixed_1)
 115 #define pixman_double_to_fixed(d)       ((pixman_fixed_t) ((d) * 65536.0))
 116 #define pixman_fixed_frac(f)            ((f) & pixman_fixed_1_minus_e)
 117 #define pixman_fixed_floor(f)           ((f) & ~pixman_fixed_1_minus_e)
 118 #define pixman_fixed_ceil(f)            pixman_fixed_floor ((f) + pixman_fixed_1_minus_e)
 119 #define pixman_fixed_fraction(f)        ((f) & pixman_fixed_1_minus_e)
 120 #define pixman_fixed_mod_2(f)           ((f) & (pixman_fixed1 | pixman_fixed_1_minus_e))
 121 #define pixman_max_fixed_48_16          ((pixman_fixed_48_16_t) 0x7fffffff)
 122 #define pixman_min_fixed_48_16          (-((pixman_fixed_48_16_t) 1 << 31))
 123
 124 /*
 125  * Misc structs
 126  */
 127 typedef struct pixman_color pixman_color_t;
 128 typedef struct pixman_point_fixed pixman_point_fixed_t;
 129 typedef struct pixman_line_fixed pixman_line_fixed_t;
 130 typedef struct pixman_vector pixman_vector_t;
 131 typedef struct pixman_transform pixman_transform_t;
 132
 133 struct pixman_color
 134 {
 135     uint16_t    red;
 136     uint16_t    green;
 137     uint16_t    blue;
 138     uint16_t    alpha;
 139 };
 140
 141 struct pixman_point_fixed
 142 {
 143     pixman_fixed_t      x;
 144     pixman_fixed_t      y;
 145 };
 146
 147 struct pixman_line_fixed
 148 {
 149     pixman_point_fixed_t        p1, p2;
 150 };
 151
 152 /*
 153  * Fixed point matrices
 154  */
 155
 156 struct pixman_vector
 157 {
 158     pixman_fixed_t      vector[3];
 159 };
 160
 161 struct pixman_transform
 162 {
 163     pixman_fixed_t      matrix[3][3];
 164 };
 165
 166 /* forward declaration (sorry) */
 167 struct pixman_box16;
 168
 169 void          pixman_transform_init_identity    (struct pixman_transform       *matrix);
 170 pixman_bool_t pixman_transform_point_3d         (const struct pixman_transform *transform,
 171                                                  struct pixman_vector          *vector);
 172 pixman_bool_t pixman_transform_point            (const struct pixman_transform *transform,
 173                                                  struct pixman_vector          *vector);
 174 pixman_bool_t pixman_transform_multiply         (struct pixman_transform       *dst,
 175                                                  const struct pixman_transform *l,
 176                                                  const struct pixman_transform *r);
 177 void          pixman_transform_init_scale       (struct pixman_transform       *t,
 178                                                  pixman_fixed_t                 sx,
 179                                                  pixman_fixed_t                 sy);
 180 pixman_bool_t pixman_transform_scale            (struct pixman_transform       *forward,
 181                                                  struct pixman_transform       *reverse,
 182                                                  pixman_fixed_t                 sx,
 183                                                  pixman_fixed_t                 sy);
 184 void          pixman_transform_init_rotate      (struct pixman_transform       *t,
 185                                                  pixman_fixed_t                 cos,
 186                                                  pixman_fixed_t                 sin);
 187 pixman_bool_t pixman_transform_rotate           (struct pixman_transform       *forward,
 188                                                  struct pixman_transform       *reverse,
 189                                                  pixman_fixed_t                 c,
 190                                                  pixman_fixed_t                 s);
 191 void          pixman_transform_init_translate   (struct pixman_transform       *t,
 192                                                  pixman_fixed_t                 tx,
 193                                                  pixman_fixed_t                 ty);
 194 pixman_bool_t pixman_transform_translate        (struct pixman_transform       *forward,
 195                                                  struct pixman_transform       *reverse,
 196                                                  pixman_fixed_t                 tx,
 197                                                  pixman_fixed_t                 ty);
 198 pixman_bool_t pixman_transform_bounds           (const struct pixman_transform *matrix,
 199                                                  struct pixman_box16           *b);
 200 pixman_bool_t pixman_transform_invert           (struct pixman_transform       *dst,
 201                                                  const struct pixman_transform *src);
 202 pixman_bool_t pixman_transform_is_identity      (const struct pixman_transform *t);
 203 pixman_bool_t pixman_transform_is_scale         (const struct pixman_transform *t);
 204 pixman_bool_t pixman_transform_is_int_translate (const struct pixman_transform *t);
 205 pixman_bool_t pixman_transform_is_inverse       (const struct pixman_transform *a,
 206                                                  const struct pixman_transform *b);
 207
 208 /*
 209  * Floating point matrices
 210  */
 211 struct pixman_f_vector
 212 {
 213     double  v[3];
 214 };
 215
 216 struct pixman_f_transform
 217 {
 218     double  m[3][3];
 219 };
 220
 221 pixman_bool_t pixman_transform_from_pixman_f_transform (struct pixman_transform         *t,
 222                                                         const struct pixman_f_transform *ft);
 223 void          pixman_f_transform_from_pixman_transform (struct pixman_f_transform       *ft,
 224                                                         const struct pixman_transform   *t);
 225 pixman_bool_t pixman_transform_from_pixman_f_transform (struct pixman_transform         *t,
 226                                                         const struct pixman_f_transform *ft);
 227 pixman_bool_t pixman_f_transform_invert                (struct pixman_f_transform       *dst,
 228                                                         const struct pixman_f_transform *src);
 229 pixman_bool_t pixman_f_transform_point                 (const struct pixman_f_transform *t,
 230                                                         struct pixman_f_vector          *v);
 231 void          pixman_f_transform_point_3d              (const struct pixman_f_transform *t,
 232                                                         struct pixman_f_vector          *v);
 233 void          pixman_f_transform_multiply              (struct pixman_f_transform       *dst,
 234                                                         const struct pixman_f_transform *l,
 235                                                         const struct pixman_f_transform *r);
 236 void          pixman_f_transform_init_scale            (struct pixman_f_transform       *t,
 237                                                         double                           sx,
 238                                                         double                           sy);
 239 pixman_bool_t pixman_f_transform_scale                 (struct pixman_f_transform       *forward,
 240                                                         struct pixman_f_transform       *reverse,
 241                                                         double                           sx,
 242                                                         double                           sy);
 243 void          pixman_f_transform_init_rotate           (struct pixman_f_transform       *t,
 244                                                         double                           cos,
 245                                                         double                           sin);
 246 pixman_bool_t pixman_f_transform_rotate                (struct pixman_f_transform       *forward,
 247                                                         struct pixman_f_transform       *reverse,
 248                                                         double                           c,
 249                                                         double                           s);
 250 void          pixman_f_transform_init_translate        (struct pixman_f_transform       *t,
 251                                                         double                           tx,
 252                                                         double                           ty);
 253 pixman_bool_t pixman_f_transform_translate             (struct pixman_f_transform       *forward,
 254                                                         struct pixman_f_transform       *reverse,
 255                                                         double                           tx,
 256                                                         double                           ty);
 257 pixman_bool_t pixman_f_transform_bounds                (const struct pixman_f_transform *t,
 258                                                         struct pixman_box16             *b);
 259 void          pixman_f_transform_init_identity         (struct pixman_f_transform       *t);
 260
 261 typedef enum
 262 {
 263     PIXMAN_REPEAT_NONE,
 264     PIXMAN_REPEAT_NORMAL,
 265     PIXMAN_REPEAT_PAD,
 266     PIXMAN_REPEAT_REFLECT
 267 } pixman_repeat_t;
 268
 269 typedef enum
 270 {
 271     PIXMAN_FILTER_FAST,
 272     PIXMAN_FILTER_GOOD,
 273     PIXMAN_FILTER_BEST,
 274     PIXMAN_FILTER_NEAREST,
 275     PIXMAN_FILTER_BILINEAR,
 276     PIXMAN_FILTER_CONVOLUTION
 277 } pixman_filter_t;
 278
 279 typedef enum
 280 {
 281     PIXMAN_OP_CLEAR                     = 0x00,
 282     PIXMAN_OP_SRC                       = 0x01,
 283     PIXMAN_OP_DST                       = 0x02,
 284     PIXMAN_OP_OVER                      = 0x03,
 285     PIXMAN_OP_OVER_REVERSE              = 0x04,
 286     PIXMAN_OP_IN                        = 0x05,
 287     PIXMAN_OP_IN_REVERSE                = 0x06,
 288     PIXMAN_OP_OUT                       = 0x07,
 289     PIXMAN_OP_OUT_REVERSE               = 0x08,
 290     PIXMAN_OP_ATOP                      = 0x09,
 291     PIXMAN_OP_ATOP_REVERSE              = 0x0a,
 292     PIXMAN_OP_XOR                       = 0x0b,
 293     PIXMAN_OP_ADD                       = 0x0c,
 294     PIXMAN_OP_SATURATE                  = 0x0d,
 295
 296     PIXMAN_OP_DISJOINT_CLEAR            = 0x10,
 297     PIXMAN_OP_DISJOINT_SRC              = 0x11,
 298     PIXMAN_OP_DISJOINT_DST              = 0x12,
 299     PIXMAN_OP_DISJOINT_OVER             = 0x13,
 300     PIXMAN_OP_DISJOINT_OVER_REVERSE     = 0x14,
 301     PIXMAN_OP_DISJOINT_IN               = 0x15,
 302     PIXMAN_OP_DISJOINT_IN_REVERSE       = 0x16,
 303     PIXMAN_OP_DISJOINT_OUT              = 0x17,
 304     PIXMAN_OP_DISJOINT_OUT_REVERSE      = 0x18,
 305     PIXMAN_OP_DISJOINT_ATOP             = 0x19,
 306     PIXMAN_OP_DISJOINT_ATOP_REVERSE     = 0x1a,
 307     PIXMAN_OP_DISJOINT_XOR              = 0x1b,
 308
 309     PIXMAN_OP_CONJOINT_CLEAR            = 0x20,
 310     PIXMAN_OP_CONJOINT_SRC              = 0x21,
 311     PIXMAN_OP_CONJOINT_DST              = 0x22,
 312     PIXMAN_OP_CONJOINT_OVER             = 0x23,
 313     PIXMAN_OP_CONJOINT_OVER_REVERSE     = 0x24,
 314     PIXMAN_OP_CONJOINT_IN               = 0x25,
 315     PIXMAN_OP_CONJOINT_IN_REVERSE       = 0x26,
 316     PIXMAN_OP_CONJOINT_OUT              = 0x27,
 317     PIXMAN_OP_CONJOINT_OUT_REVERSE      = 0x28,
 318     PIXMAN_OP_CONJOINT_ATOP             = 0x29,
 319     PIXMAN_OP_CONJOINT_ATOP_REVERSE     = 0x2a,
 320     PIXMAN_OP_CONJOINT_XOR              = 0x2b,
 321
 322     PIXMAN_OP_MULTIPLY                  = 0x30,
 323     PIXMAN_OP_SCREEN                    = 0x31,
 324     PIXMAN_OP_OVERLAY                   = 0x32,
 325     PIXMAN_OP_DARKEN                    = 0x33,
 326     PIXMAN_OP_LIGHTEN                   = 0x34,
 327     PIXMAN_OP_COLOR_DODGE               = 0x35,
 328     PIXMAN_OP_COLOR_BURN                = 0x36,
 329     PIXMAN_OP_HARD_LIGHT                = 0x37,
 330     PIXMAN_OP_SOFT_LIGHT                = 0x38,
 331     PIXMAN_OP_DIFFERENCE                = 0x39,
 332     PIXMAN_OP_EXCLUSION                 = 0x3a,
 333     PIXMAN_OP_HSL_HUE                   = 0x3b,
 334     PIXMAN_OP_HSL_SATURATION            = 0x3c,
 335     PIXMAN_OP_HSL_COLOR                 = 0x3d,
 336     PIXMAN_OP_HSL_LUMINOSITY            = 0x3e,
 337
 338     PIXMAN_OP_NONE,
 339     PIXMAN_OP_LAST = PIXMAN_OP_NONE
 340 } pixman_op_t;
 341
 342 /*
 343  * Regions
 344  */
 345 typedef struct pixman_region16_data     pixman_region16_data_t;
 346 typedef struct pixman_box16             pixman_box16_t;
 347 typedef struct pixman_rectangle16       pixman_rectangle16_t;
 348 typedef struct pixman_region16          pixman_region16_t;
 349
 350 struct pixman_region16_data {
 351     long                size;
 352     long                numRects;
 353 /*  pixman_box16_t      rects[size];   in memory but not explicitly declared */
 354 };
 355
 356 struct pixman_rectangle16
 357 {
 358     int16_t     x, y;
 359     uint16_t    width, height;
 360 };
 361
 362 struct pixman_box16
 363 {
 364     int16_t x1, y1, x2, y2;
 365 };
 366
 367 struct pixman_region16
 368 {
 369     pixman_box16_t          extents;
 370     pixman_region16_data_t *data;
 371 };
 372
 373 typedef enum
 374 {
 375     PIXMAN_REGION_OUT,
 376     PIXMAN_REGION_IN,
 377     PIXMAN_REGION_PART
 378 } pixman_region_overlap_t;
 379
 380 /* This function exists only to make it possible to preserve
 381  * the X ABI - it should go away at first opportunity.
 382  */
 383 void pixman_region_set_static_pointers (pixman_box16_t         *empty_box,
 384                                         pixman_region16_data_t *empty_data,
 385                                         pixman_region16_data_t *broken_data);
 386
 387 /* creation/destruction */
 388 void                    pixman_region_init               (pixman_region16_t *region);
 389 void                    pixman_region_init_rect          (pixman_region16_t *region,
 390                                                           int                x,
 391                                                           int                y,
 392                                                           unsigned int       width,
 393                                                           unsigned int       height);
 394 pixman_bool_t           pixman_region_init_rects         (pixman_region16_t *region,
 395                                                           pixman_box16_t    *boxes,
 396                                                           int                count);
 397 void                    pixman_region_init_with_extents  (pixman_region16_t *region,
 398                                                           pixman_box16_t    *extents);
 399 void                    pixman_region_fini               (pixman_region16_t *region);
 400
 401
 402
 403 /* manipulation */
 404 void                    pixman_region_translate          (pixman_region16_t *region,
 405                                                           int                x,
 406                                                           int                y);
 407 pixman_bool_t           pixman_region_copy               (pixman_region16_t *dest,
 408                                                           pixman_region16_t *source);
 409 pixman_bool_t           pixman_region_intersect          (pixman_region16_t *new_reg,
 410                                                           pixman_region16_t *reg1,
 411                                                           pixman_region16_t *reg2);
 412 pixman_bool_t           pixman_region_union              (pixman_region16_t *new_reg,
 413                                                           pixman_region16_t *reg1,
 414                                                           pixman_region16_t *reg2);
 415 pixman_bool_t           pixman_region_union_rect         (pixman_region16_t *dest,
 416                                                           pixman_region16_t *source,
 417                                                           int                x,
 418                                                           int                y,
 419                                                           unsigned int       width,
 420                                                           unsigned int       height);
 421 pixman_bool_t           pixman_region_subtract           (pixman_region16_t *reg_d,
 422                                                           pixman_region16_t *reg_m,
 423                                                           pixman_region16_t *reg_s);
 424 pixman_bool_t           pixman_region_inverse            (pixman_region16_t *new_reg,
 425                                                           pixman_region16_t *reg1,
 426                                                           pixman_box16_t    *inv_rect);
 427 pixman_bool_t           pixman_region_contains_point     (pixman_region16_t *region,
 428                                                           int                x,
 429                                                           int                y,
 430                                                           pixman_box16_t    *box);
 431 pixman_region_overlap_t pixman_region_contains_rectangle (pixman_region16_t *pixman_region16_t,
 432                                                           pixman_box16_t    *prect);
 433 pixman_bool_t           pixman_region_not_empty          (pixman_region16_t *region);
 434 pixman_box16_t *        pixman_region_extents            (pixman_region16_t *region);
 435 int                     pixman_region_n_rects            (pixman_region16_t *region);
 436 pixman_box16_t *        pixman_region_rectangles         (pixman_region16_t *region,
 437                                                           int               *n_rects);
 438 pixman_bool_t           pixman_region_equal              (pixman_region16_t *region1,
 439                                                           pixman_region16_t *region2);
 440 pixman_bool_t           pixman_region_selfcheck          (pixman_region16_t *region);
 441 void                    pixman_region_reset              (pixman_region16_t *region,
 442                                                           pixman_box16_t    *box);
 443 /*
 444  * 32 bit regions
 445  */
 446 typedef struct pixman_region32_data     pixman_region32_data_t;
 447 typedef struct pixman_box32             pixman_box32_t;
 448 typedef struct pixman_rectangle32       pixman_rectangle32_t;
 449 typedef struct pixman_region32          pixman_region32_t;
 450
 451 struct pixman_region32_data {
 452     long                size;
 453     long                numRects;
 454 /*  pixman_box32_t      rects[size];   in memory but not explicitly declared */
 455 };
 456
 457 struct pixman_rectangle32
 458 {
 459     int32_t x, y;
 460     uint32_t width, height;
 461 };
 462
 463 struct pixman_box32
 464 {
 465     int32_t x1, y1, x2, y2;
 466 };
 467
 468 struct pixman_region32
 469 {
 470     pixman_box32_t          extents;
 471     pixman_region32_data_t  *data;
 472 };
 473
 474 /* creation/destruction */
 475 void                    pixman_region32_init               (pixman_region32_t *region);
 476 void                    pixman_region32_init_rect          (pixman_region32_t *region,
 477                                                             int                x,
 478                                                             int                y,
 479                                                             unsigned int       width,
 480                                                             unsigned int       height);
 481 pixman_bool_t           pixman_region32_init_rects         (pixman_region32_t *region,
 482                                                             pixman_box32_t    *boxes,
 483                                                             int                count);
 484 void                    pixman_region32_init_with_extents  (pixman_region32_t *region,
 485                                                             pixman_box32_t    *extents);
 486 void                    pixman_region32_fini               (pixman_region32_t *region);
 487
 488
 489 /* manipulation */
 490 void                    pixman_region32_translate          (pixman_region32_t *region,
 491                                                             int                x,
 492                                                             int                y);
 493 pixman_bool_t           pixman_region32_copy               (pixman_region32_t *dest,
 494                                                             pixman_region32_t *source);
 495 pixman_bool_t           pixman_region32_intersect          (pixman_region32_t *new_reg,
 496                                                             pixman_region32_t *reg1,
 497                                                             pixman_region32_t *reg2);
 498 pixman_bool_t           pixman_region32_union              (pixman_region32_t *new_reg,
 499                                                             pixman_region32_t *reg1,
 500                                                             pixman_region32_t *reg2);
 501 pixman_bool_t           pixman_region32_union_rect         (pixman_region32_t *dest,
 502                                                             pixman_region32_t *source,
 503                                                             int                x,
 504                                                             int                y,
 505                                                             unsigned int       width,
 506                                                             unsigned int       height);
 507 pixman_bool_t           pixman_region32_subtract           (pixman_region32_t *reg_d,
 508                                                             pixman_region32_t *reg_m,
 509                                                             pixman_region32_t *reg_s);
 510 pixman_bool_t           pixman_region32_inverse            (pixman_region32_t *new_reg,
 511                                                             pixman_region32_t *reg1,
 512                                                             pixman_box32_t    *inv_rect);
 513 pixman_bool_t           pixman_region32_contains_point     (pixman_region32_t *region,
 514                                                             int                x,
 515                                                             int                y,
 516                                                             pixman_box32_t    *box);
 517 pixman_region_overlap_t pixman_region32_contains_rectangle (pixman_region32_t *region,
 518                                                             pixman_box32_t    *prect);
 519 pixman_bool_t           pixman_region32_not_empty          (pixman_region32_t *region);
 520 pixman_box32_t *        pixman_region32_extents            (pixman_region32_t *region);
 521 int                     pixman_region32_n_rects            (pixman_region32_t *region);
 522 pixman_box32_t *        pixman_region32_rectangles         (pixman_region32_t *region,
 523                                                             int               *n_rects);
 524 pixman_bool_t           pixman_region32_equal              (pixman_region32_t *region1,
 525                                                             pixman_region32_t *region2);
 526 pixman_bool_t           pixman_region32_selfcheck          (pixman_region32_t *region);
 527 void                    pixman_region32_reset              (pixman_region32_t *region,
 528                                                             pixman_box32_t    *box);
 529
 530
 531 /* Copy / Fill / Misc */
 532 pixman_bool_t pixman_blt                (uint32_t           *src_bits,
 533                                          uint32_t           *dst_bits,
 534                                          int                 src_stride,
 535                                          int                 dst_stride,
 536                                          int                 src_bpp,
 537                                          int                 dst_bpp,
 538                                          int                 src_x,
 539                                          int                 src_y,
 540                                          int                 dst_x,
 541                                          int                 dst_y,
 542                                          int                 width,
 543                                          int                 height);
 544 pixman_bool_t pixman_fill               (uint32_t           *bits,
 545                                          int                 stride,
 546                                          int                 bpp,
 547                                          int                 x,
 548                                          int                 y,
 549                                          int                 width,
 550                                          int                 height,
 551                                          uint32_t            _xor);
 552
 553 int           pixman_version            (void);
 554 const char*   pixman_version_string     (void);
 555
 556 /*
 557  * Images
 558  */
 559 typedef  union pixman_image             pixman_image_t;
 560 typedef struct pixman_indexed           pixman_indexed_t;
 561 typedef struct pixman_gradient_stop     pixman_gradient_stop_t;
 562
 563 typedef uint32_t (* pixman_read_memory_func_t) (const void *src, int size);
 564 typedef void     (* pixman_write_memory_func_t) (void *dst, uint32_t value, int size);
 565
 566 typedef void     (* pixman_image_destroy_func_t) (pixman_image_t *image, void *data);
 567
 568 struct pixman_gradient_stop {
 569     pixman_fixed_t x;
 570     pixman_color_t color;
 571 };
 572
 573 #define PIXMAN_MAX_INDEXED  256 /* XXX depth must be <= 8 */
 574
 575 #if PIXMAN_MAX_INDEXED <= 256
 576 typedef uint8_t pixman_index_type;
 577 #endif
 578
 579 struct pixman_indexed
 580 {
 581     pixman_bool_t       color;
 582     uint32_t            rgba[PIXMAN_MAX_INDEXED];
 583     pixman_index_type   ent[32768];
 584 };
 585
 586 /*
 587  * While the protocol is generous in format support, the
 588  * sample implementation allows only packed RGB and GBR
 589  * representations for data to simplify software rendering,
 590  */
 591 #define PIXMAN_FORMAT(bpp,type,a,r,g,b) (((bpp) << 24) |  \
 592                                          ((type) << 16) | \
 593                                          ((a) << 12) |    \
 594                                          ((r) << 8) |     \
 595                                          ((g) << 4) |     \
 596                                          ((b)))
 597
 598 #define PIXMAN_FORMAT_BPP(f)    (((f) >> 24)       )
 599 #define PIXMAN_FORMAT_TYPE(f)   (((f) >> 16) & 0xff)
 600 #define PIXMAN_FORMAT_A(f)      (((f) >> 12) & 0x0f)
 601 #define PIXMAN_FORMAT_R(f)      (((f) >>  8) & 0x0f)
 602 #define PIXMAN_FORMAT_G(f)      (((f) >>  4) & 0x0f)
 603 #define PIXMAN_FORMAT_B(f)      (((f)      ) & 0x0f)
 604 #define PIXMAN_FORMAT_RGB(f)    (((f)      ) & 0xfff)
 605 #define PIXMAN_FORMAT_VIS(f)    (((f)      ) & 0xffff)
 606 #define PIXMAN_FORMAT_DEPTH(f)  (PIXMAN_FORMAT_A(f) +   \
 607                                  PIXMAN_FORMAT_R(f) +   \
 608                                  PIXMAN_FORMAT_G(f) +   \
 609                                  PIXMAN_FORMAT_B(f))
 610
 611 #define PIXMAN_TYPE_OTHER       0
 612 #define PIXMAN_TYPE_A           1
 613 #define PIXMAN_TYPE_ARGB        2
 614 #define PIXMAN_TYPE_ABGR        3
 615 #define PIXMAN_TYPE_COLOR       4
 616 #define PIXMAN_TYPE_GRAY        5
 617 #define PIXMAN_TYPE_YUY2        6
 618 #define PIXMAN_TYPE_YV12        7
 619 #define PIXMAN_TYPE_BGRA        8
 620
 621 #define PIXMAN_FORMAT_COLOR(f)                          \
 622         (PIXMAN_FORMAT_TYPE(f) == PIXMAN_TYPE_ARGB ||   \
 623          PIXMAN_FORMAT_TYPE(f) == PIXMAN_TYPE_ABGR ||   \
 624          PIXMAN_FORMAT_TYPE(f) == PIXMAN_TYPE_BGRA)
 625
 626 /* 32bpp formats */
 627 typedef enum {
 628     PIXMAN_a8r8g8b8 =    PIXMAN_FORMAT(32,PIXMAN_TYPE_ARGB,8,8,8,8),
 629     PIXMAN_x8r8g8b8 =    PIXMAN_FORMAT(32,PIXMAN_TYPE_ARGB,0,8,8,8),
 630     PIXMAN_a8b8g8r8 =    PIXMAN_FORMAT(32,PIXMAN_TYPE_ABGR,8,8,8,8),
 631     PIXMAN_x8b8g8r8 =    PIXMAN_FORMAT(32,PIXMAN_TYPE_ABGR,0,8,8,8),
 632     PIXMAN_b8g8r8a8 =    PIXMAN_FORMAT(32,PIXMAN_TYPE_BGRA,8,8,8,8),
 633     PIXMAN_b8g8r8x8 =    PIXMAN_FORMAT(32,PIXMAN_TYPE_BGRA,0,8,8,8),
 634     PIXMAN_x2r10g10b10 = PIXMAN_FORMAT(32,PIXMAN_TYPE_ARGB,0,10,10,10),
 635     PIXMAN_a2r10g10b10 = PIXMAN_FORMAT(32,PIXMAN_TYPE_ARGB,2,10,10,10),
 636     PIXMAN_x2b10g10r10 = PIXMAN_FORMAT(32,PIXMAN_TYPE_ABGR,0,10,10,10),
 637     PIXMAN_a2b10g10r10 = PIXMAN_FORMAT(32,PIXMAN_TYPE_ABGR,2,10,10,10),
 638
 639 /* 24bpp formats */
 640     PIXMAN_r8g8b8 =      PIXMAN_FORMAT(24,PIXMAN_TYPE_ARGB,0,8,8,8),
 641     PIXMAN_b8g8r8 =      PIXMAN_FORMAT(24,PIXMAN_TYPE_ABGR,0,8,8,8),
 642
 643 /* 16bpp formats */
 644     PIXMAN_r5g6b5 =      PIXMAN_FORMAT(16,PIXMAN_TYPE_ARGB,0,5,6,5),
 645     PIXMAN_b5g6r5 =      PIXMAN_FORMAT(16,PIXMAN_TYPE_ABGR,0,5,6,5),
 646
 647     PIXMAN_a1r5g5b5 =    PIXMAN_FORMAT(16,PIXMAN_TYPE_ARGB,1,5,5,5),
 648     PIXMAN_x1r5g5b5 =    PIXMAN_FORMAT(16,PIXMAN_TYPE_ARGB,0,5,5,5),
 649     PIXMAN_a1b5g5r5 =    PIXMAN_FORMAT(16,PIXMAN_TYPE_ABGR,1,5,5,5),
 650     PIXMAN_x1b5g5r5 =    PIXMAN_FORMAT(16,PIXMAN_TYPE_ABGR,0,5,5,5),
 651     PIXMAN_a4r4g4b4 =    PIXMAN_FORMAT(16,PIXMAN_TYPE_ARGB,4,4,4,4),
 652     PIXMAN_x4r4g4b4 =    PIXMAN_FORMAT(16,PIXMAN_TYPE_ARGB,0,4,4,4),
 653     PIXMAN_a4b4g4r4 =    PIXMAN_FORMAT(16,PIXMAN_TYPE_ABGR,4,4,4,4),
 654     PIXMAN_x4b4g4r4 =    PIXMAN_FORMAT(16,PIXMAN_TYPE_ABGR,0,4,4,4),
 655
 656 /* 8bpp formats */
 657     PIXMAN_a8 =          PIXMAN_FORMAT(8,PIXMAN_TYPE_A,8,0,0,0),
 658     PIXMAN_r3g3b2 =      PIXMAN_FORMAT(8,PIXMAN_TYPE_ARGB,0,3,3,2),
 659     PIXMAN_b2g3r3 =      PIXMAN_FORMAT(8,PIXMAN_TYPE_ABGR,0,3,3,2),
 660     PIXMAN_a2r2g2b2 =    PIXMAN_FORMAT(8,PIXMAN_TYPE_ARGB,2,2,2,2),
 661     PIXMAN_a2b2g2r2 =    PIXMAN_FORMAT(8,PIXMAN_TYPE_ABGR,2,2,2,2),
 662
 663     PIXMAN_c8 =          PIXMAN_FORMAT(8,PIXMAN_TYPE_COLOR,0,0,0,0),
 664     PIXMAN_g8 =          PIXMAN_FORMAT(8,PIXMAN_TYPE_GRAY,0,0,0,0),
 665
 666     PIXMAN_x4a4 =        PIXMAN_FORMAT(8,PIXMAN_TYPE_A,4,0,0,0),
 667
 668     PIXMAN_x4c4 =        PIXMAN_FORMAT(8,PIXMAN_TYPE_COLOR,0,0,0,0),
 669     PIXMAN_x4g4 =        PIXMAN_FORMAT(8,PIXMAN_TYPE_GRAY,0,0,0,0),
 670
 671 /* 4bpp formats */
 672     PIXMAN_a4 =          PIXMAN_FORMAT(4,PIXMAN_TYPE_A,4,0,0,0),
 673     PIXMAN_r1g2b1 =      PIXMAN_FORMAT(4,PIXMAN_TYPE_ARGB,0,1,2,1),
 674     PIXMAN_b1g2r1 =      PIXMAN_FORMAT(4,PIXMAN_TYPE_ABGR,0,1,2,1),
 675     PIXMAN_a1r1g1b1 =    PIXMAN_FORMAT(4,PIXMAN_TYPE_ARGB,1,1,1,1),
 676     PIXMAN_a1b1g1r1 =    PIXMAN_FORMAT(4,PIXMAN_TYPE_ABGR,1,1,1,1),
 677
 678     PIXMAN_c4 =          PIXMAN_FORMAT(4,PIXMAN_TYPE_COLOR,0,0,0,0),
 679     PIXMAN_g4 =          PIXMAN_FORMAT(4,PIXMAN_TYPE_GRAY,0,0,0,0),
 680
 681 /* 1bpp formats */
 682     PIXMAN_a1 =          PIXMAN_FORMAT(1,PIXMAN_TYPE_A,1,0,0,0),
 683
 684     PIXMAN_g1 =          PIXMAN_FORMAT(1,PIXMAN_TYPE_GRAY,0,0,0,0),
 685
 686 /* YUV formats */
 687     PIXMAN_yuy2 =        PIXMAN_FORMAT(16,PIXMAN_TYPE_YUY2,0,0,0,0),
 688     PIXMAN_yv12 =        PIXMAN_FORMAT(12,PIXMAN_TYPE_YV12,0,0,0,0)
 689 } pixman_format_code_t;
 690
 691 /* Querying supported format values. */
 692 pixman_bool_t pixman_format_supported_destination (pixman_format_code_t format);
 693 pixman_bool_t pixman_format_supported_source      (pixman_format_code_t format);
 694
 695 /* Constructors */
 696 pixman_image_t *pixman_image_create_solid_fill       (pixman_color_t               *color);
 697 pixman_image_t *pixman_image_create_linear_gradient  (pixman_point_fixed_t         *p1,
 698                                                       pixman_point_fixed_t         *p2,
 699                                                       const pixman_gradient_stop_t *stops,
 700                                                       int                           n_stops);
 701 pixman_image_t *pixman_image_create_radial_gradient  (pixman_point_fixed_t         *inner,
 702                                                       pixman_point_fixed_t         *outer,
 703                                                       pixman_fixed_t                inner_radius,
 704                                                       pixman_fixed_t                outer_radius,
 705                                                       const pixman_gradient_stop_t *stops,
 706                                                       int                           n_stops);
 707 pixman_image_t *pixman_image_create_conical_gradient (pixman_point_fixed_t         *center,
 708                                                       pixman_fixed_t                angle,
 709                                                       const pixman_gradient_stop_t *stops,
 710                                                       int                           n_stops);
 711 pixman_image_t *pixman_image_create_bits             (pixman_format_code_t          format,
 712                                                       int                           width,
 713                                                       int                           height,
 714                                                       uint32_t                     *bits,
 715                                                       int                           rowstride_bytes);
 716
 717 /* Destructor */
 718 pixman_image_t *pixman_image_ref                     (pixman_image_t               *image);
 719 pixman_bool_t   pixman_image_unref                   (pixman_image_t               *image);
 720
 721 void            pixman_image_set_destroy_function    (pixman_image_t               *image,
 722                                                       pixman_image_destroy_func_t   function,
 723                                                       void                         *data);
 724
 725 /* Set properties */
 726 pixman_bool_t   pixman_image_set_clip_region         (pixman_image_t               *image,
 727                                                       pixman_region16_t            *region);
 728 pixman_bool_t   pixman_image_set_clip_region32       (pixman_image_t               *image,
 729                                                       pixman_region32_t            *region);
 730 void            pixman_image_set_has_client_clip     (pixman_image_t               *image,
 731                                                       pixman_bool_t                 clien_clip);
 732 pixman_bool_t   pixman_image_set_transform           (pixman_image_t               *image,
 733                                                       const pixman_transform_t     *transform);
 734 void            pixman_image_set_repeat              (pixman_image_t               *image,
 735                                                       pixman_repeat_t               repeat);
 736 pixman_bool_t   pixman_image_set_filter              (pixman_image_t               *image,
 737                                                       pixman_filter_t               filter,
 738                                                       const pixman_fixed_t         *filter_params,
 739                                                       int                           n_filter_params);
 740 void            pixman_image_set_source_clipping     (pixman_image_t               *image,
 741                                                       pixman_bool_t                 source_clipping);
 742 void            pixman_image_set_alpha_map           (pixman_image_t               *image,
 743                                                       pixman_image_t               *alpha_map,
 744                                                       int16_t                       x,
 745                                                       int16_t                       y);
 746 void            pixman_image_set_component_alpha     (pixman_image_t               *image,
 747                                                       pixman_bool_t                 component_alpha);
 748 void            pixman_image_set_accessors           (pixman_image_t               *image,
 749                                                       pixman_read_memory_func_t     read_func,
 750                                                       pixman_write_memory_func_t    write_func);
 751 void            pixman_image_set_indexed             (pixman_image_t               *image,
 752                                                       const pixman_indexed_t       *indexed);
 753 uint32_t       *pixman_image_get_data                (pixman_image_t               *image);
 754 int             pixman_image_get_width               (pixman_image_t               *image);
 755 int             pixman_image_get_height              (pixman_image_t               *image);
 756 int             pixman_image_get_stride              (pixman_image_t               *image); /* in bytes */
 757 int             pixman_image_get_depth               (pixman_image_t               *image);
 758 pixman_bool_t   pixman_image_fill_rectangles         (pixman_op_t                   op,
 759                                                       pixman_image_t               *image,
 760                                                       pixman_color_t               *color,
 761                                                       int                           n_rects,
 762                                                       const pixman_rectangle16_t   *rects);
 763
 764 /* Composite */
 765 pixman_bool_t pixman_compute_composite_region (pixman_region16_t *region,
 766                                                pixman_image_t    *src_image,
 767                                                pixman_image_t    *mask_image,
 768                                                pixman_image_t    *dst_image,
 769                                                int16_t            src_x,
 770                                                int16_t            src_y,
 771                                                int16_t            mask_x,
 772                                                int16_t            mask_y,
 773                                                int16_t            dest_x,
 774                                                int16_t            dest_y,
 775                                                uint16_t           width,
 776                                                uint16_t           height);
 777 void          pixman_image_composite          (pixman_op_t        op,
 778                                                pixman_image_t    *src,
 779                                                pixman_image_t    *mask,
 780                                                pixman_image_t    *dest,
 781                                                int16_t            src_x,
 782                                                int16_t            src_y,
 783                                                int16_t            mask_x,
 784                                                int16_t            mask_y,
 785                                                int16_t            dest_x,
 786                                                int16_t            dest_y,
 787                                                uint16_t           width,
 788                                                uint16_t           height);
 789
 790 /* Old X servers rely on out-of-bounds accesses when they are asked
 791  * to composite with a window as the source. They create a pixman image
 792  * pointing to some bogus position in memory, but then they set a clip
 793  * region to the position where the actual bits are.
 794  *
 795  * Due to a bug in old versions of pixman, where it would not clip
 796  * against the image bounds when a clip region was set, this would
 797  * actually work. So by default we allow certain out-of-bound access
 798  * to happen unless explicitly disabled.
 799  *
 800  * Fixed X servers should call this function to disable the workaround.
 801  */
 802 void          pixman_disable_out_of_bounds_workaround (void);
 803
 804 /*
 805  * Trapezoids
 806  */
 807 typedef struct pixman_edge pixman_edge_t;
 808 typedef struct pixman_trapezoid pixman_trapezoid_t;
 809 typedef struct pixman_trap pixman_trap_t;
 810 typedef struct pixman_span_fix pixman_span_fix_t;
 811
 812 /*
 813  * An edge structure.  This represents a single polygon edge
 814  * and can be quickly stepped across small or large gaps in the
 815  * sample grid
 816  */
 817 struct pixman_edge
 818 {
 819     pixman_fixed_t      x;
 820     pixman_fixed_t      e;
 821     pixman_fixed_t      stepx;
 822     pixman_fixed_t      signdx;
 823     pixman_fixed_t      dy;
 824     pixman_fixed_t      dx;
 825
 826     pixman_fixed_t      stepx_small;
 827     pixman_fixed_t      stepx_big;
 828     pixman_fixed_t      dx_small;
 829     pixman_fixed_t      dx_big;
 830 };
 831
 832 struct pixman_trapezoid
 833 {
 834     pixman_fixed_t      top, bottom;
 835     pixman_line_fixed_t left, right;
 836 };
 837
 838
 839 /* whether 't' is a well defined not obviously empty trapezoid */
 840 #define pixman_trapezoid_valid(t)                                  \
 841     ((t)->left.p1.y != (t)->left.p2.y &&                           \
 842      (t)->right.p1.y != (t)->right.p2.y &&                         \
 843      (int) ((t)->bottom - (t)->top) > 0)
 844
 845 struct pixman_span_fix
 846 {
 847     pixman_fixed_t      l, r, y;
 848 };
 849
 850 struct pixman_trap
 851 {
 852     pixman_span_fix_t   top, bot;
 853 };
 854
 855 pixman_fixed_t pixman_sample_ceil_y        (pixman_fixed_t             y,
 856                                             int                        bpp);
 857 pixman_fixed_t pixman_sample_floor_y       (pixman_fixed_t             y,
 858                                             int                        bpp);
 859 void           pixman_edge_step            (pixman_edge_t             *e,
 860                                             int                        n);
 861 void           pixman_edge_init            (pixman_edge_t             *e,
 862                                             int                        bpp,
 863                                             pixman_fixed_t             y_start,
 864                                             pixman_fixed_t             x_top,
 865                                             pixman_fixed_t             y_top,
 866                                             pixman_fixed_t             x_bot,
 867                                             pixman_fixed_t             y_bot);
 868 void           pixman_line_fixed_edge_init (pixman_edge_t             *e,
 869                                             int                        bpp,
 870                                             pixman_fixed_t             y,
 871                                             const pixman_line_fixed_t *line,
 872                                             int                        x_off,
 873                                             int                        y_off);
 874 void           pixman_rasterize_edges      (pixman_image_t            *image,
 875                                             pixman_edge_t             *l,
 876                                             pixman_edge_t             *r,
 877                                             pixman_fixed_t             t,
 878                                             pixman_fixed_t             b);
 879 void           pixman_add_traps            (pixman_image_t            *image,
 880                                             int16_t                    x_off,
 881                                             int16_t                    y_off,
 882                                             int                        ntrap,
 883                                             pixman_trap_t             *traps);
 884 void           pixman_add_trapezoids       (pixman_image_t            *image,
 885                                             int16_t                    x_off,
 886                                             int                        y_off,
 887                                             int                        ntraps,
 888                                             const pixman_trapezoid_t  *traps);
 889 void           pixman_rasterize_trapezoid  (pixman_image_t            *image,
 890                                             const pixman_trapezoid_t  *trap,
 891                                             int                        x_off,
 892                                             int                        y_off);
 893
 894 #endif /* PIXMAN_H__ */