src/cairo-gstate-private.h

   1 /* cairo - a vector graphics library with display and print output
   2  *
   3  * Copyright © 2005 Red Hat, Inc.
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it either under the terms of the GNU Lesser General Public
   7  * License version 2.1 as published by the Free Software Foundation
   8  * (the "LGPL") or, at your option, under the terms of the Mozilla
   9  * Public License Version 1.1 (the "MPL"). If you do not alter this
  10  * notice, a recipient may use your version of this file under either
  11  * the MPL or the LGPL.
  12  *
  13  * You should have received a copy of the LGPL along with this library
  14  * in the file COPYING-LGPL-2.1; if not, write to the Free Software
  15  * Foundation, Inc., 51 Franklin Street, Suite 500, Boston, MA 02110-1335, USA
  16  * You should have received a copy of the MPL along with this library
  17  * in the file COPYING-MPL-1.1
  18  *
  19  * The contents of this file are subject to the Mozilla Public License
  20  * Version 1.1 (the "License"); you may not use this file except in
  21  * compliance with the License. You may obtain a copy of the License at
  22  * http://www.mozilla.org/MPL/
  23  *
  24  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY
  25  * OF ANY KIND, either express or implied. See the LGPL or the MPL for
  26  * the specific language governing rights and limitations.
  27  *
  28  * The Original Code is the cairo graphics library.
  29  *
  30  * The Initial Developer of the Original Code is Red Hat, Inc.
  31  *
  32  * Contributor(s):
  33  *      Carl D. Worth <cworth@redhat.com>
  34  */
  35
  36 #ifndef CAIRO_GSTATE_PRIVATE_H
  37 #define CAIRO_GSTATE_PRIVATE_H
  38
  39 #include "cairo-clip-private.h"
  40
  41 struct _cairo_gstate {
  42     cairo_operator_t op;
  43
  44     double opacity;
  45     double tolerance;
  46     cairo_antialias_t antialias;
  47
  48     cairo_stroke_style_t stroke_style;
  49
  50     cairo_fill_rule_t fill_rule;
  51
  52     cairo_font_face_t *font_face;
  53     cairo_scaled_font_t *scaled_font;   /* Specific to the current CTM */
  54     cairo_scaled_font_t *previous_scaled_font;  /* holdover */
  55     cairo_matrix_t font_matrix;
  56     cairo_font_options_t font_options;
  57
  58     cairo_clip_t *clip;
  59
  60     cairo_surface_t *target;            /* The target to which all rendering is directed */
  61     cairo_surface_t *parent_target;     /* The previous target which was receiving rendering */
  62     cairo_surface_t *original_target;   /* The original target the initial gstate was created with */
  63
  64     /* the user is allowed to update the device after we have cached the matrices... */
  65     cairo_observer_t device_transform_observer;
  66
  67     cairo_matrix_t ctm;
  68     cairo_matrix_t ctm_inverse;
  69     cairo_matrix_t source_ctm_inverse; /* At the time ->source was set */
  70     cairo_bool_t is_identity;
  71
  72     cairo_pattern_t *source;
  73
  74     cairo_shadow_t shadow;
  75
  76     struct _cairo_gstate *next;
  77 };
  78
  79 /* cairo-gstate.c */
  80 cairo_private cairo_status_t
  81 _cairo_gstate_init (cairo_gstate_t  *gstate,
  82                     cairo_surface_t *target);
  83
  84 cairo_private void
  85 _cairo_gstate_fini (cairo_gstate_t *gstate);
  86
  87 cairo_private cairo_status_t
  88 _cairo_gstate_save (cairo_gstate_t **gstate, cairo_gstate_t **freelist);
  89
  90 cairo_private cairo_status_t
  91 _cairo_gstate_restore (cairo_gstate_t **gstate, cairo_gstate_t **freelist);
  92
  93 cairo_private cairo_bool_t
  94 _cairo_gstate_is_group (cairo_gstate_t *gstate);
  95
  96 cairo_private cairo_status_t
  97 _cairo_gstate_redirect_target (cairo_gstate_t *gstate, cairo_surface_t *child);
  98
  99 cairo_private cairo_surface_t *
 100 _cairo_gstate_get_target (cairo_gstate_t *gstate);
 101
 102 cairo_private cairo_surface_t *
 103 _cairo_gstate_get_original_target (cairo_gstate_t *gstate);
 104
 105 cairo_private cairo_clip_t *
 106 _cairo_gstate_get_clip (cairo_gstate_t *gstate);
 107
 108 cairo_private cairo_status_t
 109 _cairo_gstate_set_source (cairo_gstate_t *gstate, cairo_pattern_t *source);
 110
 111 cairo_private cairo_pattern_t *
 112 _cairo_gstate_get_source (cairo_gstate_t *gstate);
 113
 114 cairo_private cairo_status_t
 115 _cairo_gstate_set_operator (cairo_gstate_t *gstate, cairo_operator_t op);
 116
 117 cairo_private cairo_operator_t
 118 _cairo_gstate_get_operator (cairo_gstate_t *gstate);
 119
 120 cairo_private cairo_status_t
 121 _cairo_gstate_set_opacity (cairo_gstate_t *gstate, double opacity);
 122
 123 cairo_private double
 124 _cairo_gstate_get_opacity (cairo_gstate_t *gstate);
 125
 126 cairo_private cairo_status_t
 127 _cairo_gstate_set_tolerance (cairo_gstate_t *gstate, double tolerance);
 128
 129 cairo_private double
 130 _cairo_gstate_get_tolerance (cairo_gstate_t *gstate);
 131
 132 cairo_private cairo_status_t
 133 _cairo_gstate_set_fill_rule (cairo_gstate_t *gstate, cairo_fill_rule_t fill_rule);
 134
 135 cairo_private cairo_fill_rule_t
 136 _cairo_gstate_get_fill_rule (cairo_gstate_t *gstate);
 137
 138 cairo_private cairo_status_t
 139 _cairo_gstate_set_line_width (cairo_gstate_t *gstate, double width);
 140
 141 cairo_private double
 142 _cairo_gstate_get_line_width (cairo_gstate_t *gstate);
 143
 144 cairo_private cairo_status_t
 145 _cairo_gstate_set_line_cap (cairo_gstate_t *gstate, cairo_line_cap_t line_cap);
 146
 147 cairo_private cairo_line_cap_t
 148 _cairo_gstate_get_line_cap (cairo_gstate_t *gstate);
 149
 150 cairo_private cairo_status_t
 151 _cairo_gstate_set_line_join (cairo_gstate_t *gstate, cairo_line_join_t line_join);
 152
 153 cairo_private cairo_line_join_t
 154 _cairo_gstate_get_line_join (cairo_gstate_t *gstate);
 155
 156 cairo_private cairo_status_t
 157 _cairo_gstate_set_dash (cairo_gstate_t *gstate, const double *dash, int num_dashes, double offset);
 158
 159 cairo_private void
 160 _cairo_gstate_get_dash (cairo_gstate_t *gstate, double *dash, int *num_dashes, double *offset);
 161
 162 cairo_private cairo_status_t
 163 _cairo_gstate_set_miter_limit (cairo_gstate_t *gstate, double limit);
 164
 165 cairo_private double
 166 _cairo_gstate_get_miter_limit (cairo_gstate_t *gstate);
 167
 168 cairo_private void
 169 _cairo_gstate_get_matrix (cairo_gstate_t *gstate, cairo_matrix_t *matrix);
 170
 171 cairo_private cairo_status_t
 172 _cairo_gstate_translate (cairo_gstate_t *gstate, double tx, double ty);
 173
 174 cairo_private cairo_status_t
 175 _cairo_gstate_scale (cairo_gstate_t *gstate, double sx, double sy);
 176
 177 cairo_private cairo_status_t
 178 _cairo_gstate_rotate (cairo_gstate_t *gstate, double angle);
 179
 180 cairo_private cairo_status_t
 181 _cairo_gstate_transform (cairo_gstate_t       *gstate,
 182                          const cairo_matrix_t *matrix);
 183
 184 cairo_private cairo_status_t
 185 _cairo_gstate_set_matrix (cairo_gstate_t       *gstate,
 186                           const cairo_matrix_t *matrix);
 187
 188 cairo_private void
 189 _cairo_gstate_identity_matrix (cairo_gstate_t *gstate);
 190
 191 cairo_private void
 192 _cairo_gstate_user_to_device (cairo_gstate_t *gstate, double *x, double *y);
 193
 194 cairo_private void
 195 _cairo_gstate_user_to_device_distance (cairo_gstate_t *gstate, double *dx, double *dy);
 196
 197 cairo_private void
 198 _cairo_gstate_device_to_user (cairo_gstate_t *gstate, double *x, double *y);
 199
 200 cairo_private void
 201 _cairo_gstate_device_to_user_distance (cairo_gstate_t *gstate, double *dx, double *dy);
 202
 203 cairo_private void
 204 _do_cairo_gstate_user_to_backend (cairo_gstate_t *gstate, double *x, double *y);
 205
 206 static inline void
 207 _cairo_gstate_user_to_backend (cairo_gstate_t *gstate, double *x, double *y)
 208 {
 209     if (! gstate->is_identity)
 210         _do_cairo_gstate_user_to_backend (gstate, x, y);
 211 }
 212
 213 cairo_private void
 214 _do_cairo_gstate_user_to_backend_distance (cairo_gstate_t *gstate, double *x, double *y);
 215
 216 static inline void
 217 _cairo_gstate_user_to_backend_distance (cairo_gstate_t *gstate, double *x, double *y)
 218 {
 219     if (! gstate->is_identity)
 220         _do_cairo_gstate_user_to_backend_distance (gstate, x, y);
 221 }
 222
 223 cairo_private void
 224 _do_cairo_gstate_backend_to_user (cairo_gstate_t *gstate, double *x, double *y);
 225
 226 static inline void
 227 _cairo_gstate_backend_to_user (cairo_gstate_t *gstate, double *x, double *y)
 228 {
 229     if (! gstate->is_identity)
 230         _do_cairo_gstate_backend_to_user (gstate, x, y);
 231 }
 232
 233 cairo_private void
 234 _do_cairo_gstate_backend_to_user_distance (cairo_gstate_t *gstate, double *x, double *y);
 235
 236 static inline void
 237 _cairo_gstate_backend_to_user_distance (cairo_gstate_t *gstate, double *x, double *y)
 238 {
 239     if (! gstate->is_identity)
 240         _do_cairo_gstate_backend_to_user_distance (gstate, x, y);
 241 }
 242
 243 cairo_private void
 244 _cairo_gstate_backend_to_user_rectangle (cairo_gstate_t *gstate,
 245                                          double *x1, double *y1,
 246                                          double *x2, double *y2,
 247                                          cairo_bool_t *is_tight);
 248
 249 cairo_private void
 250 _cairo_gstate_path_extents (cairo_gstate_t     *gstate,
 251                             cairo_path_fixed_t *path,
 252                             double *x1, double *y1,
 253                             double *x2, double *y2);
 254
 255 cairo_private cairo_status_t
 256 _cairo_gstate_paint (cairo_gstate_t *gstate);
 257
 258 cairo_private cairo_status_t
 259 _cairo_gstate_mask (cairo_gstate_t  *gstate,
 260                     cairo_pattern_t *mask);
 261
 262 cairo_private cairo_status_t
 263 _cairo_gstate_stroke (cairo_gstate_t *gstate, cairo_path_fixed_t *path);
 264
 265 cairo_private cairo_status_t
 266 _cairo_gstate_fill (cairo_gstate_t *gstate, cairo_path_fixed_t *path);
 267
 268 cairo_private cairo_status_t
 269 _cairo_gstate_copy_page (cairo_gstate_t *gstate);
 270
 271 cairo_private cairo_status_t
 272 _cairo_gstate_show_page (cairo_gstate_t *gstate);
 273
 274 cairo_private cairo_status_t
 275 _cairo_gstate_stroke_extents (cairo_gstate_t     *gstate,
 276                               cairo_path_fixed_t *path,
 277                               double *x1, double *y1,
 278                               double *x2, double *y2);
 279
 280 cairo_private cairo_status_t
 281 _cairo_gstate_fill_extents (cairo_gstate_t     *gstate,
 282                             cairo_path_fixed_t *path,
 283                             double *x1, double *y1,
 284                             double *x2, double *y2);
 285
 286 cairo_private cairo_status_t
 287 _cairo_gstate_in_stroke (cairo_gstate_t     *gstate,
 288                          cairo_path_fixed_t *path,
 289                          double              x,
 290                          double              y,
 291                          cairo_bool_t       *inside_ret);
 292
 293 cairo_private cairo_bool_t
 294 _cairo_gstate_in_fill (cairo_gstate_t     *gstate,
 295                        cairo_path_fixed_t *path,
 296                        double              x,
 297                        double              y);
 298
 299 cairo_private cairo_bool_t
 300 _cairo_gstate_in_clip (cairo_gstate_t     *gstate,
 301                        double              x,
 302                        double              y);
 303
 304 cairo_private cairo_status_t
 305 _cairo_gstate_clip (cairo_gstate_t *gstate, cairo_path_fixed_t *path);
 306
 307 cairo_private cairo_status_t
 308 _cairo_gstate_reset_clip (cairo_gstate_t *gstate);
 309
 310 cairo_private cairo_bool_t
 311 _cairo_gstate_clip_extents (cairo_gstate_t *gstate,
 312                             double         *x1,
 313                             double         *y1,
 314                             double         *x2,
 315                             double         *y2);
 316
 317 cairo_private cairo_rectangle_list_t*
 318 _cairo_gstate_copy_clip_rectangle_list (cairo_gstate_t *gstate);
 319
 320 cairo_private cairo_status_t
 321 _cairo_gstate_show_surface (cairo_gstate_t      *gstate,
 322                             cairo_surface_t     *surface,
 323                             double               x,
 324                             double               y,
 325                             double              width,
 326                             double              height);
 327
 328 cairo_private cairo_status_t
 329 _cairo_gstate_set_font_size (cairo_gstate_t *gstate,
 330                              double          size);
 331
 332 cairo_private void
 333 _cairo_gstate_get_font_matrix (cairo_gstate_t *gstate,
 334                                cairo_matrix_t *matrix);
 335
 336 cairo_private cairo_status_t
 337 _cairo_gstate_set_font_matrix (cairo_gstate_t       *gstate,
 338                                const cairo_matrix_t *matrix);
 339
 340 cairo_private void
 341 _cairo_gstate_get_font_options (cairo_gstate_t       *gstate,
 342                                 cairo_font_options_t *options);
 343
 344 cairo_private void
 345 _cairo_gstate_set_font_options (cairo_gstate_t             *gstate,
 346                                 const cairo_font_options_t *options);
 347
 348 cairo_private cairo_status_t
 349 _cairo_gstate_get_font_face (cairo_gstate_t     *gstate,
 350                              cairo_font_face_t **font_face);
 351
 352 cairo_private cairo_status_t
 353 _cairo_gstate_get_scaled_font (cairo_gstate_t       *gstate,
 354                                cairo_scaled_font_t **scaled_font);
 355
 356 cairo_private cairo_status_t
 357 _cairo_gstate_get_font_extents (cairo_gstate_t *gstate,
 358                                 cairo_font_extents_t *extents);
 359
 360 cairo_private cairo_status_t
 361 _cairo_gstate_set_font_face (cairo_gstate_t    *gstate,
 362                              cairo_font_face_t *font_face);
 363
 364 cairo_private cairo_status_t
 365 _cairo_gstate_glyph_extents (cairo_gstate_t *gstate,
 366                              const cairo_glyph_t *glyphs,
 367                              int num_glyphs,
 368                              cairo_text_extents_t *extents);
 369
 370 cairo_private cairo_status_t
 371 _cairo_gstate_show_text_glyphs (cairo_gstate_t             *gstate,
 372                                 const cairo_glyph_t        *glyphs,
 373                                 int                         num_glyphs,
 374                                 cairo_glyph_text_info_t    *info);
 375
 376 cairo_private cairo_status_t
 377 _cairo_gstate_glyph_path (cairo_gstate_t      *gstate,
 378                           const cairo_glyph_t *glyphs,
 379                           int                  num_glyphs,
 380                           cairo_path_fixed_t  *path);
 381
 382 cairo_private cairo_status_t
 383 _cairo_gstate_set_antialias (cairo_gstate_t *gstate,
 384                              cairo_antialias_t antialias);
 385
 386 cairo_private cairo_antialias_t
 387 _cairo_gstate_get_antialias (cairo_gstate_t *gstate);
 388
 389 cairo_private cairo_status_t
 390 _cairo_gstate_set_shadow (cairo_gstate_t *gstate, cairo_shadow_type_t shadow);
 391
 392 cairo_private cairo_status_t
 393 _cairo_gstate_set_shadow_offset (cairo_gstate_t *gstate, double x_offset,
 394                                  double y_offset);
 395
 396 cairo_private cairo_status_t
 397 _cairo_gstate_set_shadow_rgba (cairo_gstate_t *gstate, double r, double g,
 398                                double b, double a);
 399
 400 cairo_private cairo_status_t
 401 _cairo_gstate_set_shadow_blur (cairo_gstate_t *gstate, double x_blur,
 402                                double y_blur);
 403
 404 cairo_private void
 405 _cairo_gstate_set_draw_shadow_only (cairo_gstate_t *gstate,
 406                                     cairo_bool_t draw_shadow_only);
 407
 408 cairo_private void
 409 _cairo_gstate_shadow_enable_cache (cairo_gstate_t *gstate, cairo_bool_t enable);
 410
 411 cairo_private void
 412 _cairo_gstate_set_path_is_inset_shadow_with_spread (cairo_gstate_t *gstate,
 413                                                     cairo_bool_t   is_spread_path);
 414
 415 #endif /* CAIRO_GSTATE_PRIVATE_H */