pixman/pixman.h

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