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