src/cairo-pdf-shading-private.h

   1 /* -*- Mode: c; tab-width: 8; c-basic-offset: 4; indent-tabs-mode: t; -*- */
   2 /* cairo - a vector graphics library with display and print output
   3  *
   4  * Copyright © 2009 Adrian Johnson
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it either under the terms of the GNU Lesser General Public
   8  * License version 2.1 as published by the Free Software Foundation
   9  * (the "LGPL") or, at your option, under the terms of the Mozilla
  10  * Public License Version 1.1 (the "MPL"). If you do not alter this
  11  * notice, a recipient may use your version of this file under either
  12  * the MPL or the LGPL.
  13  *
  14  * You should have received a copy of the LGPL along with this library
  15  * in the file COPYING-LGPL-2.1; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin Street, Suite 500, Boston, MA 02110-1335, USA
  17  * You should have received a copy of the MPL along with this library
  18  * in the file COPYING-MPL-1.1
  19  *
  20  * The contents of this file are subject to the Mozilla Public License
  21  * Version 1.1 (the "License"); you may not use this file except in
  22  * compliance with the License. You may obtain a copy of the License at
  23  * http://www.mozilla.org/MPL/
  24  *
  25  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY
  26  * OF ANY KIND, either express or implied. See the LGPL or the MPL for
  27  * the specific language governing rights and limitations.
  28  *
  29  * The Original Code is the cairo graphics library.
  30  *
  31  * The Initial Developer of the Original Code is Adrian Johnson.
  32  *
  33  * Contributor(s):
  34  *      Adrian Johnson <ajohnson@redneon.com>
  35  */
  36
  37 #ifndef CAIRO_PDF_SHADING_H
  38 #define CAIRO_PDF_SHADING_H
  39
  40 #include "cairo-compiler-private.h"
  41 #include "cairo-types-private.h"
  42 #include "cairo-pattern-private.h"
  43
  44
  45 typedef struct _cairo_pdf_shading {
  46     int shading_type;
  47     int bits_per_coordinate;
  48     int bits_per_component;
  49     int bits_per_flag;
  50     double *decode_array;
  51     int decode_array_length;
  52     unsigned char *data;
  53     unsigned long data_length;
  54 } cairo_pdf_shading_t;
  55
  56
  57 /**
  58  * _cairo_pdf_shading_init_color:
  59  * @shading: a #cairo_pdf_shading_t to initialize
  60  * @pattern: the #cairo_mesh_pattern_t to initialize from
  61  *
  62  * Generate the PDF shading dictionary data for the a PDF type 7
  63  * shading from RGB part of the specified mesh pattern.
  64  *
  65  * Return value: %CAIRO_STATUS_SUCCESS if successful, possible errors
  66  * include %CAIRO_STATUS_NO_MEMORY.
  67  **/
  68 cairo_private cairo_status_t
  69 _cairo_pdf_shading_init_color (cairo_pdf_shading_t        *shading,
  70                                const cairo_mesh_pattern_t *pattern);
  71
  72
  73 /**
  74  * _cairo_pdf_shading_init_alpha:
  75  * @shading: a #cairo_pdf_shading_t to initialize
  76  * @pattern: the #cairo_mesh_pattern_t to initialize from
  77  *
  78  * Generate the PDF shading dictionary data for a PDF type 7
  79  * shading from alpha part of the specified mesh pattern.
  80  *
  81  * Return value: %CAIRO_STATUS_SUCCESS if successful, possible errors
  82  * include %CAIRO_STATUS_NO_MEMORY.
  83  **/
  84 cairo_private cairo_status_t
  85 _cairo_pdf_shading_init_alpha (cairo_pdf_shading_t        *shading,
  86                                const cairo_mesh_pattern_t *pattern);
  87
  88 /**
  89  * _cairo_pdf_shading_fini:
  90  * @shading: a #cairo_pdf_shading_t
  91  *
  92  * Free all resources associated with @shading.  After this call,
  93  * @shading should not be used again without a subsequent call to
  94  * _cairo_pdf_shading_init() again first.
  95  **/
  96 cairo_private void
  97 _cairo_pdf_shading_fini (cairo_pdf_shading_t *shading);
  98
  99
 100 #endif /* CAIRO_PDF_SHADING_H */