src/cairo-color.c

   1 /* cairo - a vector graphics library with display and print output
   2  *
   3  * Copyright © 2002 University of Southern California
   4  * Copyright © 2005 Red Hat, Inc.
   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 University of Southern
  32  * California.
  33  *
  34  * Contributor(s):
  35  *      Carl D. Worth <cworth@cworth.org>
  36  */
  37
  38 #include "cairoint.h"
  39
  40 static cairo_color_t const cairo_color_white = {
  41     1.0,    1.0,    1.0,    1.0,
  42     0xffff, 0xffff, 0xffff, 0xffff
  43 };
  44
  45 static cairo_color_t const cairo_color_black = {
  46     0.0, 0.0, 0.0, 1.0,
  47     0x0, 0x0, 0x0, 0xffff
  48 };
  49
  50 static cairo_color_t const cairo_color_transparent = {
  51     0.0, 0.0, 0.0, 0.0,
  52     0x0, 0x0, 0x0, 0x0
  53 };
  54
  55 static cairo_color_t const cairo_color_magenta = {
  56     1.0,    0.0, 1.0,    1.0,
  57     0xffff, 0x0, 0xffff, 0xffff
  58 };
  59
  60 const cairo_color_t *
  61 _cairo_stock_color (cairo_stock_t stock)
  62 {
  63     switch (stock) {
  64     case CAIRO_STOCK_WHITE:
  65         return &cairo_color_white;
  66     case CAIRO_STOCK_BLACK:
  67         return &cairo_color_black;
  68     case CAIRO_STOCK_TRANSPARENT:
  69         return &cairo_color_transparent;
  70
  71     case CAIRO_STOCK_NUM_COLORS:
  72     default:
  73         ASSERT_NOT_REACHED;
  74         /* If the user can get here somehow, give a color that indicates a
  75          * problem. */
  76         return &cairo_color_magenta;
  77     }
  78 }
  79
  80 /* Convert a double in [0.0, 1.0] to an integer in [0, 65535]
  81  * The conversion is designed to divide the input range into 65536
  82  * equally-sized regions. This is achieved by multiplying by 65536 and
  83  * then special-casing the result of an input value of 1.0 so that it
  84  * maps to 65535 instead of 65536.
  85  */
  86 uint16_t
  87 _cairo_color_double_to_short (double d)
  88 {
  89     uint32_t i;
  90     i = (uint32_t) (d * 65536);
  91     i -= (i >> 16);
  92     return i;
  93 }
  94
  95 static void
  96 _cairo_color_compute_shorts (cairo_color_t *color)
  97 {
  98     color->red_short   = _cairo_color_double_to_short (color->red   * color->alpha);
  99     color->green_short = _cairo_color_double_to_short (color->green * color->alpha);
 100     color->blue_short  = _cairo_color_double_to_short (color->blue  * color->alpha);
 101     color->alpha_short = _cairo_color_double_to_short (color->alpha);
 102 }
 103
 104 void
 105 _cairo_color_init_rgba (cairo_color_t *color,
 106                         double red, double green, double blue,
 107                         double alpha)
 108 {
 109     color->red   = red;
 110     color->green = green;
 111     color->blue  = blue;
 112     color->alpha = alpha;
 113
 114     _cairo_color_compute_shorts (color);
 115 }
 116
 117 void
 118 _cairo_color_multiply_alpha (cairo_color_t *color,
 119                              double         alpha)
 120 {
 121     color->alpha *= alpha;
 122
 123     _cairo_color_compute_shorts (color);
 124 }
 125
 126 void
 127 _cairo_color_get_rgba (cairo_color_t *color,
 128                        double        *red,
 129                        double        *green,
 130                        double        *blue,
 131                        double        *alpha)
 132 {
 133     *red   = color->red;
 134     *green = color->green;
 135     *blue  = color->blue;
 136     *alpha = color->alpha;
 137 }
 138
 139 void
 140 _cairo_color_get_rgba_premultiplied (cairo_color_t *color,
 141                                      double        *red,
 142                                      double        *green,
 143                                      double        *blue,
 144                                      double        *alpha)
 145 {
 146     *red   = color->red   * color->alpha;
 147     *green = color->green * color->alpha;
 148     *blue  = color->blue  * color->alpha;
 149     *alpha = color->alpha;
 150 }
 151
 152 /* NB: This function works both for unmultiplied and premultiplied colors */
 153 cairo_bool_t
 154 _cairo_color_equal (const cairo_color_t *color_a,
 155                     const cairo_color_t *color_b)
 156 {
 157     if (color_a == color_b)
 158         return TRUE;
 159
 160     if (color_a->alpha_short != color_b->alpha_short)
 161         return FALSE;
 162
 163     if (color_a->alpha_short == 0)
 164         return TRUE;
 165
 166     return color_a->red_short   == color_b->red_short   &&
 167            color_a->green_short == color_b->green_short &&
 168            color_a->blue_short  == color_b->blue_short;
 169 }
 170
 171 cairo_bool_t
 172 _cairo_color_stop_equal (const cairo_color_stop_t *color_a,
 173                          const cairo_color_stop_t *color_b)
 174 {
 175     if (color_a == color_b)
 176         return TRUE;
 177
 178     return color_a->alpha_short == color_b->alpha_short &&
 179            color_a->red_short   == color_b->red_short   &&
 180            color_a->green_short == color_b->green_short &&
 181            color_a->blue_short  == color_b->blue_short;
 182 }
 183
 184 cairo_content_t
 185 _cairo_color_get_content (const cairo_color_t *color)
 186 {
 187     if (CAIRO_COLOR_IS_OPAQUE (color))
 188         return CAIRO_CONTENT_COLOR;
 189
 190     if (color->red_short == 0 &&
 191         color->green_short == 0 &&
 192         color->blue_short == 0)
 193     {
 194         return CAIRO_CONTENT_ALPHA;
 195     }
 196
 197     return CAIRO_CONTENT_COLOR_ALPHA;
 198 }