← Back to branch summary

~oem-solutions-group/unity-2d/clutter-1.0

« back to all changes in this revision

Viewing changes to doc/reference/cogl/html/cogl-Color-Type.html

  • Committer: Bazaar Package Importer
  • Author(s): Emilio Pozuelo Monfort
  • Date: 2010-03-21 13:27:56 UTC
  • mto: (2.1.3 experimental)
  • mto: This revision was merged to the branch mainline in revision 8.
  • Revision ID: james.westby@ubuntu.com-20100321132756-nf8yd30yxo3zzwcm
Tags: upstream-1.2.2
Import upstream version 1.2.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/cogl/html/cogl-Color-Type.html
8
8
<link rel="up" href="ch01.html" title="COGL - GL Abstraction API">
9
9
<link rel="prev" href="cogl-General-API.html" title="General API">
10
10
<link rel="next" href="cogl-Textures.html" title="Textures">
11
 
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.13 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="chapter" href="ch01.html" title="COGL - GL Abstraction API">
14
 
<link rel="index" href="ix01.html" title="Index">
 
14
<link rel="chapter" href="ch02.html" title="COGL experimental API">
 
15
<link rel="index" href="ix01.html" title="Index of all symbols">
 
16
<link rel="index" href="ix02.html" title="Index of deprecated symbols">
 
17
<link rel="index" href="ix03.html" title="Index of new symbols in 0.8">
 
18
<link rel="index" href="ix04.html" title="Index of new symbols in 1.0">
 
19
<link rel="index" href="ix05.html" title="Index of new symbols in 1.2">
15
20
<link rel="appendix" href="license.html" title="Appendix A. License">
16
21
</head>
17
22
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
25
30
</tr>
26
31
<tr><td colspan="5" class="shortcuts">
27
32
<a href="#cogl-Color-Type.synopsis" class="shortcut">Top</a>
28
 
                 | 
29
 
                <a href="#cogl-Color-Type.description" class="shortcut">Description</a>
 
33
                   | 
 
34
                  <a href="#cogl-Color-Type.description" class="shortcut">Description</a>
30
35
</td></tr>
31
36
</table>
32
37
<div class="refentry" title="Color Type">
34
39
<div class="refnamediv"><table width="100%"><tr>
35
40
<td valign="top">
36
41
<h2><span class="refentrytitle"><a name="cogl-Color-Type.top_of_page"></a>Color Type</span></h2>
37
 
<p>Color Type</p>
 
42
<p>Color Type — A generic color definition</p>
38
43
</td>
39
44
<td valign="top" align="right"></td>
40
45
</tr></table></div>
41
46
<div class="refsynopsisdiv" title="Synopsis">
42
47
<a name="cogl-Color-Type.synopsis"></a><h2>Synopsis</h2>
43
 
<pre class="synopsis">
44
 
                    <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor">CoglColor</a>;
45
 
<a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor">CoglColor</a> *         <a class="link" href="cogl-Color-Type.html#cogl-color-new" title="cogl_color_new ()">cogl_color_new</a>                      (void);
46
 
<a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor">CoglColor</a> *         <a class="link" href="cogl-Color-Type.html#cogl-color-copy" title="cogl_color_copy ()">cogl_color_copy</a>                     (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor">CoglColor</a> *color);
47
 
void                <a class="link" href="cogl-Color-Type.html#cogl-color-free" title="cogl_color_free ()">cogl_color_free</a>                     (<a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor">CoglColor</a> *color);
48
 
void                <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>             (<a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor">CoglColor</a> *dest,
49
 
                                                         <a
50
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"
51
 
>guint8</a> red,
52
 
                                                         <a
53
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"
54
 
>guint8</a> green,
55
 
                                                         <a
56
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"
57
 
>guint8</a> blue,
58
 
                                                         <a
59
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"
60
 
>guint8</a> alpha);
61
 
void                <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>              (<a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor">CoglColor</a> *dest,
62
 
                                                         float red,
63
 
                                                         float green,
64
 
                                                         float blue,
65
 
                                                         float alpha);
66
 
 
67
 
float               <a class="link" href="cogl-Color-Type.html#cogl-color-get-red" title="cogl_color_get_red ()">cogl_color_get_red</a>                  (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor">CoglColor</a> *color);
68
 
float               <a class="link" href="cogl-Color-Type.html#cogl-color-get-green" title="cogl_color_get_green ()">cogl_color_get_green</a>                (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor">CoglColor</a> *color);
69
 
float               <a class="link" href="cogl-Color-Type.html#cogl-color-get-blue" title="cogl_color_get_blue ()">cogl_color_get_blue</a>                 (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor">CoglColor</a> *color);
70
 
float               <a class="link" href="cogl-Color-Type.html#cogl-color-get-alpha" title="cogl_color_get_alpha ()">cogl_color_get_alpha</a>                (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor">CoglColor</a> *color);
71
 
 
72
 
unsigned char       <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>             (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor">CoglColor</a> *color);
73
 
unsigned char       <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>           (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor">CoglColor</a> *color);
74
 
unsigned char       <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>            (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor">CoglColor</a> *color);
75
 
unsigned char       <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>           (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor">CoglColor</a> *color);
76
 
 
77
 
float               <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>            (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor">CoglColor</a> *color);
78
 
float               <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>          (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor">CoglColor</a> *color);
79
 
float               <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>           (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor">CoglColor</a> *color);
80
 
float               <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>          (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor">CoglColor</a> *color);
 
48
<pre class="synopsis">                    <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor">CoglColor</a>;
 
49
<a class="link" href="cogl-Color-Type.html#CoglColor" title="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>                      (void);
 
50
<a class="link" href="cogl-Color-Type.html#CoglColor" title="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>                     (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor"><span class="returnvalue">CoglColor</span></a> *color);
 
51
<span class="returnvalue">void</span>                <a class="link" href="cogl-Color-Type.html#cogl-color-free" title="cogl_color_free ()">cogl_color_free</a>                     (<a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor"><span class="returnvalue">CoglColor</span></a> *color);
 
52
<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>             (<a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor"><span class="returnvalue">CoglColor</span></a> *dest,
 
53
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"><span class="returnvalue">guint8</span></a> red,
 
54
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"><span class="returnvalue">guint8</span></a> green,
 
55
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"><span class="returnvalue">guint8</span></a> blue,
 
56
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"><span class="returnvalue">guint8</span></a> alpha);
 
57
<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>              (<a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor"><span class="returnvalue">CoglColor</span></a> *dest,
 
58
                                                         <span class="returnvalue">float</span> red,
 
59
                                                         <span class="returnvalue">float</span> green,
 
60
                                                         <span class="returnvalue">float</span> blue,
 
61
                                                         <span class="returnvalue">float</span> alpha);
 
62
 
 
63
<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>                  (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor"><span class="returnvalue">CoglColor</span></a> *color);
 
64
<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>                (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor"><span class="returnvalue">CoglColor</span></a> *color);
 
65
<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>                 (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor"><span class="returnvalue">CoglColor</span></a> *color);
 
66
<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>                (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor"><span class="returnvalue">CoglColor</span></a> *color);
 
67
 
 
68
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>             (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor"><span class="returnvalue">CoglColor</span></a> *color);
 
69
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>           (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor"><span class="returnvalue">CoglColor</span></a> *color);
 
70
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>            (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor"><span class="returnvalue">CoglColor</span></a> *color);
 
71
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>           (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor"><span class="returnvalue">CoglColor</span></a> *color);
 
72
 
 
73
<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>            (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor"><span class="returnvalue">CoglColor</span></a> *color);
 
74
<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>          (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor"><span class="returnvalue">CoglColor</span></a> *color);
 
75
<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>           (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor"><span class="returnvalue">CoglColor</span></a> *color);
 
76
<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>          (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor"><span class="returnvalue">CoglColor</span></a> *color);
 
77
 
 
78
<span class="returnvalue">void</span>                <a class="link" href="cogl-Color-Type.html#cogl-color-premultiply" title="cogl_color_premultiply ()">cogl_color_premultiply</a>              (<a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor"><span class="returnvalue">CoglColor</span></a> *color);
 
79
<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>                    (<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gconstpointer"><span class="returnvalue">gconstpointer</span></a> v1,
 
80
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gconstpointer"><span class="returnvalue">gconstpointer</span></a> v2);
81
81
</pre>
82
82
</div>
83
83
<div class="refsect1" title="Description">
84
84
<a name="cogl-Color-Type.description"></a><h2>Description</h2>
85
85
<p>
86
 
</p>
 
86
<a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor"><span class="type">CoglColor</span></a> is a simple structure holding the definition of a color such
 
87
that it can be efficiently used by GL</p>
87
88
</div>
88
89
<div class="refsect1" title="Details">
89
90
<a name="cogl-Color-Type.details"></a><h2>Details</h2>
96
97
A structure for holding a color definition. The contents of
97
98
the CoglColor structure are private and should never by accessed
98
99
directly.</p>
99
 
<p>
100
 
</p>
101
100
<p class="since">Since 1.0</p>
102
101
</div>
103
102
<hr>
104
103
<div class="refsect2" title="cogl_color_new ()">
105
104
<a name="cogl-color-new"></a><h3>cogl_color_new ()</h3>
106
 
<pre class="programlisting"><a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor">CoglColor</a> *         cogl_color_new                      (void);</pre>
 
105
<pre class="programlisting"><a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor"><span class="returnvalue">CoglColor</span></a> *         cogl_color_new                      (void);</pre>
107
106
<p>
108
 
</p>
 
107
Creates a new (empty) color</p>
109
108
<div class="variablelist"><table border="0">
110
109
<col align="left" valign="top">
111
110
<tbody><tr>
112
111
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
113
 
<td>
 
112
<td> a newly-allocated <a class="link" href="cogl-Color-Type.html#CoglColor" title="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>
 
113
  to free the allocated resources
 
114
 
114
115
</td>
115
116
</tr></tbody>
116
117
</table></div>
 
118
<p class="since">Since 1.0</p>
117
119
</div>
118
120
<hr>
119
121
<div class="refsect2" title="cogl_color_copy ()">
120
122
<a name="cogl-color-copy"></a><h3>cogl_color_copy ()</h3>
121
 
<pre class="programlisting"><a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor">CoglColor</a> *         cogl_color_copy                     (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor">CoglColor</a> *color);</pre>
 
123
<pre class="programlisting"><a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor"><span class="returnvalue">CoglColor</span></a> *         cogl_color_copy                     (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor"><span class="returnvalue">CoglColor</span></a> *color);</pre>
122
124
<p>
123
 
</p>
 
125
Creates a copy of <em class="parameter"><code>color</code></em></p>
124
126
<div class="variablelist"><table border="0">
125
127
<col align="left" valign="top">
126
128
<tbody>
127
129
<tr>
128
130
<td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
129
 
<td>
 
131
<td> the color to copy
130
132
</td>
131
133
</tr>
132
134
<tr>
133
135
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
134
 
<td>
 
136
<td> a newly-allocated <a class="link" href="cogl-Color-Type.html#CoglColor" title="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>
 
137
  to free the allocate resources
 
138
 
135
139
</td>
136
140
</tr>
137
141
</tbody>
138
142
</table></div>
 
143
<p class="since">Since 1.0</p>
139
144
</div>
140
145
<hr>
141
146
<div class="refsect2" title="cogl_color_free ()">
142
147
<a name="cogl-color-free"></a><h3>cogl_color_free ()</h3>
143
 
<pre class="programlisting">void                cogl_color_free                     (<a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor">CoglColor</a> *color);</pre>
 
148
<pre class="programlisting"><span class="returnvalue">void</span>                cogl_color_free                     (<a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor"><span class="returnvalue">CoglColor</span></a> *color);</pre>
144
149
<p>
145
 
</p>
 
150
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></p>
146
151
<div class="variablelist"><table border="0">
147
152
<col align="left" valign="top">
148
153
<tbody><tr>
149
154
<td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
150
 
<td>
 
155
<td> the color to free
151
156
</td>
152
157
</tr></tbody>
153
158
</table></div>
 
159
<p class="since">Since 1.0</p>
154
160
</div>
155
161
<hr>
156
162
<div class="refsect2" title="cogl_color_set_from_4ub ()">
157
163
<a name="cogl-color-set-from-4ub"></a><h3>cogl_color_set_from_4ub ()</h3>
158
 
<pre class="programlisting">void                cogl_color_set_from_4ub             (<a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor">CoglColor</a> *dest,
159
 
                                                         <a
160
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"
161
 
>guint8</a> red,
162
 
                                                         <a
163
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"
164
 
>guint8</a> green,
165
 
                                                         <a
166
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"
167
 
>guint8</a> blue,
168
 
                                                         <a
169
 
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"
170
 
>guint8</a> alpha);</pre>
 
164
<pre class="programlisting"><span class="returnvalue">void</span>                cogl_color_set_from_4ub             (<a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor"><span class="returnvalue">CoglColor</span></a> *dest,
 
165
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"><span class="returnvalue">guint8</span></a> red,
 
166
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"><span class="returnvalue">guint8</span></a> green,
 
167
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"><span class="returnvalue">guint8</span></a> blue,
 
168
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"><span class="returnvalue">guint8</span></a> alpha);</pre>
171
169
<p>
172
170
Sets the values of the passed channels into a <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor"><span class="type">CoglColor</span></a>.</p>
173
 
<p>
174
 
</p>
175
171
<div class="variablelist"><table border="0">
176
172
<col align="left" valign="top">
177
173
<tbody>
207
203
<hr>
208
204
<div class="refsect2" title="cogl_color_set_from_4f ()">
209
205
<a name="cogl-color-set-from-4f"></a><h3>cogl_color_set_from_4f ()</h3>
210
 
<pre class="programlisting">void                cogl_color_set_from_4f              (<a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor">CoglColor</a> *dest,
211
 
                                                         float red,
212
 
                                                         float green,
213
 
                                                         float blue,
214
 
                                                         float alpha);</pre>
 
206
<pre class="programlisting"><span class="returnvalue">void</span>                cogl_color_set_from_4f              (<a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor"><span class="returnvalue">CoglColor</span></a> *dest,
 
207
                                                         <span class="returnvalue">float</span> red,
 
208
                                                         <span class="returnvalue">float</span> green,
 
209
                                                         <span class="returnvalue">float</span> blue,
 
210
                                                         <span class="returnvalue">float</span> alpha);</pre>
215
211
<p>
216
212
Sets the values of the passed channels into a <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor"><span class="type">CoglColor</span></a></p>
217
 
<p>
218
 
</p>
219
213
<div class="variablelist"><table border="0">
220
214
<col align="left" valign="top">
221
215
<tbody>
251
245
<hr>
252
246
<div class="refsect2" title="cogl_color_get_red ()">
253
247
<a name="cogl-color-get-red"></a><h3>cogl_color_get_red ()</h3>
254
 
<pre class="programlisting">float               cogl_color_get_red                  (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor">CoglColor</a> *color);</pre>
 
248
<pre class="programlisting"><span class="returnvalue">float</span>               cogl_color_get_red                  (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor"><span class="returnvalue">CoglColor</span></a> *color);</pre>
255
249
<p>
256
250
Retrieves the red channel of <em class="parameter"><code>color</code></em> as a fixed point
257
251
value between 0 and <code class="literal">1</code>.0.</p>
258
 
<p>
259
 
</p>
260
252
<div class="variablelist"><table border="0">
261
253
<col align="left" valign="top">
262
254
<tbody>
278
270
<hr>
279
271
<div class="refsect2" title="cogl_color_get_green ()">
280
272
<a name="cogl-color-get-green"></a><h3>cogl_color_get_green ()</h3>
281
 
<pre class="programlisting">float               cogl_color_get_green                (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor">CoglColor</a> *color);</pre>
 
273
<pre class="programlisting"><span class="returnvalue">float</span>               cogl_color_get_green                (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor"><span class="returnvalue">CoglColor</span></a> *color);</pre>
282
274
<p>
283
275
Retrieves the green channel of <em class="parameter"><code>color</code></em> as a fixed point
284
276
value between 0 and <code class="literal">1</code>.0.</p>
285
 
<p>
286
 
</p>
287
277
<div class="variablelist"><table border="0">
288
278
<col align="left" valign="top">
289
279
<tbody>
305
295
<hr>
306
296
<div class="refsect2" title="cogl_color_get_blue ()">
307
297
<a name="cogl-color-get-blue"></a><h3>cogl_color_get_blue ()</h3>
308
 
<pre class="programlisting">float               cogl_color_get_blue                 (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor">CoglColor</a> *color);</pre>
 
298
<pre class="programlisting"><span class="returnvalue">float</span>               cogl_color_get_blue                 (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor"><span class="returnvalue">CoglColor</span></a> *color);</pre>
309
299
<p>
310
300
Retrieves the blue channel of <em class="parameter"><code>color</code></em> as a fixed point
311
301
value between 0 and <code class="literal">1</code>.0.</p>
312
 
<p>
313
 
</p>
314
302
<div class="variablelist"><table border="0">
315
303
<col align="left" valign="top">
316
304
<tbody>
332
320
<hr>
333
321
<div class="refsect2" title="cogl_color_get_alpha ()">
334
322
<a name="cogl-color-get-alpha"></a><h3>cogl_color_get_alpha ()</h3>
335
 
<pre class="programlisting">float               cogl_color_get_alpha                (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor">CoglColor</a> *color);</pre>
 
323
<pre class="programlisting"><span class="returnvalue">float</span>               cogl_color_get_alpha                (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor"><span class="returnvalue">CoglColor</span></a> *color);</pre>
336
324
<p>
337
325
Retrieves the alpha channel of <em class="parameter"><code>color</code></em> as a fixed point
338
326
value between 0 and <code class="literal">1</code>.0.</p>
339
 
<p>
340
 
</p>
341
327
<div class="variablelist"><table border="0">
342
328
<col align="left" valign="top">
343
329
<tbody>
359
345
<hr>
360
346
<div class="refsect2" title="cogl_color_get_red_byte ()">
361
347
<a name="cogl-color-get-red-byte"></a><h3>cogl_color_get_red_byte ()</h3>
362
 
<pre class="programlisting">unsigned char       cogl_color_get_red_byte             (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor">CoglColor</a> *color);</pre>
 
348
<pre class="programlisting">unsigned <span class="returnvalue">char</span>       cogl_color_get_red_byte             (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor"><span class="returnvalue">CoglColor</span></a> *color);</pre>
363
349
<p>
364
350
Retrieves the red channel of <em class="parameter"><code>color</code></em> as a byte value
365
351
between 0 and 255</p>
366
 
<p>
367
 
</p>
368
352
<div class="variablelist"><table border="0">
369
353
<col align="left" valign="top">
370
354
<tbody>
386
370
<hr>
387
371
<div class="refsect2" title="cogl_color_get_green_byte ()">
388
372
<a name="cogl-color-get-green-byte"></a><h3>cogl_color_get_green_byte ()</h3>
389
 
<pre class="programlisting">unsigned char       cogl_color_get_green_byte           (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor">CoglColor</a> *color);</pre>
 
373
<pre class="programlisting">unsigned <span class="returnvalue">char</span>       cogl_color_get_green_byte           (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor"><span class="returnvalue">CoglColor</span></a> *color);</pre>
390
374
<p>
391
375
Retrieves the green channel of <em class="parameter"><code>color</code></em> as a byte value
392
376
between 0 and 255</p>
393
 
<p>
394
 
</p>
395
377
<div class="variablelist"><table border="0">
396
378
<col align="left" valign="top">
397
379
<tbody>
413
395
<hr>
414
396
<div class="refsect2" title="cogl_color_get_blue_byte ()">
415
397
<a name="cogl-color-get-blue-byte"></a><h3>cogl_color_get_blue_byte ()</h3>
416
 
<pre class="programlisting">unsigned char       cogl_color_get_blue_byte            (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor">CoglColor</a> *color);</pre>
 
398
<pre class="programlisting">unsigned <span class="returnvalue">char</span>       cogl_color_get_blue_byte            (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor"><span class="returnvalue">CoglColor</span></a> *color);</pre>
417
399
<p>
418
400
Retrieves the blue channel of <em class="parameter"><code>color</code></em> as a byte value
419
401
between 0 and 255</p>
420
 
<p>
421
 
</p>
422
402
<div class="variablelist"><table border="0">
423
403
<col align="left" valign="top">
424
404
<tbody>
440
420
<hr>
441
421
<div class="refsect2" title="cogl_color_get_alpha_byte ()">
442
422
<a name="cogl-color-get-alpha-byte"></a><h3>cogl_color_get_alpha_byte ()</h3>
443
 
<pre class="programlisting">unsigned char       cogl_color_get_alpha_byte           (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor">CoglColor</a> *color);</pre>
 
423
<pre class="programlisting">unsigned <span class="returnvalue">char</span>       cogl_color_get_alpha_byte           (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor"><span class="returnvalue">CoglColor</span></a> *color);</pre>
444
424
<p>
445
425
Retrieves the alpha channel of <em class="parameter"><code>color</code></em> as a byte value
446
426
between 0 and 255</p>
447
 
<p>
448
 
</p>
449
427
<div class="variablelist"><table border="0">
450
428
<col align="left" valign="top">
451
429
<tbody>
467
445
<hr>
468
446
<div class="refsect2" title="cogl_color_get_red_float ()">
469
447
<a name="cogl-color-get-red-float"></a><h3>cogl_color_get_red_float ()</h3>
470
 
<pre class="programlisting">float               cogl_color_get_red_float            (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor">CoglColor</a> *color);</pre>
 
448
<pre class="programlisting"><span class="returnvalue">float</span>               cogl_color_get_red_float            (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor"><span class="returnvalue">CoglColor</span></a> *color);</pre>
471
449
<p>
472
450
Retrieves the red channel of <em class="parameter"><code>color</code></em> as a floating point
473
451
value between 0.0 and 1.0</p>
474
 
<p>
475
 
</p>
476
452
<div class="variablelist"><table border="0">
477
453
<col align="left" valign="top">
478
454
<tbody>
494
470
<hr>
495
471
<div class="refsect2" title="cogl_color_get_green_float ()">
496
472
<a name="cogl-color-get-green-float"></a><h3>cogl_color_get_green_float ()</h3>
497
 
<pre class="programlisting">float               cogl_color_get_green_float          (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor">CoglColor</a> *color);</pre>
 
473
<pre class="programlisting"><span class="returnvalue">float</span>               cogl_color_get_green_float          (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor"><span class="returnvalue">CoglColor</span></a> *color);</pre>
498
474
<p>
499
475
Retrieves the green channel of <em class="parameter"><code>color</code></em> as a floating point
500
476
value between 0.0 and 1.0</p>
501
 
<p>
502
 
</p>
503
477
<div class="variablelist"><table border="0">
504
478
<col align="left" valign="top">
505
479
<tbody>
521
495
<hr>
522
496
<div class="refsect2" title="cogl_color_get_blue_float ()">
523
497
<a name="cogl-color-get-blue-float"></a><h3>cogl_color_get_blue_float ()</h3>
524
 
<pre class="programlisting">float               cogl_color_get_blue_float           (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor">CoglColor</a> *color);</pre>
 
498
<pre class="programlisting"><span class="returnvalue">float</span>               cogl_color_get_blue_float           (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor"><span class="returnvalue">CoglColor</span></a> *color);</pre>
525
499
<p>
526
500
Retrieves the blue channel of <em class="parameter"><code>color</code></em> as a floating point
527
501
value between 0.0 and 1.0</p>
528
 
<p>
529
 
</p>
530
502
<div class="variablelist"><table border="0">
531
503
<col align="left" valign="top">
532
504
<tbody>
548
520
<hr>
549
521
<div class="refsect2" title="cogl_color_get_alpha_float ()">
550
522
<a name="cogl-color-get-alpha-float"></a><h3>cogl_color_get_alpha_float ()</h3>
551
 
<pre class="programlisting">float               cogl_color_get_alpha_float          (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor">CoglColor</a> *color);</pre>
 
523
<pre class="programlisting"><span class="returnvalue">float</span>               cogl_color_get_alpha_float          (const <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor"><span class="returnvalue">CoglColor</span></a> *color);</pre>
552
524
<p>
553
525
Retrieves the alpha channel of <em class="parameter"><code>color</code></em> as a floating point
554
526
value between 0.0 and 1.0</p>
555
 
<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="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 alpha channel of the passed color
 
538
 
 
539
</td>
 
540
</tr>
 
541
</tbody>
 
542
</table></div>
 
543
<p class="since">Since 1.0</p>
 
544
</div>
 
545
<hr>
 
546
<div class="refsect2" title="cogl_color_premultiply ()">
 
547
<a name="cogl-color-premultiply"></a><h3>cogl_color_premultiply ()</h3>
 
548
<pre class="programlisting"><span class="returnvalue">void</span>                cogl_color_premultiply              (<a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor"><span class="returnvalue">CoglColor</span></a> *color);</pre>
 
549
<p>
 
550
Converts a non-premultiplied color to a pre-multiplied color. For
 
551
example, semi-transparent red is (1.0, 0, 0, 0.5) when non-premultiplied
 
552
and (0.5, 0, 0, 0.5) when premultiplied.</p>
 
553
<div class="variablelist"><table border="0">
 
554
<col align="left" valign="top">
 
555
<tbody><tr>
 
556
<td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
 
557
<td> the color to premultiply
 
558
</td>
 
559
</tr></tbody>
 
560
</table></div>
 
561
<p class="since">Since 1.0</p>
 
562
</div>
 
563
<hr>
 
564
<div class="refsect2" title="cogl_color_equal ()">
 
565
<a name="cogl-color-equal"></a><h3>cogl_color_equal ()</h3>
 
566
<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                    (<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gconstpointer"><span class="returnvalue">gconstpointer</span></a> v1,
 
567
                                                         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gconstpointer"><span class="returnvalue">gconstpointer</span></a> v2);</pre>
 
568
<p>
 
569
Compares two <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor"><span class="type">CoglColor</span></a>s and checks if they are the same.
556
570
</p>
 
571
<p>
 
572
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>
 
573
parameter, when using <a class="link" href="cogl-Color-Type.html#CoglColor" title="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>.</p>
557
574
<div class="variablelist"><table border="0">
558
575
<col align="left" valign="top">
559
576
<tbody>
560
577
<tr>
561
 
<td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
 
578
<td><p><span class="term"><em class="parameter"><code>v1</code></em> :</span></p></td>
 
579
<td> a <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor"><span class="type">CoglColor</span></a>
 
580
</td>
 
581
</tr>
 
582
<tr>
 
583
<td><p><span class="term"><em class="parameter"><code>v2</code></em> :</span></p></td>
562
584
<td> a <a class="link" href="cogl-Color-Type.html#CoglColor" title="CoglColor"><span class="type">CoglColor</span></a>
563
585
</td>
564
586
</tr>
565
587
<tr>
566
588
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
567
 
<td> the alpha channel of the passed color
 
589
<td> <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.
568
590
 
569
591
</td>
570
592
</tr>
576
598
</div>
577
599
<div class="footer">
578
600
<hr>
579
 
          Generated by GTK-Doc V1.11</div>
 
601
          Generated by GTK-Doc V1.13</div>
580
602
</body>
581
 
</html>
 
603
</html>
 
 
b'\\ No newline at end of file'