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