"Initial commit to Gerrit"
[profile/ivi/cogl.git] / doc / reference / cogl / html / cogl-Color-Type.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>Color Type</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7 <link rel="home" href="index.html" title="Cogl Reference Manual">
8 <link rel="up" href="ch01.html" title="Cogl - a modern 3D graphics API">
9 <link rel="prev" href="cogl-General-API.html" title="General API">
10 <link rel="next" href="cogl-Textures.html" title="Textures">
11 <meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
13 </head>
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
16 <tr valign="middle">
17 <td><a accesskey="p" href="cogl-General-API.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20 <th width="100%" align="center">Cogl Reference Manual</th>
21 <td><a accesskey="n" href="cogl-Textures.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22 </tr>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#cogl-Color-Type.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#cogl-Color-Type.description" class="shortcut">Description</a>
27 </td></tr>
28 </table>
29 <div class="refentry">
30 <a name="cogl-Color-Type"></a><div class="titlepage"></div>
31 <div class="refnamediv"><table width="100%"><tr>
32 <td valign="top">
33 <h2><span class="refentrytitle"><a name="cogl-Color-Type.top_of_page"></a>Color Type</span></h2>
34 <p>Color Type — A generic color definition</p>
35 </td>
36 <td valign="top" align="right"></td>
37 </tr></table></div>
38 <div class="refsynopsisdiv">
39 <a name="cogl-Color-Type.synopsis"></a><h2>Synopsis</h2>
40 <pre class="synopsis">struct              <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor">CoglColor</a>;
41 <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="returnvalue">CoglColor</span></a> *         <a class="link" href="cogl-Color-Type.html#cogl-color-new" title="cogl_color_new ()">cogl_color_new</a>                      (<em class="parameter"><code><span class="type">void</span></code></em>);
42 <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="returnvalue">CoglColor</span></a> *         <a class="link" href="cogl-Color-Type.html#cogl-color-copy" title="cogl_color_copy ()">cogl_color_copy</a>                     (<em class="parameter"><code>const <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>);
43 <span class="returnvalue">void</span>                <a class="link" href="cogl-Color-Type.html#cogl-color-free" title="cogl_color_free ()">cogl_color_free</a>                     (<em class="parameter"><code><a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>);
44 <span class="returnvalue">void</span>                <a class="link" href="cogl-Color-Type.html#cogl-color-init-from-4f" title="cogl_color_init_from_4f ()">cogl_color_init_from_4f</a>             (<em class="parameter"><code><a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>,
45                                                          <em class="parameter"><code><span class="type">float</span> red</code></em>,
46                                                          <em class="parameter"><code><span class="type">float</span> green</code></em>,
47                                                          <em class="parameter"><code><span class="type">float</span> blue</code></em>,
48                                                          <em class="parameter"><code><span class="type">float</span> alpha</code></em>);
49 <span class="returnvalue">void</span>                <a class="link" href="cogl-Color-Type.html#cogl-color-init-from-4fv" title="cogl_color_init_from_4fv ()">cogl_color_init_from_4fv</a>            (<em class="parameter"><code><a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>,
50                                                          <em class="parameter"><code><span class="type">float</span> *color_array</code></em>);
51 <span class="returnvalue">void</span>                <a class="link" href="cogl-Color-Type.html#cogl-color-init-from-4ub" title="cogl_color_init_from_4ub ()">cogl_color_init_from_4ub</a>            (<em class="parameter"><code><a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>,
52                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> red</code></em>,
53                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> green</code></em>,
54                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> blue</code></em>,
55                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> alpha</code></em>);
56 <span class="returnvalue">void</span>                <a class="link" href="cogl-Color-Type.html#cogl-color-set-from-4ub" title="cogl_color_set_from_4ub ()">cogl_color_set_from_4ub</a>             (<em class="parameter"><code><a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>,
57                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> red</code></em>,
58                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> green</code></em>,
59                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> blue</code></em>,
60                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> alpha</code></em>);
61 <span class="returnvalue">void</span>                <a class="link" href="cogl-Color-Type.html#cogl-color-set-from-4f" title="cogl_color_set_from_4f ()">cogl_color_set_from_4f</a>              (<em class="parameter"><code><a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>,
62                                                          <em class="parameter"><code><span class="type">float</span> red</code></em>,
63                                                          <em class="parameter"><code><span class="type">float</span> green</code></em>,
64                                                          <em class="parameter"><code><span class="type">float</span> blue</code></em>,
65                                                          <em class="parameter"><code><span class="type">float</span> alpha</code></em>);
66
67 <span class="returnvalue">float</span>               <a class="link" href="cogl-Color-Type.html#cogl-color-get-red" title="cogl_color_get_red ()">cogl_color_get_red</a>                  (<em class="parameter"><code>const <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>);
68 <span class="returnvalue">float</span>               <a class="link" href="cogl-Color-Type.html#cogl-color-get-green" title="cogl_color_get_green ()">cogl_color_get_green</a>                (<em class="parameter"><code>const <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>);
69 <span class="returnvalue">float</span>               <a class="link" href="cogl-Color-Type.html#cogl-color-get-blue" title="cogl_color_get_blue ()">cogl_color_get_blue</a>                 (<em class="parameter"><code>const <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>);
70 <span class="returnvalue">float</span>               <a class="link" href="cogl-Color-Type.html#cogl-color-get-alpha" title="cogl_color_get_alpha ()">cogl_color_get_alpha</a>                (<em class="parameter"><code>const <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>);
71
72 unsigned <span class="returnvalue">char</span>       <a class="link" href="cogl-Color-Type.html#cogl-color-get-red-byte" title="cogl_color_get_red_byte ()">cogl_color_get_red_byte</a>             (<em class="parameter"><code>const <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>);
73 unsigned <span class="returnvalue">char</span>       <a class="link" href="cogl-Color-Type.html#cogl-color-get-green-byte" title="cogl_color_get_green_byte ()">cogl_color_get_green_byte</a>           (<em class="parameter"><code>const <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>);
74 unsigned <span class="returnvalue">char</span>       <a class="link" href="cogl-Color-Type.html#cogl-color-get-blue-byte" title="cogl_color_get_blue_byte ()">cogl_color_get_blue_byte</a>            (<em class="parameter"><code>const <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>);
75 unsigned <span class="returnvalue">char</span>       <a class="link" href="cogl-Color-Type.html#cogl-color-get-alpha-byte" title="cogl_color_get_alpha_byte ()">cogl_color_get_alpha_byte</a>           (<em class="parameter"><code>const <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>);
76
77 <span class="returnvalue">float</span>               <a class="link" href="cogl-Color-Type.html#cogl-color-get-red-float" title="cogl_color_get_red_float ()">cogl_color_get_red_float</a>            (<em class="parameter"><code>const <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>);
78 <span class="returnvalue">float</span>               <a class="link" href="cogl-Color-Type.html#cogl-color-get-green-float" title="cogl_color_get_green_float ()">cogl_color_get_green_float</a>          (<em class="parameter"><code>const <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>);
79 <span class="returnvalue">float</span>               <a class="link" href="cogl-Color-Type.html#cogl-color-get-blue-float" title="cogl_color_get_blue_float ()">cogl_color_get_blue_float</a>           (<em class="parameter"><code>const <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>);
80 <span class="returnvalue">float</span>               <a class="link" href="cogl-Color-Type.html#cogl-color-get-alpha-float" title="cogl_color_get_alpha_float ()">cogl_color_get_alpha_float</a>          (<em class="parameter"><code>const <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>);
81
82 <span class="returnvalue">void</span>                <a class="link" href="cogl-Color-Type.html#cogl-color-set-red" title="cogl_color_set_red ()">cogl_color_set_red</a>                  (<em class="parameter"><code><a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>,
83                                                          <em class="parameter"><code><span class="type">float</span> red</code></em>);
84 <span class="returnvalue">void</span>                <a class="link" href="cogl-Color-Type.html#cogl-color-set-green" title="cogl_color_set_green ()">cogl_color_set_green</a>                (<em class="parameter"><code><a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>,
85                                                          <em class="parameter"><code><span class="type">float</span> green</code></em>);
86 <span class="returnvalue">void</span>                <a class="link" href="cogl-Color-Type.html#cogl-color-set-blue" title="cogl_color_set_blue ()">cogl_color_set_blue</a>                 (<em class="parameter"><code><a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>,
87                                                          <em class="parameter"><code><span class="type">float</span> blue</code></em>);
88 <span class="returnvalue">void</span>                <a class="link" href="cogl-Color-Type.html#cogl-color-set-alpha" title="cogl_color_set_alpha ()">cogl_color_set_alpha</a>                (<em class="parameter"><code><a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>,
89                                                          <em class="parameter"><code><span class="type">float</span> alpha</code></em>);
90
91 <span class="returnvalue">void</span>                <a class="link" href="cogl-Color-Type.html#cogl-color-set-red-byte" title="cogl_color_set_red_byte ()">cogl_color_set_red_byte</a>             (<em class="parameter"><code><a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>,
92                                                          <em class="parameter"><code>unsigned <span class="type">char</span> red</code></em>);
93 <span class="returnvalue">void</span>                <a class="link" href="cogl-Color-Type.html#cogl-color-set-green-byte" title="cogl_color_set_green_byte ()">cogl_color_set_green_byte</a>           (<em class="parameter"><code><a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>,
94                                                          <em class="parameter"><code>unsigned <span class="type">char</span> green</code></em>);
95 <span class="returnvalue">void</span>                <a class="link" href="cogl-Color-Type.html#cogl-color-set-blue-byte" title="cogl_color_set_blue_byte ()">cogl_color_set_blue_byte</a>            (<em class="parameter"><code><a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>,
96                                                          <em class="parameter"><code>unsigned <span class="type">char</span> blue</code></em>);
97 <span class="returnvalue">void</span>                <a class="link" href="cogl-Color-Type.html#cogl-color-set-alpha-byte" title="cogl_color_set_alpha_byte ()">cogl_color_set_alpha_byte</a>           (<em class="parameter"><code><a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>,
98                                                          <em class="parameter"><code>unsigned <span class="type">char</span> alpha</code></em>);
99
100 <span class="returnvalue">void</span>                <a class="link" href="cogl-Color-Type.html#cogl-color-set-red-float" title="cogl_color_set_red_float ()">cogl_color_set_red_float</a>            (<em class="parameter"><code><a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>,
101                                                          <em class="parameter"><code><span class="type">float</span> red</code></em>);
102 <span class="returnvalue">void</span>                <a class="link" href="cogl-Color-Type.html#cogl-color-set-green-float" title="cogl_color_set_green_float ()">cogl_color_set_green_float</a>          (<em class="parameter"><code><a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>,
103                                                          <em class="parameter"><code><span class="type">float</span> green</code></em>);
104 <span class="returnvalue">void</span>                <a class="link" href="cogl-Color-Type.html#cogl-color-set-blue-float" title="cogl_color_set_blue_float ()">cogl_color_set_blue_float</a>           (<em class="parameter"><code><a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>,
105                                                          <em class="parameter"><code><span class="type">float</span> blue</code></em>);
106 <span class="returnvalue">void</span>                <a class="link" href="cogl-Color-Type.html#cogl-color-set-alpha-float" title="cogl_color_set_alpha_float ()">cogl_color_set_alpha_float</a>          (<em class="parameter"><code><a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>,
107                                                          <em class="parameter"><code><span class="type">float</span> alpha</code></em>);
108
109 <span class="returnvalue">void</span>                <a class="link" href="cogl-Color-Type.html#cogl-color-premultiply" title="cogl_color_premultiply ()">cogl_color_premultiply</a>              (<em class="parameter"><code><a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>);
110 <span class="returnvalue">void</span>                <a class="link" href="cogl-Color-Type.html#cogl-color-unpremultiply" title="cogl_color_unpremultiply ()">cogl_color_unpremultiply</a>            (<em class="parameter"><code><a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>);
111 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="cogl-Color-Type.html#cogl-color-equal" title="cogl_color_equal ()">cogl_color_equal</a>                    (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gconstpointer"><span class="type">gconstpointer</span></a> v1</code></em>,
112                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gconstpointer"><span class="type">gconstpointer</span></a> v2</code></em>);
113 </pre>
114 </div>
115 <div class="refsect1">
116 <a name="cogl-Color-Type.description"></a><h2>Description</h2>
117 <p>
118 <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> is a simple structure holding the definition of a color such
119 that it can be efficiently used by GL
120 </p>
121 </div>
122 <div class="refsect1">
123 <a name="cogl-Color-Type.details"></a><h2>Details</h2>
124 <div class="refsect2">
125 <a name="CoglColor"></a><h3>struct CoglColor</h3>
126 <pre class="programlisting">struct CoglColor {
127 };
128 </pre>
129 <p>
130 A structure for holding a color definition. The contents of
131 the CoglColor structure are private and should never by accessed
132 directly.
133 </p>
134 <p class="since">Since 1.0</p>
135 </div>
136 <hr>
137 <div class="refsect2">
138 <a name="cogl-color-new"></a><h3>cogl_color_new ()</h3>
139 <pre class="programlisting"><a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="returnvalue">CoglColor</span></a> *         cogl_color_new                      (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
140 <p>
141 Creates a new (empty) color
142 </p>
143 <div class="variablelist"><table border="0">
144 <col align="left" valign="top">
145 <tbody><tr>
146 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
147 <td>a newly-allocated <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a>. Use <a class="link" href="cogl-Color-Type.html#cogl-color-free" title="cogl_color_free ()"><code class="function">cogl_color_free()</code></a>
148 to free the allocated resources</td>
149 </tr></tbody>
150 </table></div>
151 <p class="since">Since 1.0</p>
152 </div>
153 <hr>
154 <div class="refsect2">
155 <a name="cogl-color-copy"></a><h3>cogl_color_copy ()</h3>
156 <pre class="programlisting"><a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="returnvalue">CoglColor</span></a> *         cogl_color_copy                     (<em class="parameter"><code>const <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>);</pre>
157 <p>
158 Creates a copy of <em class="parameter"><code>color</code></em>
159 </p>
160 <div class="variablelist"><table border="0">
161 <col align="left" valign="top">
162 <tbody>
163 <tr>
164 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
165 <td>the color to copy</td>
166 </tr>
167 <tr>
168 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
169 <td>a newly-allocated <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a>. Use <a class="link" href="cogl-Color-Type.html#cogl-color-free" title="cogl_color_free ()"><code class="function">cogl_color_free()</code></a>
170 to free the allocate resources</td>
171 </tr>
172 </tbody>
173 </table></div>
174 <p class="since">Since 1.0</p>
175 </div>
176 <hr>
177 <div class="refsect2">
178 <a name="cogl-color-free"></a><h3>cogl_color_free ()</h3>
179 <pre class="programlisting"><span class="returnvalue">void</span>                cogl_color_free                     (<em class="parameter"><code><a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>);</pre>
180 <p>
181 Frees the resources allocated by <a class="link" href="cogl-Color-Type.html#cogl-color-new" title="cogl_color_new ()"><code class="function">cogl_color_new()</code></a> and <a class="link" href="cogl-Color-Type.html#cogl-color-copy" title="cogl_color_copy ()"><code class="function">cogl_color_copy()</code></a>
182 </p>
183 <div class="variablelist"><table border="0">
184 <col align="left" valign="top">
185 <tbody><tr>
186 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
187 <td>the color to free</td>
188 </tr></tbody>
189 </table></div>
190 <p class="since">Since 1.0</p>
191 </div>
192 <hr>
193 <div class="refsect2">
194 <a name="cogl-color-init-from-4f"></a><h3>cogl_color_init_from_4f ()</h3>
195 <pre class="programlisting"><span class="returnvalue">void</span>                cogl_color_init_from_4f             (<em class="parameter"><code><a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>,
196                                                          <em class="parameter"><code><span class="type">float</span> red</code></em>,
197                                                          <em class="parameter"><code><span class="type">float</span> green</code></em>,
198                                                          <em class="parameter"><code><span class="type">float</span> blue</code></em>,
199                                                          <em class="parameter"><code><span class="type">float</span> alpha</code></em>);</pre>
200 <p>
201 Sets the values of the passed channels into a <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a>
202 </p>
203 <div class="variablelist"><table border="0">
204 <col align="left" valign="top">
205 <tbody>
206 <tr>
207 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
208 <td>A pointer to a <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> to initialize</td>
209 </tr>
210 <tr>
211 <td><p><span class="term"><em class="parameter"><code>red</code></em> :</span></p></td>
212 <td>value of the red channel, between 0 and <code class="literal">1</code>.0</td>
213 </tr>
214 <tr>
215 <td><p><span class="term"><em class="parameter"><code>green</code></em> :</span></p></td>
216 <td>value of the green channel, between 0 and <code class="literal">1</code>.0</td>
217 </tr>
218 <tr>
219 <td><p><span class="term"><em class="parameter"><code>blue</code></em> :</span></p></td>
220 <td>value of the blue channel, between 0 and <code class="literal">1</code>.0</td>
221 </tr>
222 <tr>
223 <td><p><span class="term"><em class="parameter"><code>alpha</code></em> :</span></p></td>
224 <td>value of the alpha channel, between 0 and <code class="literal">1</code>.0</td>
225 </tr>
226 </tbody>
227 </table></div>
228 <p class="since">Since 1.4</p>
229 </div>
230 <hr>
231 <div class="refsect2">
232 <a name="cogl-color-init-from-4fv"></a><h3>cogl_color_init_from_4fv ()</h3>
233 <pre class="programlisting"><span class="returnvalue">void</span>                cogl_color_init_from_4fv            (<em class="parameter"><code><a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>,
234                                                          <em class="parameter"><code><span class="type">float</span> *color_array</code></em>);</pre>
235 <p>
236 Sets the values of the passed channels into a <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a>
237 </p>
238 <div class="variablelist"><table border="0">
239 <col align="left" valign="top">
240 <tbody>
241 <tr>
242 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
243 <td>A pointer to a <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> to initialize</td>
244 </tr>
245 <tr>
246 <td><p><span class="term"><em class="parameter"><code>color_array</code></em> :</span></p></td>
247 <td>a pointer to an array of 4 float color components</td>
248 </tr>
249 </tbody>
250 </table></div>
251 <p class="since">Since 1.4</p>
252 </div>
253 <hr>
254 <div class="refsect2">
255 <a name="cogl-color-init-from-4ub"></a><h3>cogl_color_init_from_4ub ()</h3>
256 <pre class="programlisting"><span class="returnvalue">void</span>                cogl_color_init_from_4ub            (<em class="parameter"><code><a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>,
257                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> red</code></em>,
258                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> green</code></em>,
259                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> blue</code></em>,
260                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> alpha</code></em>);</pre>
261 <p>
262 Sets the values of the passed channels into a <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a>.
263 </p>
264 <div class="variablelist"><table border="0">
265 <col align="left" valign="top">
266 <tbody>
267 <tr>
268 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
269 <td>A pointer to a <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> to initialize</td>
270 </tr>
271 <tr>
272 <td><p><span class="term"><em class="parameter"><code>red</code></em> :</span></p></td>
273 <td>value of the red channel, between 0 and 255</td>
274 </tr>
275 <tr>
276 <td><p><span class="term"><em class="parameter"><code>green</code></em> :</span></p></td>
277 <td>value of the green channel, between 0 and 255</td>
278 </tr>
279 <tr>
280 <td><p><span class="term"><em class="parameter"><code>blue</code></em> :</span></p></td>
281 <td>value of the blue channel, between 0 and 255</td>
282 </tr>
283 <tr>
284 <td><p><span class="term"><em class="parameter"><code>alpha</code></em> :</span></p></td>
285 <td>value of the alpha channel, between 0 and 255</td>
286 </tr>
287 </tbody>
288 </table></div>
289 <p class="since">Since 1.4</p>
290 </div>
291 <hr>
292 <div class="refsect2">
293 <a name="cogl-color-set-from-4ub"></a><h3>cogl_color_set_from_4ub ()</h3>
294 <pre class="programlisting"><span class="returnvalue">void</span>                cogl_color_set_from_4ub             (<em class="parameter"><code><a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>,
295                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> red</code></em>,
296                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> green</code></em>,
297                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> blue</code></em>,
298                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"><span class="type">guint8</span></a> alpha</code></em>);</pre>
299 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
300 <h3 class="title">Warning</h3>
301 <p><code class="literal">cogl_color_set_from_4ub</code> has been deprecated since version 1.4 and should not be used in newly-written code. Use cogl_color_init_from_4ub instead.</p>
302 </div>
303 <p>
304 Sets the values of the passed channels into a <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a>.
305 </p>
306 <div class="variablelist"><table border="0">
307 <col align="left" valign="top">
308 <tbody>
309 <tr>
310 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
311 <td>A pointer to a <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> to initialize</td>
312 </tr>
313 <tr>
314 <td><p><span class="term"><em class="parameter"><code>red</code></em> :</span></p></td>
315 <td>value of the red channel, between 0 and 255</td>
316 </tr>
317 <tr>
318 <td><p><span class="term"><em class="parameter"><code>green</code></em> :</span></p></td>
319 <td>value of the green channel, between 0 and 255</td>
320 </tr>
321 <tr>
322 <td><p><span class="term"><em class="parameter"><code>blue</code></em> :</span></p></td>
323 <td>value of the blue channel, between 0 and 255</td>
324 </tr>
325 <tr>
326 <td><p><span class="term"><em class="parameter"><code>alpha</code></em> :</span></p></td>
327 <td>value of the alpha channel, between 0 and 255</td>
328 </tr>
329 </tbody>
330 </table></div>
331 <p class="since">Since 1.0</p>
332 </div>
333 <hr>
334 <div class="refsect2">
335 <a name="cogl-color-set-from-4f"></a><h3>cogl_color_set_from_4f ()</h3>
336 <pre class="programlisting"><span class="returnvalue">void</span>                cogl_color_set_from_4f              (<em class="parameter"><code><a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>,
337                                                          <em class="parameter"><code><span class="type">float</span> red</code></em>,
338                                                          <em class="parameter"><code><span class="type">float</span> green</code></em>,
339                                                          <em class="parameter"><code><span class="type">float</span> blue</code></em>,
340                                                          <em class="parameter"><code><span class="type">float</span> alpha</code></em>);</pre>
341 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
342 <h3 class="title">Warning</h3>
343 <p><code class="literal">cogl_color_set_from_4f</code> has been deprecated since version 1.4 and should not be used in newly-written code. Use cogl_color_init_from_4f instead.</p>
344 </div>
345 <p>
346 Sets the values of the passed channels into a <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a>
347 </p>
348 <div class="variablelist"><table border="0">
349 <col align="left" valign="top">
350 <tbody>
351 <tr>
352 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
353 <td>A pointer to a <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> to initialize</td>
354 </tr>
355 <tr>
356 <td><p><span class="term"><em class="parameter"><code>red</code></em> :</span></p></td>
357 <td>value of the red channel, between 0 and <code class="literal">1</code>.0</td>
358 </tr>
359 <tr>
360 <td><p><span class="term"><em class="parameter"><code>green</code></em> :</span></p></td>
361 <td>value of the green channel, between 0 and <code class="literal">1</code>.0</td>
362 </tr>
363 <tr>
364 <td><p><span class="term"><em class="parameter"><code>blue</code></em> :</span></p></td>
365 <td>value of the blue channel, between 0 and <code class="literal">1</code>.0</td>
366 </tr>
367 <tr>
368 <td><p><span class="term"><em class="parameter"><code>alpha</code></em> :</span></p></td>
369 <td>value of the alpha channel, between 0 and <code class="literal">1</code>.0</td>
370 </tr>
371 </tbody>
372 </table></div>
373 <p class="since">Since 1.0</p>
374 </div>
375 <hr>
376 <div class="refsect2">
377 <a name="cogl-color-get-red"></a><h3>cogl_color_get_red ()</h3>
378 <pre class="programlisting"><span class="returnvalue">float</span>               cogl_color_get_red                  (<em class="parameter"><code>const <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>);</pre>
379 <p>
380 Retrieves the red channel of <em class="parameter"><code>color</code></em> as a fixed point
381 value between 0 and <code class="literal">1</code>.0.
382 </p>
383 <div class="variablelist"><table border="0">
384 <col align="left" valign="top">
385 <tbody>
386 <tr>
387 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
388 <td>a <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a>
389 </td>
390 </tr>
391 <tr>
392 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
393 <td>the red channel of the passed color</td>
394 </tr>
395 </tbody>
396 </table></div>
397 <p class="since">Since 1.0</p>
398 </div>
399 <hr>
400 <div class="refsect2">
401 <a name="cogl-color-get-green"></a><h3>cogl_color_get_green ()</h3>
402 <pre class="programlisting"><span class="returnvalue">float</span>               cogl_color_get_green                (<em class="parameter"><code>const <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>);</pre>
403 <p>
404 Retrieves the green channel of <em class="parameter"><code>color</code></em> as a fixed point
405 value between 0 and <code class="literal">1</code>.0.
406 </p>
407 <div class="variablelist"><table border="0">
408 <col align="left" valign="top">
409 <tbody>
410 <tr>
411 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
412 <td>a <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a>
413 </td>
414 </tr>
415 <tr>
416 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
417 <td>the green channel of the passed color</td>
418 </tr>
419 </tbody>
420 </table></div>
421 <p class="since">Since 1.0</p>
422 </div>
423 <hr>
424 <div class="refsect2">
425 <a name="cogl-color-get-blue"></a><h3>cogl_color_get_blue ()</h3>
426 <pre class="programlisting"><span class="returnvalue">float</span>               cogl_color_get_blue                 (<em class="parameter"><code>const <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>);</pre>
427 <p>
428 Retrieves the blue channel of <em class="parameter"><code>color</code></em> as a fixed point
429 value between 0 and <code class="literal">1</code>.0.
430 </p>
431 <div class="variablelist"><table border="0">
432 <col align="left" valign="top">
433 <tbody>
434 <tr>
435 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
436 <td>a <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a>
437 </td>
438 </tr>
439 <tr>
440 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
441 <td>the blue channel of the passed color</td>
442 </tr>
443 </tbody>
444 </table></div>
445 <p class="since">Since 1.0</p>
446 </div>
447 <hr>
448 <div class="refsect2">
449 <a name="cogl-color-get-alpha"></a><h3>cogl_color_get_alpha ()</h3>
450 <pre class="programlisting"><span class="returnvalue">float</span>               cogl_color_get_alpha                (<em class="parameter"><code>const <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>);</pre>
451 <p>
452 Retrieves the alpha channel of <em class="parameter"><code>color</code></em> as a fixed point
453 value between 0 and <code class="literal">1</code>.0.
454 </p>
455 <div class="variablelist"><table border="0">
456 <col align="left" valign="top">
457 <tbody>
458 <tr>
459 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
460 <td>a <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a>
461 </td>
462 </tr>
463 <tr>
464 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
465 <td>the alpha channel of the passed color</td>
466 </tr>
467 </tbody>
468 </table></div>
469 <p class="since">Since 1.0</p>
470 </div>
471 <hr>
472 <div class="refsect2">
473 <a name="cogl-color-get-red-byte"></a><h3>cogl_color_get_red_byte ()</h3>
474 <pre class="programlisting">unsigned <span class="returnvalue">char</span>       cogl_color_get_red_byte             (<em class="parameter"><code>const <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>);</pre>
475 <p>
476 Retrieves the red channel of <em class="parameter"><code>color</code></em> as a byte value
477 between 0 and 255
478 </p>
479 <div class="variablelist"><table border="0">
480 <col align="left" valign="top">
481 <tbody>
482 <tr>
483 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
484 <td>a <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a>
485 </td>
486 </tr>
487 <tr>
488 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
489 <td>the red channel of the passed color</td>
490 </tr>
491 </tbody>
492 </table></div>
493 <p class="since">Since 1.0</p>
494 </div>
495 <hr>
496 <div class="refsect2">
497 <a name="cogl-color-get-green-byte"></a><h3>cogl_color_get_green_byte ()</h3>
498 <pre class="programlisting">unsigned <span class="returnvalue">char</span>       cogl_color_get_green_byte           (<em class="parameter"><code>const <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>);</pre>
499 <p>
500 Retrieves the green channel of <em class="parameter"><code>color</code></em> as a byte value
501 between 0 and 255
502 </p>
503 <div class="variablelist"><table border="0">
504 <col align="left" valign="top">
505 <tbody>
506 <tr>
507 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
508 <td>a <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a>
509 </td>
510 </tr>
511 <tr>
512 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
513 <td>the green channel of the passed color</td>
514 </tr>
515 </tbody>
516 </table></div>
517 <p class="since">Since 1.0</p>
518 </div>
519 <hr>
520 <div class="refsect2">
521 <a name="cogl-color-get-blue-byte"></a><h3>cogl_color_get_blue_byte ()</h3>
522 <pre class="programlisting">unsigned <span class="returnvalue">char</span>       cogl_color_get_blue_byte            (<em class="parameter"><code>const <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>);</pre>
523 <p>
524 Retrieves the blue channel of <em class="parameter"><code>color</code></em> as a byte value
525 between 0 and 255
526 </p>
527 <div class="variablelist"><table border="0">
528 <col align="left" valign="top">
529 <tbody>
530 <tr>
531 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
532 <td>a <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a>
533 </td>
534 </tr>
535 <tr>
536 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
537 <td>the blue channel of the passed color</td>
538 </tr>
539 </tbody>
540 </table></div>
541 <p class="since">Since 1.0</p>
542 </div>
543 <hr>
544 <div class="refsect2">
545 <a name="cogl-color-get-alpha-byte"></a><h3>cogl_color_get_alpha_byte ()</h3>
546 <pre class="programlisting">unsigned <span class="returnvalue">char</span>       cogl_color_get_alpha_byte           (<em class="parameter"><code>const <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>);</pre>
547 <p>
548 Retrieves the alpha channel of <em class="parameter"><code>color</code></em> as a byte value
549 between 0 and 255
550 </p>
551 <div class="variablelist"><table border="0">
552 <col align="left" valign="top">
553 <tbody>
554 <tr>
555 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
556 <td>a <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a>
557 </td>
558 </tr>
559 <tr>
560 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
561 <td>the alpha channel of the passed color</td>
562 </tr>
563 </tbody>
564 </table></div>
565 <p class="since">Since 1.0</p>
566 </div>
567 <hr>
568 <div class="refsect2">
569 <a name="cogl-color-get-red-float"></a><h3>cogl_color_get_red_float ()</h3>
570 <pre class="programlisting"><span class="returnvalue">float</span>               cogl_color_get_red_float            (<em class="parameter"><code>const <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>);</pre>
571 <p>
572 Retrieves the red channel of <em class="parameter"><code>color</code></em> as a floating point
573 value between 0.0 and 1.0
574 </p>
575 <div class="variablelist"><table border="0">
576 <col align="left" valign="top">
577 <tbody>
578 <tr>
579 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
580 <td>a <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a>
581 </td>
582 </tr>
583 <tr>
584 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
585 <td>the red channel of the passed color</td>
586 </tr>
587 </tbody>
588 </table></div>
589 <p class="since">Since 1.0</p>
590 </div>
591 <hr>
592 <div class="refsect2">
593 <a name="cogl-color-get-green-float"></a><h3>cogl_color_get_green_float ()</h3>
594 <pre class="programlisting"><span class="returnvalue">float</span>               cogl_color_get_green_float          (<em class="parameter"><code>const <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>);</pre>
595 <p>
596 Retrieves the green channel of <em class="parameter"><code>color</code></em> as a floating point
597 value between 0.0 and 1.0
598 </p>
599 <div class="variablelist"><table border="0">
600 <col align="left" valign="top">
601 <tbody>
602 <tr>
603 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
604 <td>a <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a>
605 </td>
606 </tr>
607 <tr>
608 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
609 <td>the green channel of the passed color</td>
610 </tr>
611 </tbody>
612 </table></div>
613 <p class="since">Since 1.0</p>
614 </div>
615 <hr>
616 <div class="refsect2">
617 <a name="cogl-color-get-blue-float"></a><h3>cogl_color_get_blue_float ()</h3>
618 <pre class="programlisting"><span class="returnvalue">float</span>               cogl_color_get_blue_float           (<em class="parameter"><code>const <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>);</pre>
619 <p>
620 Retrieves the blue channel of <em class="parameter"><code>color</code></em> as a floating point
621 value between 0.0 and 1.0
622 </p>
623 <div class="variablelist"><table border="0">
624 <col align="left" valign="top">
625 <tbody>
626 <tr>
627 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
628 <td>a <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a>
629 </td>
630 </tr>
631 <tr>
632 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
633 <td>the blue channel of the passed color</td>
634 </tr>
635 </tbody>
636 </table></div>
637 <p class="since">Since 1.0</p>
638 </div>
639 <hr>
640 <div class="refsect2">
641 <a name="cogl-color-get-alpha-float"></a><h3>cogl_color_get_alpha_float ()</h3>
642 <pre class="programlisting"><span class="returnvalue">float</span>               cogl_color_get_alpha_float          (<em class="parameter"><code>const <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>);</pre>
643 <p>
644 Retrieves the alpha channel of <em class="parameter"><code>color</code></em> as a floating point
645 value between 0.0 and 1.0
646 </p>
647 <div class="variablelist"><table border="0">
648 <col align="left" valign="top">
649 <tbody>
650 <tr>
651 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
652 <td>a <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a>
653 </td>
654 </tr>
655 <tr>
656 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
657 <td>the alpha channel of the passed color</td>
658 </tr>
659 </tbody>
660 </table></div>
661 <p class="since">Since 1.0</p>
662 </div>
663 <hr>
664 <div class="refsect2">
665 <a name="cogl-color-set-red"></a><h3>cogl_color_set_red ()</h3>
666 <pre class="programlisting"><span class="returnvalue">void</span>                cogl_color_set_red                  (<em class="parameter"><code><a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>,
667                                                          <em class="parameter"><code><span class="type">float</span> red</code></em>);</pre>
668 <p>
669 Sets the red channel of <em class="parameter"><code>color</code></em> to <em class="parameter"><code>red</code></em>.
670 </p>
671 <div class="variablelist"><table border="0">
672 <col align="left" valign="top">
673 <tbody>
674 <tr>
675 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
676 <td>a <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a>
677 </td>
678 </tr>
679 <tr>
680 <td><p><span class="term"><em class="parameter"><code>red</code></em> :</span></p></td>
681 <td>a float value between 0.0f and 1.0f</td>
682 </tr>
683 </tbody>
684 </table></div>
685 <p class="since">Since 1.4</p>
686 </div>
687 <hr>
688 <div class="refsect2">
689 <a name="cogl-color-set-green"></a><h3>cogl_color_set_green ()</h3>
690 <pre class="programlisting"><span class="returnvalue">void</span>                cogl_color_set_green                (<em class="parameter"><code><a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>,
691                                                          <em class="parameter"><code><span class="type">float</span> green</code></em>);</pre>
692 <p>
693 Sets the green channel of <em class="parameter"><code>color</code></em> to <em class="parameter"><code>green</code></em>.
694 </p>
695 <div class="variablelist"><table border="0">
696 <col align="left" valign="top">
697 <tbody>
698 <tr>
699 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
700 <td>a <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a>
701 </td>
702 </tr>
703 <tr>
704 <td><p><span class="term"><em class="parameter"><code>green</code></em> :</span></p></td>
705 <td>a float value between 0.0f and 1.0f</td>
706 </tr>
707 </tbody>
708 </table></div>
709 <p class="since">Since 1.4</p>
710 </div>
711 <hr>
712 <div class="refsect2">
713 <a name="cogl-color-set-blue"></a><h3>cogl_color_set_blue ()</h3>
714 <pre class="programlisting"><span class="returnvalue">void</span>                cogl_color_set_blue                 (<em class="parameter"><code><a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>,
715                                                          <em class="parameter"><code><span class="type">float</span> blue</code></em>);</pre>
716 <p>
717 Sets the blue channel of <em class="parameter"><code>color</code></em> to <em class="parameter"><code>blue</code></em>.
718 </p>
719 <div class="variablelist"><table border="0">
720 <col align="left" valign="top">
721 <tbody>
722 <tr>
723 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
724 <td>a <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a>
725 </td>
726 </tr>
727 <tr>
728 <td><p><span class="term"><em class="parameter"><code>blue</code></em> :</span></p></td>
729 <td>a float value between 0.0f and 1.0f</td>
730 </tr>
731 </tbody>
732 </table></div>
733 <p class="since">Since 1.4</p>
734 </div>
735 <hr>
736 <div class="refsect2">
737 <a name="cogl-color-set-alpha"></a><h3>cogl_color_set_alpha ()</h3>
738 <pre class="programlisting"><span class="returnvalue">void</span>                cogl_color_set_alpha                (<em class="parameter"><code><a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>,
739                                                          <em class="parameter"><code><span class="type">float</span> alpha</code></em>);</pre>
740 <p>
741 Sets the alpha channel of <em class="parameter"><code>color</code></em> to <em class="parameter"><code>alpha</code></em>.
742 </p>
743 <div class="variablelist"><table border="0">
744 <col align="left" valign="top">
745 <tbody>
746 <tr>
747 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
748 <td>a <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a>
749 </td>
750 </tr>
751 <tr>
752 <td><p><span class="term"><em class="parameter"><code>alpha</code></em> :</span></p></td>
753 <td>a float value between 0.0f and 1.0f</td>
754 </tr>
755 </tbody>
756 </table></div>
757 <p class="since">Since 1.4</p>
758 </div>
759 <hr>
760 <div class="refsect2">
761 <a name="cogl-color-set-red-byte"></a><h3>cogl_color_set_red_byte ()</h3>
762 <pre class="programlisting"><span class="returnvalue">void</span>                cogl_color_set_red_byte             (<em class="parameter"><code><a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>,
763                                                          <em class="parameter"><code>unsigned <span class="type">char</span> red</code></em>);</pre>
764 <p>
765 Sets the red channel of <em class="parameter"><code>color</code></em> to <em class="parameter"><code>red</code></em>.
766 </p>
767 <div class="variablelist"><table border="0">
768 <col align="left" valign="top">
769 <tbody>
770 <tr>
771 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
772 <td>a <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a>
773 </td>
774 </tr>
775 <tr>
776 <td><p><span class="term"><em class="parameter"><code>red</code></em> :</span></p></td>
777 <td>a byte value between 0 and 255</td>
778 </tr>
779 </tbody>
780 </table></div>
781 <p class="since">Since 1.4</p>
782 </div>
783 <hr>
784 <div class="refsect2">
785 <a name="cogl-color-set-green-byte"></a><h3>cogl_color_set_green_byte ()</h3>
786 <pre class="programlisting"><span class="returnvalue">void</span>                cogl_color_set_green_byte           (<em class="parameter"><code><a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>,
787                                                          <em class="parameter"><code>unsigned <span class="type">char</span> green</code></em>);</pre>
788 <p>
789 Sets the green channel of <em class="parameter"><code>color</code></em> to <em class="parameter"><code>green</code></em>.
790 </p>
791 <div class="variablelist"><table border="0">
792 <col align="left" valign="top">
793 <tbody>
794 <tr>
795 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
796 <td>a <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a>
797 </td>
798 </tr>
799 <tr>
800 <td><p><span class="term"><em class="parameter"><code>green</code></em> :</span></p></td>
801 <td>a byte value between 0 and 255</td>
802 </tr>
803 </tbody>
804 </table></div>
805 <p class="since">Since 1.4</p>
806 </div>
807 <hr>
808 <div class="refsect2">
809 <a name="cogl-color-set-blue-byte"></a><h3>cogl_color_set_blue_byte ()</h3>
810 <pre class="programlisting"><span class="returnvalue">void</span>                cogl_color_set_blue_byte            (<em class="parameter"><code><a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>,
811                                                          <em class="parameter"><code>unsigned <span class="type">char</span> blue</code></em>);</pre>
812 <p>
813 Sets the blue channel of <em class="parameter"><code>color</code></em> to <em class="parameter"><code>blue</code></em>.
814 </p>
815 <div class="variablelist"><table border="0">
816 <col align="left" valign="top">
817 <tbody>
818 <tr>
819 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
820 <td>a <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a>
821 </td>
822 </tr>
823 <tr>
824 <td><p><span class="term"><em class="parameter"><code>blue</code></em> :</span></p></td>
825 <td>a byte value between 0 and 255</td>
826 </tr>
827 </tbody>
828 </table></div>
829 <p class="since">Since 1.4</p>
830 </div>
831 <hr>
832 <div class="refsect2">
833 <a name="cogl-color-set-alpha-byte"></a><h3>cogl_color_set_alpha_byte ()</h3>
834 <pre class="programlisting"><span class="returnvalue">void</span>                cogl_color_set_alpha_byte           (<em class="parameter"><code><a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>,
835                                                          <em class="parameter"><code>unsigned <span class="type">char</span> alpha</code></em>);</pre>
836 <p>
837 Sets the alpha channel of <em class="parameter"><code>color</code></em> to <em class="parameter"><code>alpha</code></em>.
838 </p>
839 <div class="variablelist"><table border="0">
840 <col align="left" valign="top">
841 <tbody>
842 <tr>
843 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
844 <td>a <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a>
845 </td>
846 </tr>
847 <tr>
848 <td><p><span class="term"><em class="parameter"><code>alpha</code></em> :</span></p></td>
849 <td>a byte value between 0 and 255</td>
850 </tr>
851 </tbody>
852 </table></div>
853 <p class="since">Since 1.4</p>
854 </div>
855 <hr>
856 <div class="refsect2">
857 <a name="cogl-color-set-red-float"></a><h3>cogl_color_set_red_float ()</h3>
858 <pre class="programlisting"><span class="returnvalue">void</span>                cogl_color_set_red_float            (<em class="parameter"><code><a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>,
859                                                          <em class="parameter"><code><span class="type">float</span> red</code></em>);</pre>
860 <p>
861 Sets the red channel of <em class="parameter"><code>color</code></em> to <em class="parameter"><code>red</code></em>.
862 </p>
863 <div class="variablelist"><table border="0">
864 <col align="left" valign="top">
865 <tbody>
866 <tr>
867 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
868 <td>a <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a>
869 </td>
870 </tr>
871 <tr>
872 <td><p><span class="term"><em class="parameter"><code>red</code></em> :</span></p></td>
873 <td>a float value between 0.0f and 1.0f</td>
874 </tr>
875 </tbody>
876 </table></div>
877 <p class="since">Since 1.4</p>
878 </div>
879 <hr>
880 <div class="refsect2">
881 <a name="cogl-color-set-green-float"></a><h3>cogl_color_set_green_float ()</h3>
882 <pre class="programlisting"><span class="returnvalue">void</span>                cogl_color_set_green_float          (<em class="parameter"><code><a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>,
883                                                          <em class="parameter"><code><span class="type">float</span> green</code></em>);</pre>
884 <p>
885 Sets the green channel of <em class="parameter"><code>color</code></em> to <em class="parameter"><code>green</code></em>.
886 </p>
887 <div class="variablelist"><table border="0">
888 <col align="left" valign="top">
889 <tbody>
890 <tr>
891 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
892 <td>a <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a>
893 </td>
894 </tr>
895 <tr>
896 <td><p><span class="term"><em class="parameter"><code>green</code></em> :</span></p></td>
897 <td>a float value between 0.0f and 1.0f</td>
898 </tr>
899 </tbody>
900 </table></div>
901 <p class="since">Since 1.4</p>
902 </div>
903 <hr>
904 <div class="refsect2">
905 <a name="cogl-color-set-blue-float"></a><h3>cogl_color_set_blue_float ()</h3>
906 <pre class="programlisting"><span class="returnvalue">void</span>                cogl_color_set_blue_float           (<em class="parameter"><code><a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>,
907                                                          <em class="parameter"><code><span class="type">float</span> blue</code></em>);</pre>
908 <p>
909 Sets the blue channel of <em class="parameter"><code>color</code></em> to <em class="parameter"><code>blue</code></em>.
910 </p>
911 <div class="variablelist"><table border="0">
912 <col align="left" valign="top">
913 <tbody>
914 <tr>
915 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
916 <td>a <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a>
917 </td>
918 </tr>
919 <tr>
920 <td><p><span class="term"><em class="parameter"><code>blue</code></em> :</span></p></td>
921 <td>a float value between 0.0f and 1.0f</td>
922 </tr>
923 </tbody>
924 </table></div>
925 <p class="since">Since 1.4</p>
926 </div>
927 <hr>
928 <div class="refsect2">
929 <a name="cogl-color-set-alpha-float"></a><h3>cogl_color_set_alpha_float ()</h3>
930 <pre class="programlisting"><span class="returnvalue">void</span>                cogl_color_set_alpha_float          (<em class="parameter"><code><a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>,
931                                                          <em class="parameter"><code><span class="type">float</span> alpha</code></em>);</pre>
932 <p>
933 Sets the alpha channel of <em class="parameter"><code>color</code></em> to <em class="parameter"><code>alpha</code></em>.
934 </p>
935 <div class="variablelist"><table border="0">
936 <col align="left" valign="top">
937 <tbody>
938 <tr>
939 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
940 <td>a <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a>
941 </td>
942 </tr>
943 <tr>
944 <td><p><span class="term"><em class="parameter"><code>alpha</code></em> :</span></p></td>
945 <td>a float value between 0.0f and 1.0f</td>
946 </tr>
947 </tbody>
948 </table></div>
949 <p class="since">Since 1.4</p>
950 </div>
951 <hr>
952 <div class="refsect2">
953 <a name="cogl-color-premultiply"></a><h3>cogl_color_premultiply ()</h3>
954 <pre class="programlisting"><span class="returnvalue">void</span>                cogl_color_premultiply              (<em class="parameter"><code><a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>);</pre>
955 <p>
956 Converts a non-premultiplied color to a pre-multiplied color. For
957 example, semi-transparent red is (1.0, 0, 0, 0.5) when non-premultiplied
958 and (0.5, 0, 0, 0.5) when premultiplied.
959 </p>
960 <div class="variablelist"><table border="0">
961 <col align="left" valign="top">
962 <tbody><tr>
963 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
964 <td>the color to premultiply</td>
965 </tr></tbody>
966 </table></div>
967 <p class="since">Since 1.0</p>
968 </div>
969 <hr>
970 <div class="refsect2">
971 <a name="cogl-color-unpremultiply"></a><h3>cogl_color_unpremultiply ()</h3>
972 <pre class="programlisting"><span class="returnvalue">void</span>                cogl_color_unpremultiply            (<em class="parameter"><code><a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a> *color</code></em>);</pre>
973 <p>
974 Converts a pre-multiplied color to a non-premultiplied color. For
975 example, semi-transparent red is (0.5, 0, 0, 0.5) when premultiplied
976 and (1.0, 0, 0, 0.5) when non-premultiplied.
977 </p>
978 <div class="variablelist"><table border="0">
979 <col align="left" valign="top">
980 <tbody><tr>
981 <td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
982 <td>the color to unpremultiply</td>
983 </tr></tbody>
984 </table></div>
985 <p class="since">Since 1.4</p>
986 </div>
987 <hr>
988 <div class="refsect2">
989 <a name="cogl-color-equal"></a><h3>cogl_color_equal ()</h3>
990 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            cogl_color_equal                    (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gconstpointer"><span class="type">gconstpointer</span></a> v1</code></em>,
991                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gconstpointer"><span class="type">gconstpointer</span></a> v2</code></em>);</pre>
992 <p>
993 Compares two <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a>s and checks if they are the same.
994 </p>
995 <p>
996 This function can be passed to <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#g-hash-table-new"><code class="function">g_hash_table_new()</code></a> as the <em class="parameter"><code>key_equal_func</code></em>
997 parameter, when using <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a>s as keys in a <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a>.
998 </p>
999 <div class="variablelist"><table border="0">
1000 <col align="left" valign="top">
1001 <tbody>
1002 <tr>
1003 <td><p><span class="term"><em class="parameter"><code>v1</code></em> :</span></p></td>
1004 <td>a <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a>
1005 </td>
1006 </tr>
1007 <tr>
1008 <td><p><span class="term"><em class="parameter"><code>v2</code></em> :</span></p></td>
1009 <td>a <a class="link" href="cogl-Color-Type.html#CoglColor" title="struct CoglColor"><span class="type">CoglColor</span></a>
1010 </td>
1011 </tr>
1012 <tr>
1013 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1014 <td>
1015 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the two colors are the same.</td>
1016 </tr>
1017 </tbody>
1018 </table></div>
1019 <p class="since">Since 1.0</p>
1020 </div>
1021 </div>
1022 </div>
1023 <div class="footer">
1024 <hr>
1025           Generated by GTK-Doc V1.18.1</div>
1026 </body>
1027 </html>