<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ClutterColorizeEffect: Clutter Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="Clutter Reference Manual">
<link rel="up" href="ch06.html" title="Effects">
<link rel="prev" href="ClutterBrightnessContrastEffect.html" title="ClutterBrightnessContrastEffect">
<link rel="next" href="ClutterDesaturateEffect.html" title="ClutterDesaturateEffect">
<meta name="generator" content="GTK-Doc V1.25.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#ClutterColorizeEffect.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#ClutterColorizeEffect.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#ClutterColorizeEffect.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch06.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ClutterBrightnessContrastEffect.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ClutterDesaturateEffect.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="ClutterColorizeEffect"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ClutterColorizeEffect.top_of_page"></a>ClutterColorizeEffect</span></h2>
<p>ClutterColorizeEffect — A colorization effect</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="ClutterColorizeEffect.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="ClutterEffect.html" title="ClutterEffect"><span class="returnvalue">ClutterEffect</span></a> *
</td>
<td class="function_name">
<a class="link" href="ClutterColorizeEffect.html#clutter-colorize-effect-new" title="clutter_colorize_effect_new ()">clutter_colorize_effect_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterColorizeEffect.html#clutter-colorize-effect-set-tint" title="clutter_colorize_effect_set_tint ()">clutter_colorize_effect_set_tint</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterColorizeEffect.html#clutter-colorize-effect-get-tint" title="clutter_colorize_effect_get_tint ()">clutter_colorize_effect_get_tint</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterColorizeEffect.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody><tr>
<td class="property_type">
<a class="link" href="clutter-Colors.html#ClutterColor"><span class="type">ClutterColor</span></a> *</td>
<td class="property_name"><a class="link" href="ClutterColorizeEffect.html#ClutterColorizeEffect--tint" title="The “tint” property">tint</a></td>
<td class="property_flags">Read / Write</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterColorizeEffect.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="ClutterColorizeEffect.html#ClutterColorizeEffect-struct" title="ClutterColorizeEffect">ClutterColorizeEffect</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterColorizeEffect.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> GInitiallyUnowned
<span class="lineart">╰──</span> <a class="link" href="ClutterActorMeta.html" title="ClutterActorMeta">ClutterActorMeta</a>
<span class="lineart">╰──</span> <a class="link" href="ClutterEffect.html" title="ClutterEffect">ClutterEffect</a>
<span class="lineart">╰──</span> <a class="link" href="ClutterOffscreenEffect.html" title="ClutterOffscreenEffect">ClutterOffscreenEffect</a>
<span class="lineart">╰──</span> ClutterColorizeEffect
</pre>
</div>
<div class="refsect1">
<a name="ClutterColorizeEffect.description"></a><h2>Description</h2>
<p><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
colorizes an actor with the given tint.</p>
<p><a class="link" href="ClutterColorizeEffect.html" title="ClutterColorizeEffect"><span class="type">ClutterColorizeEffect</span></a> is available since Clutter 1.4</p>
</div>
<div class="refsect1">
<a name="ClutterColorizeEffect.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="clutter-colorize-effect-new"></a><h3>clutter_colorize_effect_new ()</h3>
<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"><span class="type">ClutterColor</span></a> *tint</code></em>);</pre>
<p>Creates a new <a class="link" href="ClutterColorizeEffect.html" title="ClutterColorizeEffect"><span class="type">ClutterColorizeEffect</span></a> to be used with
<a class="link" href="ClutterActor.html#clutter-actor-add-effect" title="clutter_actor_add_effect ()"><code class="function">clutter_actor_add_effect()</code></a></p>
<div class="refsect3">
<a name="clutter-colorize-effect-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>tint</p></td>
<td class="parameter_description"><p>the color to be used</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-colorize-effect-new.returns"></a><h4>Returns</h4>
<p> the newly created <a class="link" href="ClutterColorizeEffect.html" title="ClutterColorizeEffect"><span class="type">ClutterColorizeEffect</span></a> or <code class="literal">NULL</code></p>
</div>
<p class="since">Since: <a class="link" href="ix09.html#api-index-1.4">1.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-colorize-effect-set-tint"></a><h3>clutter_colorize_effect_set_tint ()</h3>
<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>,
<em class="parameter"><code>const <a class="link" href="clutter-Colors.html#ClutterColor"><span class="type">ClutterColor</span></a> *tint</code></em>);</pre>
<p>Sets the tint to be used when colorizing</p>
<div class="refsect3">
<a name="clutter-colorize-effect-set-tint.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>effect</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterColorizeEffect.html" title="ClutterColorizeEffect"><span class="type">ClutterColorizeEffect</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>tint</p></td>
<td class="parameter_description"><p>the color to be used</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix09.html#api-index-1.4">1.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-colorize-effect-get-tint"></a><h3>clutter_colorize_effect_get_tint ()</h3>
<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>,
<em class="parameter"><code><a class="link" href="clutter-Colors.html#ClutterColor"><span class="type">ClutterColor</span></a> *tint</code></em>);</pre>
<p>Retrieves the tint used by <em class="parameter"><code>effect</code></em>
</p>
<div class="refsect3">
<a name="clutter-colorize-effect-get-tint.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>effect</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterColorizeEffect.html" title="ClutterColorizeEffect"><span class="type">ClutterColorizeEffect</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>tint</p></td>
<td class="parameter_description"><p> return location for the color used. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Out parameter, where caller must allocate storage."><span class="acronym">out caller-allocates</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix09.html#api-index-1.4">1.4</a></p>
</div>
</div>
<div class="refsect1">
<a name="ClutterColorizeEffect.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="ClutterColorizeEffect-struct"></a><h3>ClutterColorizeEffect</h3>
<pre class="programlisting">typedef struct _ClutterColorizeEffect ClutterColorizeEffect;</pre>
<p><a class="link" href="ClutterColorizeEffect.html" title="ClutterColorizeEffect"><span class="type">ClutterColorizeEffect</span></a> is an opaque structure
whose members cannot be directly accessed</p>
<p class="since">Since: <a class="link" href="ix09.html#api-index-1.4">1.4</a></p>
</div>
</div>
<div class="refsect1">
<a name="ClutterColorizeEffect.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="ClutterColorizeEffect--tint"></a><h3>The <code class="literal">“tint”</code> property</h3>
<pre class="programlisting"> “tint” <a class="link" href="clutter-Colors.html#ClutterColor"><span class="type">ClutterColor</span></a> *</pre>
<p>The tint to apply to the actor</p>
<p>Flags: Read / Write</p>
<p class="since">Since: <a class="link" href="ix09.html#api-index-1.4">1.4</a></p>
</div>
</div>
<div class="refsect1">
<a name="ClutterColorizeEffect.see-also"></a><h2>See Also</h2>
<p><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></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25.1</div>
</body>
</html>