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