<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ClutterTexture: 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="deprecated.html" title="Part X. Deprecated Classes">
<link rel="prev" href="ClutterTableLayout.html" title="ClutterTableLayout">
<link rel="next" href="clutterobjects.html" title="Part XI. Clutter Actors and Objects">
<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="#ClutterTexture.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#ClutterTexture.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#ClutterTexture.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#ClutterTexture.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#ClutterTexture.signals" class="shortcut">Signals</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="deprecated.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ClutterTableLayout.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="clutterobjects.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="ClutterTexture"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ClutterTexture.top_of_page"></a>ClutterTexture</span></h2>
<p>ClutterTexture — An actor for displaying and manipulating images.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="ClutterTexture.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="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
</td>
<td class="function_name">
<a class="link" href="ClutterTexture.html#clutter-texture-new" title="clutter_texture_new ()">clutter_texture_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
</td>
<td class="function_name">
<a class="link" href="ClutterTexture.html#clutter-texture-new-from-file" title="clutter_texture_new_from_file ()">clutter_texture_new_from_file</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
</td>
<td class="function_name">
<a class="link" href="ClutterTexture.html#clutter-texture-new-from-actor" title="clutter_texture_new_from_actor ()">clutter_texture_new_from_actor</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="ClutterTexture.html#clutter-texture-set-from-file" title="clutter_texture_set_from_file ()">clutter_texture_set_from_file</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="ClutterTexture.html#clutter-texture-set-from-rgb-data" title="clutter_texture_set_from_rgb_data ()">clutter_texture_set_from_rgb_data</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="ClutterTexture.html#clutter-texture-set-from-yuv-data" title="clutter_texture_set_from_yuv_data ()">clutter_texture_set_from_yuv_data</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="ClutterTexture.html#clutter-texture-set-area-from-rgb-data" title="clutter_texture_set_area_from_rgb_data ()">clutter_texture_set_area_from_rgb_data</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="ClutterTexture.html#clutter-texture-get-base-size" title="clutter_texture_get_base_size ()">clutter_texture_get_base_size</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">CoglPixelFormat</span>
</td>
<td class="function_name">
<a class="link" href="ClutterTexture.html#clutter-texture-get-pixel-format" title="clutter_texture_get_pixel_format ()">clutter_texture_get_pixel_format</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gint</span>
</td>
<td class="function_name">
<a class="link" href="ClutterTexture.html#clutter-texture-get-max-tile-waste" title="clutter_texture_get_max_tile_waste ()">clutter_texture_get_max_tile_waste</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="ClutterTexture.html#ClutterTextureQuality" title="enum ClutterTextureQuality"><span class="returnvalue">ClutterTextureQuality</span></a>
</td>
<td class="function_name">
<a class="link" href="ClutterTexture.html#clutter-texture-get-filter-quality" title="clutter_texture_get_filter_quality ()">clutter_texture_get_filter_quality</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="ClutterTexture.html#clutter-texture-set-filter-quality" title="clutter_texture_set_filter_quality ()">clutter_texture_set_filter_quality</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">CoglHandle</span>
</td>
<td class="function_name">
<a class="link" href="ClutterTexture.html#clutter-texture-get-cogl-texture" title="clutter_texture_get_cogl_texture ()">clutter_texture_get_cogl_texture</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="ClutterTexture.html#clutter-texture-set-cogl-texture" title="clutter_texture_set_cogl_texture ()">clutter_texture_set_cogl_texture</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">CoglHandle</span>
</td>
<td class="function_name">
<a class="link" href="ClutterTexture.html#clutter-texture-get-cogl-material" title="clutter_texture_get_cogl_material ()">clutter_texture_get_cogl_material</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="ClutterTexture.html#clutter-texture-set-cogl-material" title="clutter_texture_set_cogl_material ()">clutter_texture_set_cogl_material</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="ClutterTexture.html#clutter-texture-get-sync-size" title="clutter_texture_get_sync_size ()">clutter_texture_get_sync_size</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="ClutterTexture.html#clutter-texture-set-sync-size" title="clutter_texture_set_sync_size ()">clutter_texture_set_sync_size</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="ClutterTexture.html#clutter-texture-get-repeat" title="clutter_texture_get_repeat ()">clutter_texture_get_repeat</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="ClutterTexture.html#clutter-texture-set-repeat" title="clutter_texture_set_repeat ()">clutter_texture_set_repeat</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="ClutterTexture.html#clutter-texture-get-keep-aspect-ratio" title="clutter_texture_get_keep_aspect_ratio ()">clutter_texture_get_keep_aspect_ratio</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="ClutterTexture.html#clutter-texture-set-keep-aspect-ratio" title="clutter_texture_set_keep_aspect_ratio ()">clutter_texture_set_keep_aspect_ratio</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="ClutterTexture.html#clutter-texture-get-load-async" title="clutter_texture_get_load_async ()">clutter_texture_get_load_async</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="ClutterTexture.html#clutter-texture-set-load-async" title="clutter_texture_set_load_async ()">clutter_texture_set_load_async</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="ClutterTexture.html#clutter-texture-get-load-data-async" title="clutter_texture_get_load_data_async ()">clutter_texture_get_load_data_async</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="ClutterTexture.html#clutter-texture-set-load-data-async" title="clutter_texture_set_load_data_async ()">clutter_texture_set_load_data_async</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="ClutterTexture.html#clutter-texture-get-pick-with-alpha" title="clutter_texture_get_pick_with_alpha ()">clutter_texture_get_pick_with_alpha</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="ClutterTexture.html#clutter-texture-set-pick-with-alpha" title="clutter_texture_set_pick_with_alpha ()">clutter_texture_set_pick_with_alpha</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterTexture.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">
<span class="type">CoglHandle</span> *</td>
<td class="property_name"><a class="link" href="ClutterTexture.html#ClutterTexture--cogl-material" title="The “cogl-material” property">cogl-material</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<span class="type">CoglHandle</span> *</td>
<td class="property_name"><a class="link" href="ClutterTexture.html#ClutterTexture--cogl-texture" title="The “cogl-texture” property">cogl-texture</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="ClutterTexture.html#ClutterTexture--disable-slicing" title="The “disable-slicing” property">disable-slicing</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="ClutterTexture.html#ClutterTexture--filename" title="The “filename” property">filename</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a class="link" href="ClutterTexture.html#ClutterTextureQuality" title="enum ClutterTextureQuality"><span class="type">ClutterTextureQuality</span></a></td>
<td class="property_name"><a class="link" href="ClutterTexture.html#ClutterTexture--filter-quality" title="The “filter-quality” property">filter-quality</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="ClutterTexture.html#ClutterTexture--keep-aspect-ratio" title="The “keep-aspect-ratio” property">keep-aspect-ratio</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="ClutterTexture.html#ClutterTexture--load-async" title="The “load-async” property">load-async</a></td>
<td class="property_flags">Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="ClutterTexture.html#ClutterTexture--load-data-async" title="The “load-data-async” property">load-data-async</a></td>
<td class="property_flags">Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="ClutterTexture.html#ClutterTexture--pick-with-alpha" title="The “pick-with-alpha” property">pick-with-alpha</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">CoglPixelFormat</span></td>
<td class="property_name"><a class="link" href="ClutterTexture.html#ClutterTexture--pixel-format" title="The “pixel-format” property">pixel-format</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="ClutterTexture.html#ClutterTexture--repeat-x" title="The “repeat-x” property">repeat-x</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="ClutterTexture.html#ClutterTexture--repeat-y" title="The “repeat-y” property">repeat-y</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="ClutterTexture.html#ClutterTexture--sync-size" title="The “sync-size” property">sync-size</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gint</span></td>
<td class="property_name"><a class="link" href="ClutterTexture.html#ClutterTexture--tile-waste" title="The “tile-waste” property">tile-waste</a></td>
<td class="property_flags">Read</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterTexture.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="ClutterTexture.html#ClutterTexture-load-finished" title="The “load-finished” signal">load-finished</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="ClutterTexture.html#ClutterTexture-pixbuf-change" title="The “pixbuf-change” signal">pixbuf-change</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="ClutterTexture.html#ClutterTexture-size-change" title="The “size-change” signal">size-change</a></td>
<td class="signal_flags">Run Last</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterTexture.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">struct</td>
<td class="function_name"><a class="link" href="ClutterTexture.html#ClutterTexture-struct" title="struct ClutterTexture">ClutterTexture</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="ClutterTexture.html#ClutterTextureClass" title="struct ClutterTextureClass">ClutterTextureClass</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="ClutterTexture.html#ClutterTextureFlags" title="enum ClutterTextureFlags">ClutterTextureFlags</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="ClutterTexture.html#ClutterTextureQuality" title="enum ClutterTextureQuality">ClutterTextureQuality</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="ClutterTexture.html#CLUTTER-TEXTURE-ERROR:CAPS" title="CLUTTER_TEXTURE_ERROR">CLUTTER_TEXTURE_ERROR</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="ClutterTexture.html#ClutterTextureError" title="enum ClutterTextureError">ClutterTextureError</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterTexture.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> GInitiallyUnowned
<span class="lineart">╰──</span> <a class="link" href="ClutterActor.html" title="ClutterActor">ClutterActor</a>
<span class="lineart">╰──</span> ClutterTexture
<span class="lineart">├──</span> <a class="link" href="ClutterCairoTexture.html" title="ClutterCairoTexture">ClutterCairoTexture</a>
<span class="lineart">╰──</span> <a class="link" href="ClutterX11TexturePixmap.html" title="ClutterX11TexturePixmap">ClutterX11TexturePixmap</a>
</pre>
</div>
<div class="refsect1">
<a name="ClutterTexture.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
ClutterTexture implements
<a class="link" href="ClutterContainer.html" title="ClutterContainer">ClutterContainer</a>, <a class="link" href="ClutterScriptable.html" title="ClutterScriptable">ClutterScriptable</a>, <a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable">ClutterAnimatable</a> and AtkImplementorIface.</p>
</div>
<div class="refsect1">
<a name="ClutterTexture.description"></a><h2>Description</h2>
<p><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> is a base class for displaying and manipulating pixel
buffer type data.</p>
<p>The <a class="link" href="ClutterTexture.html#clutter-texture-set-from-rgb-data" title="clutter_texture_set_from_rgb_data ()"><code class="function">clutter_texture_set_from_rgb_data()</code></a> and
<a class="link" href="ClutterTexture.html#clutter-texture-set-from-file" title="clutter_texture_set_from_file ()"><code class="function">clutter_texture_set_from_file()</code></a> functions are used to copy image
data into texture memory and subsequently realize the texture.</p>
<p>Note: a ClutterTexture will scale its contents to fit the bounding
box requested using <a class="link" href="ClutterActor.html#clutter-actor-set-size" title="clutter_actor_set_size ()"><code class="function">clutter_actor_set_size()</code></a>. To display an area of
a texture without scaling, you should set the clip area using
<a class="link" href="ClutterActor.html#clutter-actor-set-clip" title="clutter_actor_set_clip ()"><code class="function">clutter_actor_set_clip()</code></a>.</p>
<p>The <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> API is deprecated since Clutter 1.12. It is strongly
recommended to use <a class="link" href="ClutterImage.html" title="ClutterImage"><span class="type">ClutterImage</span></a> instead.</p>
</div>
<div class="refsect1">
<a name="ClutterTexture.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="clutter-texture-new"></a><h3>clutter_texture_new ()</h3>
<pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
clutter_texture_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_texture_new</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterImage.html" title="ClutterImage"><span class="type">ClutterImage</span></a> instead</p>
</div>
<p>Creates a new empty <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> object.</p>
<div class="refsect3">
<a name="clutter-texture-new.returns"></a><h4>Returns</h4>
<p> A newly created <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> object.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="clutter-texture-new-from-file"></a><h3>clutter_texture_new_from_file ()</h3>
<pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
clutter_texture_new_from_file (<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_texture_new_from_file</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>No direct replacement is available. Use <a class="link" href="ClutterImage.html" title="ClutterImage"><span class="type">ClutterImage</span></a>
and platform-specific image loading API, like GdkPixbuf, instead</p>
</div>
<p>Creates a new ClutterTexture actor to display the image contained a
file. If the image failed to load then NULL is returned and <em class="parameter"><code>error</code></em>
is set.</p>
<div class="refsect3">
<a name="clutter-texture-new-from-file.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>filename</p></td>
<td class="parameter_description"><p>The name of an image file to load.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Return locatoin for an error.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-texture-new-from-file.returns"></a><h4>Returns</h4>
<p> A newly created <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> object or NULL on
error.</p>
</div>
<p class="since">Since: <a class="link" href="ix06.html#api-index-0.8">0.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-texture-new-from-actor"></a><h3>clutter_texture_new_from_actor ()</h3>
<pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
clutter_texture_new_from_actor (<em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *actor</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_texture_new_from_actor</code> has been deprecated since version 1.8 and should not be used in newly-written code.</p>
<p>Use the <a class="link" href="ClutterOffscreenEffect.html" title="ClutterOffscreenEffect"><span class="type">ClutterOffscreenEffect</span></a> and <a class="link" href="ClutterShaderEffect.html" title="ClutterShaderEffect"><span class="type">ClutterShaderEffect</span></a>
directly on the intended <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> to replace the functionality of
this function.</p>
</div>
<p>Creates a new <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> object with its source a prexisting
actor (and associated children). The textures content will contain
'live' redirected output of the actors scene.</p>
<p>Note this function is intented as a utility call for uniformly applying
shaders to groups and other potential visual effects. It requires that
the <a class="link" href="clutter-Features.html#CLUTTER-FEATURE-OFFSCREEN:CAPS"><code class="literal">CLUTTER_FEATURE_OFFSCREEN</code></a> feature is supported by the current backend
and the target system.</p>
<p>Some tips on usage:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p>The source actor must be visible</p></li>
<li class="listitem"><p>The source actor must have a parent in order for it to be
allocated a size from the layouting mechanism. If the source
actor does not have a parent when this function is called then
the ClutterTexture will adopt it and allocate it at its
preferred size. Using this you can clone an actor that is
otherwise not displayed. Because of this feature if you do
intend to display the source actor then you must make sure that
the actor is parented before calling
<a class="link" href="ClutterTexture.html#clutter-texture-new-from-actor" title="clutter_texture_new_from_actor ()"><code class="function">clutter_texture_new_from_actor()</code></a> or that you unparent it before
adding it to a container.</p></li>
<li class="listitem"><p>When getting the image for the clone texture, Clutter
will attempt to render the source actor exactly as it would
appear if it was rendered on screen. The source actor's parent
transformations are taken into account. Therefore if your
source actor is rotated along the X or Y axes so that it has
some depth, the texture will appear differently depending on
the on-screen location of the source actor. While painting the
source actor, Clutter will set up a temporary asymmetric
perspective matrix as the projection matrix so that the source
actor will be projected as if a small section of the screen was
being viewed. Before version 0.8.2, an orthogonal identity
projection was used which meant that the source actor would be
clipped if any part of it was not on the zero Z-plane.</p></li>
<li class="listitem"><p>Avoid reparenting the source with the created texture.</p></li>
<li class="listitem"><p>A group can be padded with a transparent rectangle as to
provide a border to contents for shader output (blurring text
for example).</p></li>
<li class="listitem"><p>The texture will automatically resize to contain a further
transformed source. However, this involves overhead and can be
avoided by placing the source actor in a bounding group
sized large enough to contain any child tranformations.</p></li>
<li class="listitem"><p>Uploading pixel data to the texture (e.g by using
<a class="link" href="ClutterTexture.html#clutter-texture-set-from-file" title="clutter_texture_set_from_file ()"><code class="function">clutter_texture_set_from_file()</code></a>) will destroy the offscreen texture
data and end redirection.</p></li>
<li class="listitem"><p>cogl_texture_get_data() with the handle returned by
<a class="link" href="ClutterTexture.html#clutter-texture-get-cogl-texture" title="clutter_texture_get_cogl_texture ()"><code class="function">clutter_texture_get_cogl_texture()</code></a> can be used to read the
offscreen texture pixels into a pixbuf.</p></li>
</ul></div>
<div class="refsect3">
<a name="clutter-texture-new-from-actor.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>actor</p></td>
<td class="parameter_description"><p>A source <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-texture-new-from-actor.returns"></a><h4>Returns</h4>
<p> A newly created <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> object, or <code class="literal">NULL</code> on failure.</p>
</div>
<p class="since">Since: <a class="link" href="ix05.html#api-index-0.6">0.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-texture-set-from-file"></a><h3>clutter_texture_set_from_file ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_texture_set_from_file (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_texture_set_from_file</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterImage.html" title="ClutterImage"><span class="type">ClutterImage</span></a> and platform-specific image
loading API, like GdkPixbuf, instead</p>
</div>
<p>Sets the <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> image data from an image file. In case of
failure, <code class="literal">FALSE</code> is returned and <em class="parameter"><code>error</code></em>
is set.</p>
<p>If <a class="link" href="ClutterTexture.html#ClutterTexture--load-async" title="The “load-async” property"><span class="type">“load-async”</span></a> is set to <code class="literal">TRUE</code>, this function
will return as soon as possible, and the actual image loading
from disk will be performed asynchronously. <a class="link" href="ClutterTexture.html#ClutterTexture-size-change" title="The “size-change” signal"><span class="type">“size-change”</span></a>
will be emitten when the size of the texture is available and
<a class="link" href="ClutterTexture.html#ClutterTexture-load-finished" title="The “load-finished” signal"><span class="type">“load-finished”</span></a> will be emitted when the image has been
loaded or if an error occurred.</p>
<div class="refsect3">
<a name="clutter-texture-set-from-file.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>texture</p></td>
<td class="parameter_description"><p>A <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>The filename of the image in GLib file name encoding</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Return location for a <span class="type">GError</span>, or <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-texture-set-from-file.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the image was successfully loaded and set</p>
</div>
<p class="since">Since: <a class="link" href="ix06.html#api-index-0.8">0.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-texture-set-from-rgb-data"></a><h3>clutter_texture_set_from_rgb_data ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_texture_set_from_rgb_data (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>,
<em class="parameter"><code>const <span class="type">guchar</span> *data</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> has_alpha</code></em>,
<em class="parameter"><code><span class="type">gint</span> width</code></em>,
<em class="parameter"><code><span class="type">gint</span> height</code></em>,
<em class="parameter"><code><span class="type">gint</span> rowstride</code></em>,
<em class="parameter"><code><span class="type">gint</span> bpp</code></em>,
<em class="parameter"><code><a class="link" href="ClutterTexture.html#ClutterTextureFlags" title="enum ClutterTextureFlags"><span class="type">ClutterTextureFlags</span></a> flags</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_texture_set_from_rgb_data</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterImage.html" title="ClutterImage"><span class="type">ClutterImage</span></a> and <a class="link" href="ClutterImage.html#clutter-image-set-data" title="clutter_image_set_data ()"><code class="function">clutter_image_set_data()</code></a> instead</p>
</div>
<p>Sets <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> image data.</p>
<div class="refsect3">
<a name="clutter-texture-set-from-rgb-data.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>texture</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p> image data in RGBA type colorspace. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>has_alpha</p></td>
<td class="parameter_description"><p>set to <code class="literal">TRUE</code> if image data has an alpha channel.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>width</p></td>
<td class="parameter_description"><p>width in pixels of image data.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>height</p></td>
<td class="parameter_description"><p>height in pixels of image data</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>rowstride</p></td>
<td class="parameter_description"><p>distance in bytes between row starts.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>bpp</p></td>
<td class="parameter_description"><p>bytes per pixel (currently only 3 and 4 supported, depending
on the value of <em class="parameter"><code>has_alpha</code></em>
)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>flags</p></td>
<td class="parameter_description"><p><a class="link" href="ClutterTexture.html#ClutterTextureFlags" title="enum ClutterTextureFlags"><span class="type">ClutterTextureFlags</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-texture-set-from-rgb-data.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> on failure.</p>
</div>
<p class="since">Since: <a class="link" href="ix04.html#api-index-0.4">0.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-texture-set-from-yuv-data"></a><h3>clutter_texture_set_from_yuv_data ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_texture_set_from_yuv_data (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>,
<em class="parameter"><code>const <span class="type">guchar</span> *data</code></em>,
<em class="parameter"><code><span class="type">gint</span> width</code></em>,
<em class="parameter"><code><span class="type">gint</span> height</code></em>,
<em class="parameter"><code><a class="link" href="ClutterTexture.html#ClutterTextureFlags" title="enum ClutterTextureFlags"><span class="type">ClutterTextureFlags</span></a> flags</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_texture_set_from_yuv_data</code> has been deprecated since version 1.10 and should not be used in newly-written code.</p>
<p>Use a custom <a class="link" href="ClutterContent.html" title="ClutterContent"><span class="type">ClutterContent</span></a> implementation and
set up the Cogl pipeline using a <a class="link" href="clutter-Paint-Nodes.html#ClutterPipelineNode"><span class="type">ClutterPipelineNode</span></a> with a
fragment shader instead.</p>
</div>
<p>Sets a <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> from YUV image data. If an error occurred,
<code class="literal">FALSE</code> is returned and <em class="parameter"><code>error</code></em>
is set.</p>
<p>The YUV support depends on the driver; the format supported by the
few drivers exposing this capability are not really useful.</p>
<p>The proper way to convert image data in any YUV colorspace to any
RGB colorspace is to use a fragment shader associated with the
<a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> material.</p>
<div class="refsect3">
<a name="clutter-texture-set-from-yuv-data.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>texture</p></td>
<td class="parameter_description"><p>A <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p> Image data in YUV type colorspace. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>width</p></td>
<td class="parameter_description"><p>Width in pixels of image data.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>height</p></td>
<td class="parameter_description"><p>Height in pixels of image data</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>flags</p></td>
<td class="parameter_description"><p><a class="link" href="ClutterTexture.html#ClutterTextureFlags" title="enum ClutterTextureFlags"><span class="type">ClutterTextureFlags</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-texture-set-from-yuv-data.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the texture was successfully updated</p>
</div>
<p class="since">Since: <a class="link" href="ix04.html#api-index-0.4">0.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-texture-set-area-from-rgb-data"></a><h3>clutter_texture_set_area_from_rgb_data ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_texture_set_area_from_rgb_data
(<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>,
<em class="parameter"><code>const <span class="type">guchar</span> *data</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> has_alpha</code></em>,
<em class="parameter"><code><span class="type">gint</span> x</code></em>,
<em class="parameter"><code><span class="type">gint</span> y</code></em>,
<em class="parameter"><code><span class="type">gint</span> width</code></em>,
<em class="parameter"><code><span class="type">gint</span> height</code></em>,
<em class="parameter"><code><span class="type">gint</span> rowstride</code></em>,
<em class="parameter"><code><span class="type">gint</span> bpp</code></em>,
<em class="parameter"><code><a class="link" href="ClutterTexture.html#ClutterTextureFlags" title="enum ClutterTextureFlags"><span class="type">ClutterTextureFlags</span></a> flags</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_texture_set_area_from_rgb_data</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterImage.html" title="ClutterImage"><span class="type">ClutterImage</span></a> and <a class="link" href="ClutterImage.html#clutter-image-set-area" title="clutter_image_set_area ()"><code class="function">clutter_image_set_area()</code></a> instead</p>
</div>
<p>Updates a sub-region of the pixel data in a <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a>.</p>
<div class="refsect3">
<a name="clutter-texture-set-area-from-rgb-data.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>texture</p></td>
<td class="parameter_description"><p>A <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p> Image data in RGB type colorspace. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>has_alpha</p></td>
<td class="parameter_description"><p>Set to TRUE if image data has an alpha channel.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>x</p></td>
<td class="parameter_description"><p>X coordinate of upper left corner of region to update.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>y</p></td>
<td class="parameter_description"><p>Y coordinate of upper left corner of region to update.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>width</p></td>
<td class="parameter_description"><p>Width in pixels of region to update.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>height</p></td>
<td class="parameter_description"><p>Height in pixels of region to update.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>rowstride</p></td>
<td class="parameter_description"><p>Distance in bytes between row starts on source buffer.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>bpp</p></td>
<td class="parameter_description"><p>bytes per pixel (Currently only 3 and 4 supported,
depending on <em class="parameter"><code>has_alpha</code></em>
)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>flags</p></td>
<td class="parameter_description"><p><a class="link" href="ClutterTexture.html#ClutterTextureFlags" title="enum ClutterTextureFlags"><span class="type">ClutterTextureFlags</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-texture-set-area-from-rgb-data.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> on failure.</p>
</div>
<p class="since">Since: <a class="link" href="ix05.html#api-index-0.6">0.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-texture-get-base-size"></a><h3>clutter_texture_get_base_size ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_texture_get_base_size (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>,
<em class="parameter"><code><span class="type">gint</span> *width</code></em>,
<em class="parameter"><code><span class="type">gint</span> *height</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_texture_get_base_size</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterImage.html" title="ClutterImage"><span class="type">ClutterImage</span></a> and <a class="link" href="ClutterContent.html#clutter-content-get-preferred-size" title="clutter_content_get_preferred_size ()"><code class="function">clutter_content_get_preferred_size()</code></a>
instead</p>
</div>
<p>Gets the size in pixels of the untransformed underlying image</p>
<div class="refsect3">
<a name="clutter-texture-get-base-size.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>texture</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>width</p></td>
<td class="parameter_description"><p> return location for the width, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>height</p></td>
<td class="parameter_description"><p> return location for the height, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="clutter-texture-get-pixel-format"></a><h3>clutter_texture_get_pixel_format ()</h3>
<pre class="programlisting"><span class="returnvalue">CoglPixelFormat</span>
clutter_texture_get_pixel_format (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_texture_get_pixel_format</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>There is no direct replacement for this function</p>
</div>
<p>Retrieves the pixel format used by <em class="parameter"><code>texture</code></em>
. This is
equivalent to:</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="normal">handle </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="ClutterTexture.html#clutter-texture-get-pixel-format">clutter_texture_get_pixel_format</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">texture</span><span class="symbol">);</span>
<span class="keyword">if</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">handle </span><span class="symbol">!=</span><span class="normal"> COGL_INVALID_HANDLE</span><span class="symbol">)</span>
<span class="normal"> format </span><span class="symbol">=</span><span class="normal"> </span><span class="function">cogl_texture_get_format</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">handle</span><span class="symbol">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p></p>
<div class="refsect3">
<a name="clutter-texture-get-pixel-format.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>texture</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-texture-get-pixel-format.returns"></a><h4>Returns</h4>
<p> a <span class="type">CoglPixelFormat</span> value</p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-texture-get-max-tile-waste"></a><h3>clutter_texture_get_max_tile_waste ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>
clutter_texture_get_max_tile_waste (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_texture_get_max_tile_waste</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>No replacement is available</p>
</div>
<p>Gets the maximum waste that will be used when creating a texture or
-1 if slicing is disabled.</p>
<div class="refsect3">
<a name="clutter-texture-get-max-tile-waste.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>texture</p></td>
<td class="parameter_description"><p>A <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-texture-get-max-tile-waste.returns"></a><h4>Returns</h4>
<p> The maximum waste or -1 if the texture waste is
unlimited.</p>
</div>
<p class="since">Since: <a class="link" href="ix06.html#api-index-0.8">0.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-texture-get-filter-quality"></a><h3>clutter_texture_get_filter_quality ()</h3>
<pre class="programlisting"><a class="link" href="ClutterTexture.html#ClutterTextureQuality" title="enum ClutterTextureQuality"><span class="returnvalue">ClutterTextureQuality</span></a>
clutter_texture_get_filter_quality (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_texture_get_filter_quality</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterImage.html" title="ClutterImage"><span class="type">ClutterImage</span></a> and <a class="link" href="ClutterActor.html#clutter-actor-get-content-scaling-filters" title="clutter_actor_get_content_scaling_filters ()"><code class="function">clutter_actor_get_content_scaling_filters()</code></a>
instead</p>
</div>
<p>Gets the filter quality used when scaling a texture.</p>
<div class="refsect3">
<a name="clutter-texture-get-filter-quality.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>texture</p></td>
<td class="parameter_description"><p>A <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-texture-get-filter-quality.returns"></a><h4>Returns</h4>
<p> The filter quality value.</p>
</div>
<p class="since">Since: <a class="link" href="ix06.html#api-index-0.8">0.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-texture-set-filter-quality"></a><h3>clutter_texture_set_filter_quality ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_texture_set_filter_quality (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>,
<em class="parameter"><code><a class="link" href="ClutterTexture.html#ClutterTextureQuality" title="enum ClutterTextureQuality"><span class="type">ClutterTextureQuality</span></a> filter_quality</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_texture_set_filter_quality</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterImage.html" title="ClutterImage"><span class="type">ClutterImage</span></a> and <a class="link" href="ClutterActor.html#clutter-actor-set-content-scaling-filters" title="clutter_actor_set_content_scaling_filters ()"><code class="function">clutter_actor_set_content_scaling_filters()</code></a>
instead</p>
</div>
<p>Sets the filter quality when scaling a texture. The quality is an
enumeration currently the following values are supported:
<a class="link" href="ClutterTexture.html#CLUTTER-TEXTURE-QUALITY-LOW:CAPS"><code class="literal">CLUTTER_TEXTURE_QUALITY_LOW</code></a> which is fast but only uses nearest neighbour
interpolation. <a class="link" href="ClutterTexture.html#CLUTTER-TEXTURE-QUALITY-MEDIUM:CAPS"><code class="literal">CLUTTER_TEXTURE_QUALITY_MEDIUM</code></a> which is computationally a
bit more expensive (bilinear interpolation), and
<a class="link" href="ClutterTexture.html#CLUTTER-TEXTURE-QUALITY-HIGH:CAPS"><code class="literal">CLUTTER_TEXTURE_QUALITY_HIGH</code></a> which uses extra texture memory resources to
improve scaled down rendering as well (by using mipmaps). The default value
is <a class="link" href="ClutterTexture.html#CLUTTER-TEXTURE-QUALITY-MEDIUM:CAPS"><code class="literal">CLUTTER_TEXTURE_QUALITY_MEDIUM</code></a>.</p>
<div class="refsect3">
<a name="clutter-texture-set-filter-quality.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>texture</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>filter_quality</p></td>
<td class="parameter_description"><p>new filter quality value</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix06.html#api-index-0.8">0.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-texture-get-cogl-texture"></a><h3>clutter_texture_get_cogl_texture ()</h3>
<pre class="programlisting"><span class="returnvalue">CoglHandle</span>
clutter_texture_get_cogl_texture (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_texture_get_cogl_texture</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>No replacement available; it's not advisable to
modify the Cogl pipeline of an actor. Use a <a class="link" href="ClutterContent.html" title="ClutterContent"><span class="type">ClutterContent</span></a>
implementation and set up the pipeline during the paint sequence
instead.</p>
</div>
<p>Retrieves the handle to the underlying COGL texture used for drawing
the actor. No extra reference is taken so if you need to keep the
handle then you should call <code class="function">cogl_handle_ref()</code> on it.</p>
<p>The texture handle returned is the first layer of the material
handle used by the <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a>. If you need to access the other
layers you should use <a class="link" href="ClutterTexture.html#clutter-texture-get-cogl-material" title="clutter_texture_get_cogl_material ()"><code class="function">clutter_texture_get_cogl_material()</code></a> instead
and use the <span class="type">CoglMaterial</span> API.</p>
<div class="refsect3">
<a name="clutter-texture-get-cogl-texture.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>texture</p></td>
<td class="parameter_description"><p>A <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-texture-get-cogl-texture.returns"></a><h4>Returns</h4>
<p> a <span class="type">CoglHandle</span> for the texture. The returned
handle is owned by the <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> and it should not be unreferenced. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="ix06.html#api-index-0.8">0.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-texture-set-cogl-texture"></a><h3>clutter_texture_set_cogl_texture ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_texture_set_cogl_texture (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>,
<em class="parameter"><code><span class="type">CoglHandle</span> cogl_tex</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_texture_set_cogl_texture</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>No replacement available; it's not advisable to
modify the Cogl pipeline of an actor. Use a <a class="link" href="ClutterContent.html" title="ClutterContent"><span class="type">ClutterContent</span></a>
implementation and set up the pipeline during the paint sequence
instead.</p>
</div>
<p>Replaces the underlying COGL texture drawn by this actor with
<em class="parameter"><code>cogl_tex</code></em>
. A reference to the texture is taken so if the handle is
no longer needed it should be deref'd with cogl_handle_unref.</p>
<div class="refsect3">
<a name="clutter-texture-set-cogl-texture.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>texture</p></td>
<td class="parameter_description"><p>A <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cogl_tex</p></td>
<td class="parameter_description"><p>A CoglHandle for a texture</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix06.html#api-index-0.8">0.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-texture-get-cogl-material"></a><h3>clutter_texture_get_cogl_material ()</h3>
<pre class="programlisting"><span class="returnvalue">CoglHandle</span>
clutter_texture_get_cogl_material (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_texture_get_cogl_material</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>No replacement is available; it's not advisable
to modify the Cogl pipeline of an actor. Use a <a class="link" href="ClutterContent.html" title="ClutterContent"><span class="type">ClutterContent</span></a>
implementation and modify the pipeline during the paint sequence</p>
</div>
<p>Returns a handle to the underlying COGL material used for drawing
the actor.</p>
<div class="refsect3">
<a name="clutter-texture-get-cogl-material.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>texture</p></td>
<td class="parameter_description"><p>A <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-texture-get-cogl-material.returns"></a><h4>Returns</h4>
<p> a handle for a <span class="type">CoglMaterial</span>. The
material is owned by the <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> and it should not be
unreferenced. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-texture-set-cogl-material"></a><h3>clutter_texture_set_cogl_material ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_texture_set_cogl_material (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>,
<em class="parameter"><code><span class="type">CoglHandle</span> cogl_material</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_texture_set_cogl_material</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>No replacement is available; it's not advisable
to modify the Cogl pipeline of an actor. Use a <a class="link" href="ClutterContent.html" title="ClutterContent"><span class="type">ClutterContent</span></a>
implementation and modify the pipeline during the paint sequence</p>
</div>
<p>Replaces the underlying Cogl material drawn by this actor with
<em class="parameter"><code>cogl_material</code></em>
. A reference to the material is taken so if the
handle is no longer needed it should be deref'd with
cogl_handle_unref. Texture data is attached to the material so
calling this function also replaces the Cogl
texture. <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> requires that the material have a texture
layer so you should set one on the material before calling this
function.</p>
<div class="refsect3">
<a name="clutter-texture-set-cogl-material.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>texture</p></td>
<td class="parameter_description"><p>A <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cogl_material</p></td>
<td class="parameter_description"><p>A CoglHandle for a material</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix06.html#api-index-0.8">0.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-texture-get-sync-size"></a><h3>clutter_texture_get_sync_size ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_texture_get_sync_size (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_texture_get_sync_size</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>There is no direct replacement</p>
</div>
<p>Retrieves the value set with <a class="link" href="ClutterTexture.html#clutter-texture-set-sync-size" title="clutter_texture_set_sync_size ()"><code class="function">clutter_texture_set_sync_size()</code></a></p>
<div class="refsect3">
<a name="clutter-texture-get-sync-size.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>texture</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-texture-get-sync-size.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> should have the same
preferred size of the underlying image data</p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-texture-set-sync-size"></a><h3>clutter_texture_set_sync_size ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_texture_set_sync_size (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> sync_size</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_texture_set_sync_size</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>No replacement is available. A <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> using
<a class="link" href="ClutterImage.html" title="ClutterImage"><span class="type">ClutterImage</span></a> with a <a class="link" href="ClutterActor.html#CLUTTER-REQUEST-CONTENT-SIZE:CAPS"><code class="literal">CLUTTER_REQUEST_CONTENT_SIZE</code></a> request mode
will automatically bind the preferred size of the content to the
preferred size of the actor</p>
</div>
<p>Sets whether <em class="parameter"><code>texture</code></em>
should have the same preferred size as the
underlying image data.</p>
<div class="refsect3">
<a name="clutter-texture-set-sync-size.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>texture</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>sync_size</p></td>
<td class="parameter_description"><p><code class="literal">TRUE</code> if the texture should have the same size of the
underlying image data</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-texture-get-repeat"></a><h3>clutter_texture_get_repeat ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_texture_get_repeat (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> *repeat_x</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> *repeat_y</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_texture_get_repeat</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterImage.html" title="ClutterImage"><span class="type">ClutterImage</span></a> and <a class="link" href="ClutterActor.html#clutter-actor-get-content-repeat" title="clutter_actor_get_content_repeat ()"><code class="function">clutter_actor_get_content_repeat()</code></a>
instead</p>
</div>
<p>Retrieves the horizontal and vertical repeat values set
using <a class="link" href="ClutterTexture.html#clutter-texture-set-repeat" title="clutter_texture_set_repeat ()"><code class="function">clutter_texture_set_repeat()</code></a></p>
<div class="refsect3">
<a name="clutter-texture-get-repeat.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>texture</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>repeat_x</p></td>
<td class="parameter_description"><p> return location for the horizontal repeat. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>repeat_y</p></td>
<td class="parameter_description"><p> return location for the vertical repeat. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-texture-set-repeat"></a><h3>clutter_texture_set_repeat ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_texture_set_repeat (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> repeat_x</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> repeat_y</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_texture_set_repeat</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterImage.html" title="ClutterImage"><span class="type">ClutterImage</span></a> and <a class="link" href="ClutterActor.html#clutter-actor-set-content-repeat" title="clutter_actor_set_content_repeat ()"><code class="function">clutter_actor_set_content_repeat()</code></a>
instead</p>
</div>
<p>Sets whether the <em class="parameter"><code>texture</code></em>
should repeat horizontally or
vertically when the actor size is bigger than the image size</p>
<div class="refsect3">
<a name="clutter-texture-set-repeat.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>texture</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>repeat_x</p></td>
<td class="parameter_description"><p><code class="literal">TRUE</code> if the texture should repeat horizontally</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>repeat_y</p></td>
<td class="parameter_description"><p><code class="literal">TRUE</code> if the texture should repeat vertically</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-texture-get-keep-aspect-ratio"></a><h3>clutter_texture_get_keep_aspect_ratio ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_texture_get_keep_aspect_ratio (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_texture_get_keep_aspect_ratio</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterImage.html" title="ClutterImage"><span class="type">ClutterImage</span></a> and <a class="link" href="ClutterActor.html#clutter-actor-get-content-gravity" title="clutter_actor_get_content_gravity ()"><code class="function">clutter_actor_get_content_gravity()</code></a>
instead</p>
</div>
<p>Retrieves the value set using <a class="link" href="ClutterTexture.html#clutter-texture-set-keep-aspect-ratio" title="clutter_texture_set_keep_aspect_ratio ()"><code class="function">clutter_texture_set_keep_aspect_ratio()</code></a></p>
<div class="refsect3">
<a name="clutter-texture-get-keep-aspect-ratio.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>texture</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-texture-get-keep-aspect-ratio.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> should maintain the
aspect ratio of the underlying image</p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-texture-set-keep-aspect-ratio"></a><h3>clutter_texture_set_keep_aspect_ratio ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_texture_set_keep_aspect_ratio (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> keep_aspect</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_texture_set_keep_aspect_ratio</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterImage.html" title="ClutterImage"><span class="type">ClutterImage</span></a> and <a class="link" href="ClutterActor.html#clutter-actor-set-content-gravity" title="clutter_actor_set_content_gravity ()"><code class="function">clutter_actor_set_content_gravity()</code></a>
with <a class="link" href="ClutterActor.html#CLUTTER-CONTENT-GRAVITY-RESIZE-ASPECT:CAPS"><code class="literal">CLUTTER_CONTENT_GRAVITY_RESIZE_ASPECT</code></a> instead</p>
</div>
<p>Sets whether <em class="parameter"><code>texture</code></em>
should have a preferred size maintaining
the aspect ratio of the underlying image</p>
<div class="refsect3">
<a name="clutter-texture-set-keep-aspect-ratio.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>texture</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>keep_aspect</p></td>
<td class="parameter_description"><p><code class="literal">TRUE</code> to maintain aspect ratio</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-texture-get-load-async"></a><h3>clutter_texture_get_load_async ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_texture_get_load_async (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_texture_get_load_async</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>There is no direct replacement for this function</p>
</div>
<p>Retrieves the value set using <a class="link" href="ClutterTexture.html#clutter-texture-set-load-async" title="clutter_texture_set_load_async ()"><code class="function">clutter_texture_set_load_async()</code></a></p>
<div class="refsect3">
<a name="clutter-texture-get-load-async.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>texture</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-texture-get-load-async.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> should load the data from
disk asynchronously</p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-texture-set-load-async"></a><h3>clutter_texture_set_load_async ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_texture_set_load_async (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> load_async</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_texture_set_load_async</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>There is no direct replacement for this function.
Use <a class="link" href="ClutterImage.html" title="ClutterImage"><span class="type">ClutterImage</span></a> and platform-specific API for loading image data
asynchronously, like GdkPixbuf</p>
</div>
<p>Sets whether <em class="parameter"><code>texture</code></em>
should use a worker thread to load the data
from disk asynchronously. Setting <em class="parameter"><code>load_async</code></em>
to <code class="literal">TRUE</code> will make
<a class="link" href="ClutterTexture.html#clutter-texture-set-from-file" title="clutter_texture_set_from_file ()"><code class="function">clutter_texture_set_from_file()</code></a> return immediately.</p>
<p>See the <a class="link" href="ClutterTexture.html#ClutterTexture--load-async" title="The “load-async” property"><span class="type">“load-async”</span></a> property documentation, and
<a class="link" href="ClutterTexture.html#clutter-texture-set-load-data-async" title="clutter_texture_set_load_data_async ()"><code class="function">clutter_texture_set_load_data_async()</code></a>.</p>
<div class="refsect3">
<a name="clutter-texture-set-load-async.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>texture</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>load_async</p></td>
<td class="parameter_description"><p><code class="literal">TRUE</code> if the texture should asynchronously load data
from a filename</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-texture-get-load-data-async"></a><h3>clutter_texture_get_load_data_async ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_texture_get_load_data_async (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_texture_get_load_data_async</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>There is no direct replacement for this function</p>
</div>
<p>Retrieves the value set by <a class="link" href="ClutterTexture.html#clutter-texture-set-load-data-async" title="clutter_texture_set_load_data_async ()"><code class="function">clutter_texture_set_load_data_async()</code></a></p>
<div class="refsect3">
<a name="clutter-texture-get-load-data-async.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>texture</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-texture-get-load-data-async.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> should load the image
data from a file asynchronously</p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-texture-set-load-data-async"></a><h3>clutter_texture_set_load_data_async ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_texture_set_load_data_async (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> load_async</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_texture_set_load_data_async</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>There is no direct replacement for this function.
Use <a class="link" href="ClutterImage.html" title="ClutterImage"><span class="type">ClutterImage</span></a> and platform-specific API for loading image data
asynchronously, like GdkPixbuf</p>
</div>
<p>Sets whether <em class="parameter"><code>texture</code></em>
should use a worker thread to load the data
from disk asynchronously. Setting <em class="parameter"><code>load_async</code></em>
to <code class="literal">TRUE</code> will make
<a class="link" href="ClutterTexture.html#clutter-texture-set-from-file" title="clutter_texture_set_from_file ()"><code class="function">clutter_texture_set_from_file()</code></a> block until the <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> has
determined the width and height of the image data.</p>
<p>See the <a class="link" href="ClutterTexture.html#ClutterTexture--load-async" title="The “load-async” property"><span class="type">“load-async”</span></a> property documentation, and
<a class="link" href="ClutterTexture.html#clutter-texture-set-load-async" title="clutter_texture_set_load_async ()"><code class="function">clutter_texture_set_load_async()</code></a>.</p>
<div class="refsect3">
<a name="clutter-texture-set-load-data-async.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>texture</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>load_async</p></td>
<td class="parameter_description"><p><code class="literal">TRUE</code> if the texture should asynchronously load data
from a filename</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-texture-get-pick-with-alpha"></a><h3>clutter_texture_get_pick_with_alpha ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_texture_get_pick_with_alpha (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_texture_get_pick_with_alpha</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>There is no direct replacement for this function</p>
</div>
<p>Retrieves the value set by <a class="link" href="ClutterTexture.html#clutter-texture-set-load-data-async" title="clutter_texture_set_load_data_async ()"><code class="function">clutter_texture_set_load_data_async()</code></a></p>
<div class="refsect3">
<a name="clutter-texture-get-pick-with-alpha.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>texture</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-texture-get-pick-with-alpha.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> should define its shape
using the alpha channel when picking.</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-texture-set-pick-with-alpha"></a><h3>clutter_texture_set_pick_with_alpha ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_texture_set_pick_with_alpha (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> pick_with_alpha</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_texture_set_pick_with_alpha</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>There is no direct replacement for this function</p>
</div>
<p>Sets whether <em class="parameter"><code>texture</code></em>
should have it's shape defined by the alpha
channel when picking.</p>
<p>Be aware that this is a bit more costly than the default picking
due to the texture lookup, extra test against the alpha value and
the fact that it will also interrupt the batching of geometry done
internally.</p>
<p>Also there is currently no control over the threshold used to
determine what value of alpha is considered pickable, and so only
fully opaque parts of the texture will react to picking.</p>
<div class="refsect3">
<a name="clutter-texture-set-pick-with-alpha.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>texture</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>pick_with_alpha</p></td>
<td class="parameter_description"><p><code class="literal">TRUE</code> if the alpha channel should affect the
picking shape</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>
</div>
<div class="refsect1">
<a name="ClutterTexture.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="ClutterTexture-struct"></a><h3>struct ClutterTexture</h3>
<pre class="programlisting">struct ClutterTexture;</pre>
<p>The <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> structure contains only private data
and should be accessed using the provided API</p>
<p class="since">Since: <a class="link" href="ix03.html#api-index-0.2">0.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterTextureClass"></a><h3>struct ClutterTextureClass</h3>
<pre class="programlisting">struct ClutterTextureClass {
void (* size_change) (ClutterTexture *texture,
gint width,
gint height);
void (* pixbuf_change) (ClutterTexture *texture);
void (* load_finished) (ClutterTexture *texture,
const GError *error);
};
</pre>
<p>The <a class="link" href="ClutterTexture.html#ClutterTextureClass" title="struct ClutterTextureClass"><span class="type">ClutterTextureClass</span></a> structure contains only private data</p>
<div class="refsect3">
<a name="ClutterTextureClass.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterTextureClass.size-change"></a>size_change</code></em> ()</p></td>
<td class="struct_member_description"><p>handler for the <a class="link" href="ClutterTexture.html#ClutterTexture-size-change" title="The “size-change” signal"><span class="type">“size-change”</span></a> signal</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterTextureClass.pixbuf-change"></a>pixbuf_change</code></em> ()</p></td>
<td class="struct_member_description"><p>handler for the <a class="link" href="ClutterTexture.html#ClutterTexture-pixbuf-change" title="The “pixbuf-change” signal"><span class="type">“pixbuf-change”</span></a> signal</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterTextureClass.load-finished"></a>load_finished</code></em> ()</p></td>
<td class="struct_member_description"><p>handler for the <a class="link" href="ClutterTexture.html#ClutterTexture-load-finished" title="The “load-finished” signal"><span class="type">“load-finished”</span></a> signal</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix03.html#api-index-0.2">0.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterTextureFlags"></a><h3>enum ClutterTextureFlags</h3>
<div class="warning">
<p><code class="literal">ClutterTextureFlags</code> has been deprecated since version 1.22 and should not be used in newly-written code.</p>
<p>The <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> class was the only user of
this API</p>
</div>
<p>Flags for <a class="link" href="ClutterTexture.html#clutter-texture-set-from-rgb-data" title="clutter_texture_set_from_rgb_data ()"><code class="function">clutter_texture_set_from_rgb_data()</code></a> and
<a class="link" href="ClutterTexture.html#clutter-texture-set-from-yuv-data" title="clutter_texture_set_from_yuv_data ()"><code class="function">clutter_texture_set_from_yuv_data()</code></a>.</p>
<div class="refsect3">
<a name="ClutterTextureFlags.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-TEXTURE-NONE:CAPS"></a>CLUTTER_TEXTURE_NONE</p></td>
<td class="enum_member_description">
<p>No flags</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-TEXTURE-RGB-FLAG-BGR:CAPS"></a>CLUTTER_TEXTURE_RGB_FLAG_BGR</p></td>
<td class="enum_member_description">
<p>Unused flag</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-TEXTURE-RGB-FLAG-PREMULT:CAPS"></a>CLUTTER_TEXTURE_RGB_FLAG_PREMULT</p></td>
<td class="enum_member_description">
<p>Unused flag</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-TEXTURE-YUV-FLAG-YUV2:CAPS"></a>CLUTTER_TEXTURE_YUV_FLAG_YUV2</p></td>
<td class="enum_member_description">
<p>Unused flag</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix04.html#api-index-0.4">0.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterTextureQuality"></a><h3>enum ClutterTextureQuality</h3>
<div class="warning">
<p><code class="literal">ClutterTextureQuality</code> has been deprecated since version 1.22 and should not be used in newly-written code.</p>
<p>The <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> class was the only used ot
this API; use <a class="link" href="ClutterImage.html" title="ClutterImage"><span class="type">ClutterImage</span></a> and <a class="link" href="ClutterActor.html#clutter-actor-set-content-scaling-filters" title="clutter_actor_set_content_scaling_filters ()"><code class="function">clutter_actor_set_content_scaling_filters()</code></a>
instead.</p>
</div>
<p>Enumaration controlling the texture quality.</p>
<div class="refsect3">
<a name="ClutterTextureQuality.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-TEXTURE-QUALITY-LOW:CAPS"></a>CLUTTER_TEXTURE_QUALITY_LOW</p></td>
<td class="enum_member_description">
<p>fastest rendering will use nearest neighbour
interpolation when rendering. good setting.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-TEXTURE-QUALITY-MEDIUM:CAPS"></a>CLUTTER_TEXTURE_QUALITY_MEDIUM</p></td>
<td class="enum_member_description">
<p>higher quality rendering without using
extra resources.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-TEXTURE-QUALITY-HIGH:CAPS"></a>CLUTTER_TEXTURE_QUALITY_HIGH</p></td>
<td class="enum_member_description">
<p>render the texture with the best quality
available using extra memory.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix06.html#api-index-0.8">0.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="CLUTTER-TEXTURE-ERROR:CAPS"></a><h3>CLUTTER_TEXTURE_ERROR</h3>
<pre class="programlisting">#define CLUTTER_TEXTURE_ERROR (clutter_texture_error_quark ())
</pre>
<p>Error domain for <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> errors</p>
<p class="since">Since: <a class="link" href="ix04.html#api-index-0.4">0.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterTextureError"></a><h3>enum ClutterTextureError</h3>
<p>Error enumeration for <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a></p>
<div class="refsect3">
<a name="ClutterTextureError.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-TEXTURE-ERROR-OUT-OF-MEMORY:CAPS"></a>CLUTTER_TEXTURE_ERROR_OUT_OF_MEMORY</p></td>
<td class="enum_member_description">
<p>OOM condition</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-TEXTURE-ERROR-NO-YUV:CAPS"></a>CLUTTER_TEXTURE_ERROR_NO_YUV</p></td>
<td class="enum_member_description">
<p>YUV operation attempted but no YUV support
found</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-TEXTURE-ERROR-BAD-FORMAT:CAPS"></a>CLUTTER_TEXTURE_ERROR_BAD_FORMAT</p></td>
<td class="enum_member_description">
<p>The requested format for
clutter_texture_set_from_rgb_data or
clutter_texture_set_from_yuv_data is unsupported.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix04.html#api-index-0.4">0.4</a></p>
</div>
</div>
<div class="refsect1">
<a name="ClutterTexture.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="ClutterTexture--cogl-material"></a><h3>The <code class="literal">“cogl-material”</code> property</h3>
<pre class="programlisting"> “cogl-material” <span class="type">CoglHandle</span> *</pre>
<p>The underlying Cogl material handle used to draw this actor.</p>
<p>Flags: Read / Write</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterTexture--cogl-texture"></a><h3>The <code class="literal">“cogl-texture”</code> property</h3>
<pre class="programlisting"> “cogl-texture” <span class="type">CoglHandle</span> *</pre>
<p>The underlying Cogl texture handle used to draw this actor.</p>
<p>Flags: Read / Write</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterTexture--disable-slicing"></a><h3>The <code class="literal">“disable-slicing”</code> property</h3>
<pre class="programlisting"> “disable-slicing” <span class="type">gboolean</span></pre>
<p>Forces the underlying texture to be singular and not made of smaller space saving individual textures.</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterTexture--filename"></a><h3>The <code class="literal">“filename”</code> property</h3>
<pre class="programlisting"> “filename” <span class="type">gchar</span> *</pre>
<p>The path of the file containing the image data to be displayed by
the texture.</p>
<p>This property is unset when using the clutter_texture_set_from_*_data()
family of functions.</p>
<div class="warning">
<p><code class="literal">ClutterTexture:filename</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterImage.html" title="ClutterImage"><span class="type">ClutterImage</span></a> and platform-specific image loading
API, like GdkPixbuf</p>
</div>
<p>Flags: Read / Write</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterTexture--filter-quality"></a><h3>The <code class="literal">“filter-quality”</code> property</h3>
<pre class="programlisting"> “filter-quality” <a class="link" href="ClutterTexture.html#ClutterTextureQuality" title="enum ClutterTextureQuality"><span class="type">ClutterTextureQuality</span></a></pre>
<p>Rendering quality used when drawing the texture.</p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: CLUTTER_TEXTURE_QUALITY_MEDIUM</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterTexture--keep-aspect-ratio"></a><h3>The <code class="literal">“keep-aspect-ratio”</code> property</h3>
<pre class="programlisting"> “keep-aspect-ratio” <span class="type">gboolean</span></pre>
<p>Keep the aspect ratio of the texture when requesting the preferred width or height.</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterTexture--load-async"></a><h3>The <code class="literal">“load-async”</code> property</h3>
<pre class="programlisting"> “load-async” <span class="type">gboolean</span></pre>
<p>Tries to load a texture from a filename by using a local thread to perform
the read operations. The initially created texture has dimensions 0x0 when
the true size becomes available the <a class="link" href="ClutterTexture.html#ClutterTexture-size-change" title="The “size-change” signal"><span class="type">“size-change”</span></a> signal is
emitted and when the image has completed loading the
<a class="link" href="ClutterTexture.html#ClutterTexture-load-finished" title="The “load-finished” signal"><span class="type">“load-finished”</span></a> signal is emitted.</p>
<p>Threading is only enabled if <code class="function">g_thread_init()</code> has been called prior to
<a class="link" href="clutter-General.html#clutter-init" title="clutter_init ()"><code class="function">clutter_init()</code></a>, otherwise <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> will use the main loop to load
the image.</p>
<p>The upload of the texture data on the GL pipeline is not asynchronous, as
it must be performed from within the same thread that called
<a class="link" href="clutter-General.html#clutter-main" title="clutter_main ()"><code class="function">clutter_main()</code></a>.</p>
<div class="warning">
<p><code class="literal">ClutterTexture:load-async</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use platform-specific image loading API, like GdkPixbuf</p>
</div>
<p>Flags: Write</p>
<p>Default value: FALSE</p>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterTexture--load-data-async"></a><h3>The <code class="literal">“load-data-async”</code> property</h3>
<pre class="programlisting"> “load-data-async” <span class="type">gboolean</span></pre>
<p>Like <a class="link" href="ClutterTexture.html#ClutterTexture--load-async" title="The “load-async” property"><span class="type">“load-async”</span></a> but loads the width and height
synchronously causing some blocking.</p>
<div class="warning">
<p><code class="literal">ClutterTexture:load-data-async</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use platform-specific image loading API, like GdkPixbuf</p>
</div>
<p>Flags: Write</p>
<p>Default value: FALSE</p>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterTexture--pick-with-alpha"></a><h3>The <code class="literal">“pick-with-alpha”</code> property</h3>
<pre class="programlisting"> “pick-with-alpha” <span class="type">gboolean</span></pre>
<p>Shape actor with alpha channel when picking.</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterTexture--pixel-format"></a><h3>The <code class="literal">“pixel-format”</code> property</h3>
<pre class="programlisting"> “pixel-format” <span class="type">CoglPixelFormat</span></pre>
<p>The Cogl pixel format to use.</p>
<p>Flags: Read</p>
<p>Default value: COGL_PIXEL_FORMAT_RGBA_8888</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterTexture--repeat-x"></a><h3>The <code class="literal">“repeat-x”</code> property</h3>
<pre class="programlisting"> “repeat-x” <span class="type">gboolean</span></pre>
<p>Repeat the contents rather than scaling them horizontally.</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterTexture--repeat-y"></a><h3>The <code class="literal">“repeat-y”</code> property</h3>
<pre class="programlisting"> “repeat-y” <span class="type">gboolean</span></pre>
<p>Repeat the contents rather than scaling them vertically.</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterTexture--sync-size"></a><h3>The <code class="literal">“sync-size”</code> property</h3>
<pre class="programlisting"> “sync-size” <span class="type">gboolean</span></pre>
<p>Auto sync size of actor to underlying pixbuf dimensions.</p>
<p>Flags: Read / Write</p>
<p>Default value: TRUE</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterTexture--tile-waste"></a><h3>The <code class="literal">“tile-waste”</code> property</h3>
<pre class="programlisting"> “tile-waste” <span class="type">gint</span></pre>
<p>Maximum waste area of a sliced texture.</p>
<p>Flags: Read</p>
<p>Allowed values: >= -1</p>
<p>Default value: 127</p>
</div>
</div>
<div class="refsect1">
<a name="ClutterTexture.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="ClutterTexture-load-finished"></a><h3>The <code class="literal">“load-finished”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture,
<span class="type">GError</span> *error,
<span class="type">gpointer</span> user_data)</pre>
<p>The ::load-finished signal is emitted when a texture load has
completed. If there was an error during loading, <em class="parameter"><code>error</code></em>
will
be set, otherwise it will be <code class="literal">NULL</code></p>
<div class="warning">
<p><code class="literal">ClutterTexture::load-finished</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>No replacement is available</p>
</div>
<div class="refsect3">
<a name="ClutterTexture-load-finished.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>texture</p></td>
<td class="parameter_description"><p>the texture which received the signal</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>A set error, or <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterTexture-pixbuf-change"></a><h3>The <code class="literal">“pixbuf-change”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture,
<span class="type">gpointer</span> user_data)</pre>
<p>The ::pixbuf-change signal is emitted each time the pixbuf
used by <em class="parameter"><code>texture</code></em>
changes.</p>
<div class="warning">
<p><code class="literal">ClutterTexture::pixbuf-change</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>No replacement is available</p>
</div>
<div class="refsect3">
<a name="ClutterTexture-pixbuf-change.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>texture</p></td>
<td class="parameter_description"><p>the texture which received the signal</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterTexture-size-change"></a><h3>The <code class="literal">“size-change”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture,
<span class="type">gint</span> width,
<span class="type">gint</span> height,
<span class="type">gpointer</span> user_data)</pre>
<p>The ::size-change signal is emitted each time the size of the
pixbuf used by <em class="parameter"><code>texture</code></em>
changes. The new size is given as
argument to the callback.</p>
<div class="warning">
<p><code class="literal">ClutterTexture::size-change</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>No replacement is available</p>
</div>
<div class="refsect3">
<a name="ClutterTexture-size-change.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>texture</p></td>
<td class="parameter_description"><p>the texture which received the signal</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>width</p></td>
<td class="parameter_description"><p>the width of the new texture</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>height</p></td>
<td class="parameter_description"><p>the height of the new texture</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25.1</div>
</body>
</html>