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