1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>ClutterColorizeEffect</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7 <link rel="home" href="index.html" title="Clutter Reference Manual">
8 <link rel="up" href="ch06.html" title="Effects">
9 <link rel="prev" href="ClutterBrightnessContrastEffect.html" title="ClutterBrightnessContrastEffect">
10 <link rel="next" href="ClutterDesaturateEffect.html" title="ClutterDesaturateEffect">
11 <meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
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">
17 <td><a accesskey="p" href="ClutterBrightnessContrastEffect.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="ch06.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">Clutter Reference Manual</th>
21 <td><a accesskey="n" href="ClutterDesaturateEffect.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#ClutterColorizeEffect.synopsis" class="shortcut">Top</a>
26 <a href="#ClutterColorizeEffect.description" class="shortcut">Description</a>
28 <a href="#ClutterColorizeEffect.object-hierarchy" class="shortcut">Object Hierarchy</a>
30 <a href="#ClutterColorizeEffect.properties" class="shortcut">Properties</a>
33 <div class="refentry">
34 <a name="ClutterColorizeEffect"></a><div class="titlepage"></div>
35 <div class="refnamediv"><table width="100%"><tr>
37 <h2><span class="refentrytitle"><a name="ClutterColorizeEffect.top_of_page"></a>ClutterColorizeEffect</span></h2>
38 <p>ClutterColorizeEffect — A colorization effect</p>
40 <td valign="top" align="right"></td>
42 <div class="refsynopsisdiv">
43 <a name="ClutterColorizeEffect.synopsis"></a><h2>Synopsis</h2>
44 <pre class="synopsis"> <a class="link" href="ClutterColorizeEffect.html#ClutterColorizeEffect-struct" title="ClutterColorizeEffect">ClutterColorizeEffect</a>;
45 <a class="link" href="ClutterEffect.html" title="ClutterEffect"><span class="returnvalue">ClutterEffect</span></a> * <a class="link" href="ClutterColorizeEffect.html#clutter-colorize-effect-new" title="clutter_colorize_effect_new ()">clutter_colorize_effect_new</a> (<em class="parameter"><code>const <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *tint</code></em>);
46 <span class="returnvalue">void</span> <a class="link" href="ClutterColorizeEffect.html#clutter-colorize-effect-set-tint" title="clutter_colorize_effect_set_tint ()">clutter_colorize_effect_set_tint</a> (<em class="parameter"><code><a class="link" href="ClutterColorizeEffect.html" title="ClutterColorizeEffect"><span class="type">ClutterColorizeEffect</span></a> *effect</code></em>,
47 <em class="parameter"><code>const <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *tint</code></em>);
48 <span class="returnvalue">void</span> <a class="link" href="ClutterColorizeEffect.html#clutter-colorize-effect-get-tint" title="clutter_colorize_effect_get_tint ()">clutter_colorize_effect_get_tint</a> (<em class="parameter"><code><a class="link" href="ClutterColorizeEffect.html" title="ClutterColorizeEffect"><span class="type">ClutterColorizeEffect</span></a> *effect</code></em>,
49 <em class="parameter"><code><a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *tint</code></em>);
52 <div class="refsect1">
53 <a name="ClutterColorizeEffect.object-hierarchy"></a><h2>Object Hierarchy</h2>
54 <pre class="synopsis">
56 +----GInitiallyUnowned
57 +----<a class="link" href="ClutterActorMeta.html" title="ClutterActorMeta">ClutterActorMeta</a>
58 +----<a class="link" href="ClutterEffect.html" title="ClutterEffect">ClutterEffect</a>
59 +----<a class="link" href="ClutterOffscreenEffect.html" title="ClutterOffscreenEffect">ClutterOffscreenEffect</a>
60 +----ClutterColorizeEffect
63 <div class="refsect1">
64 <a name="ClutterColorizeEffect.properties"></a><h2>Properties</h2>
65 <pre class="synopsis">
66 "<a class="link" href="ClutterColorizeEffect.html#ClutterColorizeEffect--tint" title='The "tint" property'>tint</a>" <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a>* : Read / Write
69 <div class="refsect1">
70 <a name="ClutterColorizeEffect.description"></a><h2>Description</h2>
72 <a class="link" href="ClutterColorizeEffect.html" title="ClutterColorizeEffect"><span class="type">ClutterColorizeEffect</span></a> is a sub-class of <a class="link" href="ClutterEffect.html" title="ClutterEffect"><span class="type">ClutterEffect</span></a> that
73 colorizes an actor with the given tint.
76 <a class="link" href="ClutterColorizeEffect.html" title="ClutterColorizeEffect"><span class="type">ClutterColorizeEffect</span></a> is available since Clutter 1.4
79 <div class="refsect1">
80 <a name="ClutterColorizeEffect.details"></a><h2>Details</h2>
81 <div class="refsect2">
82 <a name="ClutterColorizeEffect-struct"></a><h3>ClutterColorizeEffect</h3>
83 <pre class="programlisting">typedef struct _ClutterColorizeEffect ClutterColorizeEffect;</pre>
85 <span class="structname">ClutterColorizeEffect</span> is an opaque structure
86 whose members cannot be directly accessed
88 <p class="since">Since 1.4</p>
91 <div class="refsect2">
92 <a name="clutter-colorize-effect-new"></a><h3>clutter_colorize_effect_new ()</h3>
93 <pre class="programlisting"><a class="link" href="ClutterEffect.html" title="ClutterEffect"><span class="returnvalue">ClutterEffect</span></a> * clutter_colorize_effect_new (<em class="parameter"><code>const <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *tint</code></em>);</pre>
95 Creates a new <a class="link" href="ClutterColorizeEffect.html" title="ClutterColorizeEffect"><span class="type">ClutterColorizeEffect</span></a> to be used with
96 <a class="link" href="ClutterActor.html#clutter-actor-add-effect" title="clutter_actor_add_effect ()"><code class="function">clutter_actor_add_effect()</code></a>
98 <div class="variablelist"><table border="0">
99 <col align="left" valign="top">
102 <td><p><span class="term"><em class="parameter"><code>tint</code></em> :</span></p></td>
103 <td>the color to be used</td>
106 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
107 <td>the newly created <a class="link" href="ClutterColorizeEffect.html" title="ClutterColorizeEffect"><span class="type">ClutterColorizeEffect</span></a> or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
112 <p class="since">Since 1.4</p>
115 <div class="refsect2">
116 <a name="clutter-colorize-effect-set-tint"></a><h3>clutter_colorize_effect_set_tint ()</h3>
117 <pre class="programlisting"><span class="returnvalue">void</span> clutter_colorize_effect_set_tint (<em class="parameter"><code><a class="link" href="ClutterColorizeEffect.html" title="ClutterColorizeEffect"><span class="type">ClutterColorizeEffect</span></a> *effect</code></em>,
118 <em class="parameter"><code>const <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *tint</code></em>);</pre>
120 Sets the tint to be used when colorizing
122 <div class="variablelist"><table border="0">
123 <col align="left" valign="top">
126 <td><p><span class="term"><em class="parameter"><code>effect</code></em> :</span></p></td>
127 <td>a <a class="link" href="ClutterColorizeEffect.html" title="ClutterColorizeEffect"><span class="type">ClutterColorizeEffect</span></a>
131 <td><p><span class="term"><em class="parameter"><code>tint</code></em> :</span></p></td>
132 <td>the color to be used</td>
136 <p class="since">Since 1.4</p>
139 <div class="refsect2">
140 <a name="clutter-colorize-effect-get-tint"></a><h3>clutter_colorize_effect_get_tint ()</h3>
141 <pre class="programlisting"><span class="returnvalue">void</span> clutter_colorize_effect_get_tint (<em class="parameter"><code><a class="link" href="ClutterColorizeEffect.html" title="ClutterColorizeEffect"><span class="type">ClutterColorizeEffect</span></a> *effect</code></em>,
142 <em class="parameter"><code><a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *tint</code></em>);</pre>
144 Retrieves the tint used by <em class="parameter"><code>effect</code></em>
146 <div class="variablelist"><table border="0">
147 <col align="left" valign="top">
150 <td><p><span class="term"><em class="parameter"><code>effect</code></em> :</span></p></td>
151 <td>a <a class="link" href="ClutterColorizeEffect.html" title="ClutterColorizeEffect"><span class="type">ClutterColorizeEffect</span></a>
155 <td><p><span class="term"><em class="parameter"><code>tint</code></em> :</span></p></td>
156 <td>return location for the color used. <span class="annotation">[<acronym title="Out parameter, where caller must allocate storage."><span class="acronym">out caller-allocates</span></acronym>]</span>
161 <p class="since">Since 1.4</p>
164 <div class="refsect1">
165 <a name="ClutterColorizeEffect.property-details"></a><h2>Property Details</h2>
166 <div class="refsect2">
167 <a name="ClutterColorizeEffect--tint"></a><h3>The <code class="literal">"tint"</code> property</h3>
168 <pre class="programlisting"> "tint" <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a>* : Read / Write</pre>
170 The tint to apply to the actor
172 <p class="since">Since 1.4</p>
175 <div class="refsect1">
176 <a name="ClutterColorizeEffect.see-also"></a><h2>See Also</h2>
177 <a class="link" href="ClutterEffect.html" title="ClutterEffect"><span class="type">ClutterEffect</span></a>, <a class="link" href="ClutterOffscreenEffect.html" title="ClutterOffscreenEffect"><span class="type">ClutterOffscreenEffect</span></a>
182 Generated by GTK-Doc V1.18.1</div>