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>ClutterBrightnessContrastEffect</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="ClutterBlurEffect.html" title="ClutterBlurEffect">
10 <link rel="next" href="ClutterColorizeEffect.html" title="ClutterColorizeEffect">
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="ClutterBlurEffect.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="ClutterColorizeEffect.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="#ClutterBrightnessContrastEffect.synopsis" class="shortcut">Top</a>
26 <a href="#ClutterBrightnessContrastEffect.description" class="shortcut">Description</a>
28 <a href="#ClutterBrightnessContrastEffect.object-hierarchy" class="shortcut">Object Hierarchy</a>
30 <a href="#ClutterBrightnessContrastEffect.properties" class="shortcut">Properties</a>
33 <div class="refentry">
34 <a name="ClutterBrightnessContrastEffect"></a><div class="titlepage"></div>
35 <div class="refnamediv"><table width="100%"><tr>
37 <h2><span class="refentrytitle"><a name="ClutterBrightnessContrastEffect.top_of_page"></a>ClutterBrightnessContrastEffect</span></h2>
38 <p>ClutterBrightnessContrastEffect — Increase/decrease brightness and/or contrast of actor.</p>
40 <td valign="top" align="right"></td>
42 <div class="refsynopsisdiv">
43 <a name="ClutterBrightnessContrastEffect.synopsis"></a><h2>Synopsis</h2>
44 <pre class="synopsis"> <a class="link" href="ClutterBrightnessContrastEffect.html#ClutterBrightnessContrastEffect-struct" title="ClutterBrightnessContrastEffect">ClutterBrightnessContrastEffect</a>;
45 <a class="link" href="ClutterEffect.html" title="ClutterEffect"><span class="returnvalue">ClutterEffect</span></a> * <a class="link" href="ClutterBrightnessContrastEffect.html#clutter-brightness-contrast-effect-new" title="clutter_brightness_contrast_effect_new ()">clutter_brightness_contrast_effect_new</a>
46 (<em class="parameter"><code><span class="type">void</span></code></em>);
47 <span class="returnvalue">void</span> <a class="link" href="ClutterBrightnessContrastEffect.html#clutter-brightness-contrast-effect-set-brightness" title="clutter_brightness_contrast_effect_set_brightness ()">clutter_brightness_contrast_effect_set_brightness</a>
48 (<em class="parameter"><code><a class="link" href="ClutterBrightnessContrastEffect.html" title="ClutterBrightnessContrastEffect"><span class="type">ClutterBrightnessContrastEffect</span></a> *effect</code></em>,
49 <em class="parameter"><code><span class="type">float</span> brightness</code></em>);
50 <span class="returnvalue">void</span> <a class="link" href="ClutterBrightnessContrastEffect.html#clutter-brightness-contrast-effect-set-brightness-full" title="clutter_brightness_contrast_effect_set_brightness_full ()">clutter_brightness_contrast_effect_set_brightness_full</a>
51 (<em class="parameter"><code><a class="link" href="ClutterBrightnessContrastEffect.html" title="ClutterBrightnessContrastEffect"><span class="type">ClutterBrightnessContrastEffect</span></a> *effect</code></em>,
52 <em class="parameter"><code><span class="type">float</span> red</code></em>,
53 <em class="parameter"><code><span class="type">float</span> green</code></em>,
54 <em class="parameter"><code><span class="type">float</span> blue</code></em>);
55 <span class="returnvalue">void</span> <a class="link" href="ClutterBrightnessContrastEffect.html#clutter-brightness-contrast-effect-get-brightness" title="clutter_brightness_contrast_effect_get_brightness ()">clutter_brightness_contrast_effect_get_brightness</a>
56 (<em class="parameter"><code><a class="link" href="ClutterBrightnessContrastEffect.html" title="ClutterBrightnessContrastEffect"><span class="type">ClutterBrightnessContrastEffect</span></a> *effect</code></em>,
57 <em class="parameter"><code><span class="type">float</span> *red</code></em>,
58 <em class="parameter"><code><span class="type">float</span> *green</code></em>,
59 <em class="parameter"><code><span class="type">float</span> *blue</code></em>);
60 <span class="returnvalue">void</span> <a class="link" href="ClutterBrightnessContrastEffect.html#clutter-brightness-contrast-effect-set-contrast" title="clutter_brightness_contrast_effect_set_contrast ()">clutter_brightness_contrast_effect_set_contrast</a>
61 (<em class="parameter"><code><a class="link" href="ClutterBrightnessContrastEffect.html" title="ClutterBrightnessContrastEffect"><span class="type">ClutterBrightnessContrastEffect</span></a> *effect</code></em>,
62 <em class="parameter"><code><span class="type">float</span> contrast</code></em>);
63 <span class="returnvalue">void</span> <a class="link" href="ClutterBrightnessContrastEffect.html#clutter-brightness-contrast-effect-set-contrast-full" title="clutter_brightness_contrast_effect_set_contrast_full ()">clutter_brightness_contrast_effect_set_contrast_full</a>
64 (<em class="parameter"><code><a class="link" href="ClutterBrightnessContrastEffect.html" title="ClutterBrightnessContrastEffect"><span class="type">ClutterBrightnessContrastEffect</span></a> *effect</code></em>,
65 <em class="parameter"><code><span class="type">float</span> red</code></em>,
66 <em class="parameter"><code><span class="type">float</span> green</code></em>,
67 <em class="parameter"><code><span class="type">float</span> blue</code></em>);
68 <span class="returnvalue">void</span> <a class="link" href="ClutterBrightnessContrastEffect.html#clutter-brightness-contrast-effect-get-contrast" title="clutter_brightness_contrast_effect_get_contrast ()">clutter_brightness_contrast_effect_get_contrast</a>
69 (<em class="parameter"><code><a class="link" href="ClutterBrightnessContrastEffect.html" title="ClutterBrightnessContrastEffect"><span class="type">ClutterBrightnessContrastEffect</span></a> *effect</code></em>,
70 <em class="parameter"><code><span class="type">float</span> *red</code></em>,
71 <em class="parameter"><code><span class="type">float</span> *green</code></em>,
72 <em class="parameter"><code><span class="type">float</span> *blue</code></em>);
75 <div class="refsect1">
76 <a name="ClutterBrightnessContrastEffect.object-hierarchy"></a><h2>Object Hierarchy</h2>
77 <pre class="synopsis">
79 +----GInitiallyUnowned
80 +----<a class="link" href="ClutterActorMeta.html" title="ClutterActorMeta">ClutterActorMeta</a>
81 +----<a class="link" href="ClutterEffect.html" title="ClutterEffect">ClutterEffect</a>
82 +----<a class="link" href="ClutterOffscreenEffect.html" title="ClutterOffscreenEffect">ClutterOffscreenEffect</a>
83 +----ClutterBrightnessContrastEffect
86 <div class="refsect1">
87 <a name="ClutterBrightnessContrastEffect.properties"></a><h2>Properties</h2>
88 <pre class="synopsis">
89 "<a class="link" href="ClutterBrightnessContrastEffect.html#ClutterBrightnessContrastEffect--brightness" title='The "brightness" property'>brightness</a>" <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a>* : Read / Write
90 "<a class="link" href="ClutterBrightnessContrastEffect.html#ClutterBrightnessContrastEffect--contrast" title='The "contrast" property'>contrast</a>" <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a>* : Read / Write
93 <div class="refsect1">
94 <a name="ClutterBrightnessContrastEffect.description"></a><h2>Description</h2>
96 <a class="link" href="ClutterBrightnessContrastEffect.html" title="ClutterBrightnessContrastEffect"><span class="type">ClutterBrightnessContrastEffect</span></a> is a sub-class of <a class="link" href="ClutterEffect.html" title="ClutterEffect"><span class="type">ClutterEffect</span></a> that
97 changes the overall brightness of a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>.
100 <a class="link" href="ClutterBrightnessContrastEffect.html" title="ClutterBrightnessContrastEffect"><span class="type">ClutterBrightnessContrastEffect</span></a> is available since Clutter 1.10
103 <div class="refsect1">
104 <a name="ClutterBrightnessContrastEffect.details"></a><h2>Details</h2>
105 <div class="refsect2">
106 <a name="ClutterBrightnessContrastEffect-struct"></a><h3>ClutterBrightnessContrastEffect</h3>
107 <pre class="programlisting">typedef struct _ClutterBrightnessContrastEffect ClutterBrightnessContrastEffect;</pre>
109 <span class="structname">ClutterBrightnessContrastEffect</span> is an opaque structure
110 whose members cannot be directly accessed
112 <p class="since">Since 1.10</p>
115 <div class="refsect2">
116 <a name="clutter-brightness-contrast-effect-new"></a><h3>clutter_brightness_contrast_effect_new ()</h3>
117 <pre class="programlisting"><a class="link" href="ClutterEffect.html" title="ClutterEffect"><span class="returnvalue">ClutterEffect</span></a> * clutter_brightness_contrast_effect_new
118 (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
120 Creates a new <a class="link" href="ClutterBrightnessContrastEffect.html" title="ClutterBrightnessContrastEffect"><span class="type">ClutterBrightnessContrastEffect</span></a> to be used with
121 <a class="link" href="ClutterActor.html#clutter-actor-add-effect" title="clutter_actor_add_effect ()"><code class="function">clutter_actor_add_effect()</code></a>
123 <div class="variablelist"><table border="0">
124 <col align="left" valign="top">
126 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
127 <td>the newly created
128 <a class="link" href="ClutterBrightnessContrastEffect.html" title="ClutterBrightnessContrastEffect"><span class="type">ClutterBrightnessContrastEffect</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>. Use <code class="function">g_object_unref()</code> when
129 done. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
133 <p class="since">Since 1.10</p>
136 <div class="refsect2">
137 <a name="clutter-brightness-contrast-effect-set-brightness"></a><h3>clutter_brightness_contrast_effect_set_brightness ()</h3>
138 <pre class="programlisting"><span class="returnvalue">void</span> clutter_brightness_contrast_effect_set_brightness
139 (<em class="parameter"><code><a class="link" href="ClutterBrightnessContrastEffect.html" title="ClutterBrightnessContrastEffect"><span class="type">ClutterBrightnessContrastEffect</span></a> *effect</code></em>,
140 <em class="parameter"><code><span class="type">float</span> brightness</code></em>);</pre>
142 The range of <em class="parameter"><code>brightness</code></em> is [-1.0, 1.0], where 0.0 designates no change;
143 a value below 0.0 indicates a decrease in brightness; and a value
144 above 0.0 indicates an increase of brightness.
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="ClutterBrightnessContrastEffect.html" title="ClutterBrightnessContrastEffect"><span class="type">ClutterBrightnessContrastEffect</span></a>
155 <td><p><span class="term"><em class="parameter"><code>brightness</code></em> :</span></p></td>
156 <td>the brightness change for all three components (r, g, b)</td>
160 <p class="since">Since 1.10</p>
163 <div class="refsect2">
164 <a name="clutter-brightness-contrast-effect-set-brightness-full"></a><h3>clutter_brightness_contrast_effect_set_brightness_full ()</h3>
165 <pre class="programlisting"><span class="returnvalue">void</span> clutter_brightness_contrast_effect_set_brightness_full
166 (<em class="parameter"><code><a class="link" href="ClutterBrightnessContrastEffect.html" title="ClutterBrightnessContrastEffect"><span class="type">ClutterBrightnessContrastEffect</span></a> *effect</code></em>,
167 <em class="parameter"><code><span class="type">float</span> red</code></em>,
168 <em class="parameter"><code><span class="type">float</span> green</code></em>,
169 <em class="parameter"><code><span class="type">float</span> blue</code></em>);</pre>
171 The range for each component is [-1.0, 1.0] where 0.0 designates no change,
172 values below 0.0 mean a decrease in brightness, and values above indicate
175 <div class="variablelist"><table border="0">
176 <col align="left" valign="top">
179 <td><p><span class="term"><em class="parameter"><code>effect</code></em> :</span></p></td>
180 <td>a <a class="link" href="ClutterBrightnessContrastEffect.html" title="ClutterBrightnessContrastEffect"><span class="type">ClutterBrightnessContrastEffect</span></a>
184 <td><p><span class="term"><em class="parameter"><code>red</code></em> :</span></p></td>
185 <td>red component of the change in brightness</td>
188 <td><p><span class="term"><em class="parameter"><code>green</code></em> :</span></p></td>
189 <td>green component of the change in brightness</td>
192 <td><p><span class="term"><em class="parameter"><code>blue</code></em> :</span></p></td>
193 <td>blue component of the change in brightness</td>
197 <p class="since">Since 1.10</p>
200 <div class="refsect2">
201 <a name="clutter-brightness-contrast-effect-get-brightness"></a><h3>clutter_brightness_contrast_effect_get_brightness ()</h3>
202 <pre class="programlisting"><span class="returnvalue">void</span> clutter_brightness_contrast_effect_get_brightness
203 (<em class="parameter"><code><a class="link" href="ClutterBrightnessContrastEffect.html" title="ClutterBrightnessContrastEffect"><span class="type">ClutterBrightnessContrastEffect</span></a> *effect</code></em>,
204 <em class="parameter"><code><span class="type">float</span> *red</code></em>,
205 <em class="parameter"><code><span class="type">float</span> *green</code></em>,
206 <em class="parameter"><code><span class="type">float</span> *blue</code></em>);</pre>
208 Retrieves the change in brightness used by <em class="parameter"><code>effect</code></em>.
210 <div class="variablelist"><table border="0">
211 <col align="left" valign="top">
214 <td><p><span class="term"><em class="parameter"><code>effect</code></em> :</span></p></td>
215 <td>a <a class="link" href="ClutterBrightnessContrastEffect.html" title="ClutterBrightnessContrastEffect"><span class="type">ClutterBrightnessContrastEffect</span></a>
219 <td><p><span class="term"><em class="parameter"><code>red</code></em> :</span></p></td>
220 <td>return location for red component of the
221 change in brightness. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
225 <td><p><span class="term"><em class="parameter"><code>green</code></em> :</span></p></td>
226 <td>return location for green component of the
227 change in brightness. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
231 <td><p><span class="term"><em class="parameter"><code>blue</code></em> :</span></p></td>
232 <td>return location for blue component of the
233 change in brightness. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
238 <p class="since">Since 1.10</p>
241 <div class="refsect2">
242 <a name="clutter-brightness-contrast-effect-set-contrast"></a><h3>clutter_brightness_contrast_effect_set_contrast ()</h3>
243 <pre class="programlisting"><span class="returnvalue">void</span> clutter_brightness_contrast_effect_set_contrast
244 (<em class="parameter"><code><a class="link" href="ClutterBrightnessContrastEffect.html" title="ClutterBrightnessContrastEffect"><span class="type">ClutterBrightnessContrastEffect</span></a> *effect</code></em>,
245 <em class="parameter"><code><span class="type">float</span> contrast</code></em>);</pre>
247 The range for <em class="parameter"><code>contrast</code></em> is [-1.0, 1.0], where 0.0 designates no change;
248 a value below 0.0 indicates a decrease in contrast; and a value above
249 0.0 indicates an increase.
251 <div class="variablelist"><table border="0">
252 <col align="left" valign="top">
255 <td><p><span class="term"><em class="parameter"><code>effect</code></em> :</span></p></td>
256 <td>a <a class="link" href="ClutterBrightnessContrastEffect.html" title="ClutterBrightnessContrastEffect"><span class="type">ClutterBrightnessContrastEffect</span></a>
260 <td><p><span class="term"><em class="parameter"><code>contrast</code></em> :</span></p></td>
261 <td>contrast change for all three channels</td>
265 <p class="since">Since 1.10</p>
268 <div class="refsect2">
269 <a name="clutter-brightness-contrast-effect-set-contrast-full"></a><h3>clutter_brightness_contrast_effect_set_contrast_full ()</h3>
270 <pre class="programlisting"><span class="returnvalue">void</span> clutter_brightness_contrast_effect_set_contrast_full
271 (<em class="parameter"><code><a class="link" href="ClutterBrightnessContrastEffect.html" title="ClutterBrightnessContrastEffect"><span class="type">ClutterBrightnessContrastEffect</span></a> *effect</code></em>,
272 <em class="parameter"><code><span class="type">float</span> red</code></em>,
273 <em class="parameter"><code><span class="type">float</span> green</code></em>,
274 <em class="parameter"><code><span class="type">float</span> blue</code></em>);</pre>
276 The range for each component is [-1.0, 1.0] where 0.0 designates no change,
277 values below 0.0 mean a decrease in contrast, and values above indicate
280 <div class="variablelist"><table border="0">
281 <col align="left" valign="top">
284 <td><p><span class="term"><em class="parameter"><code>effect</code></em> :</span></p></td>
285 <td>a <a class="link" href="ClutterBrightnessContrastEffect.html" title="ClutterBrightnessContrastEffect"><span class="type">ClutterBrightnessContrastEffect</span></a>
289 <td><p><span class="term"><em class="parameter"><code>red</code></em> :</span></p></td>
290 <td>red component of the change in contrast</td>
293 <td><p><span class="term"><em class="parameter"><code>green</code></em> :</span></p></td>
294 <td>green component of the change in contrast</td>
297 <td><p><span class="term"><em class="parameter"><code>blue</code></em> :</span></p></td>
298 <td>blue component of the change in contrast</td>
302 <p class="since">Since 1.10</p>
305 <div class="refsect2">
306 <a name="clutter-brightness-contrast-effect-get-contrast"></a><h3>clutter_brightness_contrast_effect_get_contrast ()</h3>
307 <pre class="programlisting"><span class="returnvalue">void</span> clutter_brightness_contrast_effect_get_contrast
308 (<em class="parameter"><code><a class="link" href="ClutterBrightnessContrastEffect.html" title="ClutterBrightnessContrastEffect"><span class="type">ClutterBrightnessContrastEffect</span></a> *effect</code></em>,
309 <em class="parameter"><code><span class="type">float</span> *red</code></em>,
310 <em class="parameter"><code><span class="type">float</span> *green</code></em>,
311 <em class="parameter"><code><span class="type">float</span> *blue</code></em>);</pre>
313 Retrieves the contrast value used by <em class="parameter"><code>effect</code></em>.
315 <div class="variablelist"><table border="0">
316 <col align="left" valign="top">
319 <td><p><span class="term"><em class="parameter"><code>effect</code></em> :</span></p></td>
320 <td>a <a class="link" href="ClutterBrightnessContrastEffect.html" title="ClutterBrightnessContrastEffect"><span class="type">ClutterBrightnessContrastEffect</span></a>
324 <td><p><span class="term"><em class="parameter"><code>red</code></em> :</span></p></td>
325 <td>return location for red component of the
326 change in contrast. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
330 <td><p><span class="term"><em class="parameter"><code>green</code></em> :</span></p></td>
331 <td>return location for green component of the
332 change in contrast. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
336 <td><p><span class="term"><em class="parameter"><code>blue</code></em> :</span></p></td>
337 <td>return location for blue component of the
338 change in contrast. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
343 <p class="since">Since 1.10</p>
346 <div class="refsect1">
347 <a name="ClutterBrightnessContrastEffect.property-details"></a><h2>Property Details</h2>
348 <div class="refsect2">
349 <a name="ClutterBrightnessContrastEffect--brightness"></a><h3>The <code class="literal">"brightness"</code> property</h3>
350 <pre class="programlisting"> "brightness" <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a>* : Read / Write</pre>
352 The brightness change to apply to the effect.
355 This property uses a <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> to represent the changes to each
356 color channel. The range is [ 0, 255 ], with 127 as the value used
357 to indicate no change; values smaller than 127 indicate a decrease
358 in brightness, and values larger than 127 indicate an increase in
361 <p class="since">Since 1.10</p>
364 <div class="refsect2">
365 <a name="ClutterBrightnessContrastEffect--contrast"></a><h3>The <code class="literal">"contrast"</code> property</h3>
366 <pre class="programlisting"> "contrast" <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a>* : Read / Write</pre>
368 The contrast change to apply to the effect.
371 This property uses a <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> to represent the changes to each
372 color channel. The range is [ 0, 255 ], with 127 as the value used
373 to indicate no change; values smaller than 127 indicate a decrease
374 in contrast, and values larger than 127 indicate an increase in
377 <p class="since">Since 1.10</p>
380 <div class="refsect1">
381 <a name="ClutterBrightnessContrastEffect.see-also"></a><h2>See Also</h2>
382 <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>
387 Generated by GTK-Doc V1.18.1</div>