1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>ClutterTexture</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7 <link rel="home" href="index.html" title="Clutter Reference Manual">
8 <link rel="up" href="ch02.html" title="Base actors">
9 <link rel="prev" href="ClutterStage.html" title="ClutterStage">
10 <link rel="next" href="ClutterClone.html" title="ClutterClone">
11 <meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
17 <td><a accesskey="p" href="ClutterStage.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="ch02.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20 <th width="100%" align="center">Clutter Reference Manual</th>
21 <td><a accesskey="n" href="ClutterClone.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#ClutterTexture.synopsis" class="shortcut">Top</a>
26 <a href="#ClutterTexture.description" class="shortcut">Description</a>
28 <a href="#ClutterTexture.object-hierarchy" class="shortcut">Object Hierarchy</a>
30 <a href="#ClutterTexture.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
32 <a href="#ClutterTexture.properties" class="shortcut">Properties</a>
34 <a href="#ClutterTexture.signals" class="shortcut">Signals</a>
37 <div class="refentry">
38 <a name="ClutterTexture"></a><div class="titlepage"></div>
39 <div class="refnamediv"><table width="100%"><tr>
41 <h2><span class="refentrytitle"><a name="ClutterTexture.top_of_page"></a>ClutterTexture</span></h2>
42 <p>ClutterTexture — An actor for displaying and manipulating images.</p>
44 <td valign="top" align="right"></td>
46 <div class="refsynopsisdiv">
47 <a name="ClutterTexture.synopsis"></a><h2>Synopsis</h2>
48 <pre class="synopsis">struct <a class="link" href="ClutterTexture.html#ClutterTexture-struct" title="struct ClutterTexture">ClutterTexture</a>;
49 struct <a class="link" href="ClutterTexture.html#ClutterTextureClass" title="struct ClutterTextureClass">ClutterTextureClass</a>;
50 enum <a class="link" href="ClutterTexture.html#ClutterTextureFlags" title="enum ClutterTextureFlags">ClutterTextureFlags</a>;
51 enum <a class="link" href="ClutterTexture.html#ClutterTextureQuality" title="enum ClutterTextureQuality">ClutterTextureQuality</a>;
52 <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> * <a class="link" href="ClutterTexture.html#clutter-texture-new" title="clutter_texture_new ()">clutter_texture_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
53 <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> * <a class="link" href="ClutterTexture.html#clutter-texture-new-from-file" title="clutter_texture_new_from_file ()">clutter_texture_new_from_file</a> (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>,
54 <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
55 <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> * <a class="link" href="ClutterTexture.html#clutter-texture-new-from-actor" title="clutter_texture_new_from_actor ()">clutter_texture_new_from_actor</a> (<em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *actor</code></em>);
57 #define <a class="link" href="ClutterTexture.html#CLUTTER-TEXTURE-ERROR:CAPS" title="CLUTTER_TEXTURE_ERROR">CLUTTER_TEXTURE_ERROR</a>
58 enum <a class="link" href="ClutterTexture.html#ClutterTextureError" title="enum ClutterTextureError">ClutterTextureError</a>;
59 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="ClutterTexture.html#clutter-texture-set-from-file" title="clutter_texture_set_from_file ()">clutter_texture_set_from_file</a> (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>,
60 <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>,
61 <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
62 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <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> (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>,
63 <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> *data</code></em>,
64 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> has_alpha</code></em>,
65 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> width</code></em>,
66 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> height</code></em>,
67 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> rowstride</code></em>,
68 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> bpp</code></em>,
69 <em class="parameter"><code><a class="link" href="ClutterTexture.html#ClutterTextureFlags" title="enum ClutterTextureFlags"><span class="type">ClutterTextureFlags</span></a> flags</code></em>,
70 <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
71 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <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> (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>,
72 <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> *data</code></em>,
73 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> width</code></em>,
74 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> height</code></em>,
75 <em class="parameter"><code><a class="link" href="ClutterTexture.html#ClutterTextureFlags" title="enum ClutterTextureFlags"><span class="type">ClutterTextureFlags</span></a> flags</code></em>,
76 <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
77 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <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>
78 (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>,
79 <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> *data</code></em>,
80 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> has_alpha</code></em>,
81 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> x</code></em>,
82 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> y</code></em>,
83 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> width</code></em>,
84 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> height</code></em>,
85 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> rowstride</code></em>,
86 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> bpp</code></em>,
87 <em class="parameter"><code><a class="link" href="ClutterTexture.html#ClutterTextureFlags" title="enum ClutterTextureFlags"><span class="type">ClutterTextureFlags</span></a> flags</code></em>,
88 <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
90 <span class="returnvalue">void</span> <a class="link" href="ClutterTexture.html#clutter-texture-get-base-size" title="clutter_texture_get_base_size ()">clutter_texture_get_base_size</a> (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>,
91 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *width</code></em>,
92 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *height</code></em>);
93 <span class="returnvalue">CoglPixelFormat</span> <a class="link" href="ClutterTexture.html#clutter-texture-get-pixel-format" title="clutter_texture_get_pixel_format ()">clutter_texture_get_pixel_format</a> (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>);
94 <a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> <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> (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>);
96 <a class="link" href="ClutterTexture.html#ClutterTextureQuality" title="enum ClutterTextureQuality"><span class="returnvalue">ClutterTextureQuality</span></a> <a class="link" href="ClutterTexture.html#clutter-texture-get-filter-quality" title="clutter_texture_get_filter_quality ()">clutter_texture_get_filter_quality</a>
97 (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>);
98 <span class="returnvalue">void</span> <a class="link" href="ClutterTexture.html#clutter-texture-set-filter-quality" title="clutter_texture_set_filter_quality ()">clutter_texture_set_filter_quality</a> (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>,
99 <em class="parameter"><code><a class="link" href="ClutterTexture.html#ClutterTextureQuality" title="enum ClutterTextureQuality"><span class="type">ClutterTextureQuality</span></a> filter_quality</code></em>);
100 <span class="returnvalue">CoglHandle</span> <a class="link" href="ClutterTexture.html#clutter-texture-get-cogl-texture" title="clutter_texture_get_cogl_texture ()">clutter_texture_get_cogl_texture</a> (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>);
101 <span class="returnvalue">void</span> <a class="link" href="ClutterTexture.html#clutter-texture-set-cogl-texture" title="clutter_texture_set_cogl_texture ()">clutter_texture_set_cogl_texture</a> (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>,
102 <em class="parameter"><code><span class="type">CoglHandle</span> cogl_tex</code></em>);
103 <span class="returnvalue">CoglHandle</span> <a class="link" href="ClutterTexture.html#clutter-texture-get-cogl-material" title="clutter_texture_get_cogl_material ()">clutter_texture_get_cogl_material</a> (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>);
104 <span class="returnvalue">void</span> <a class="link" href="ClutterTexture.html#clutter-texture-set-cogl-material" title="clutter_texture_set_cogl_material ()">clutter_texture_set_cogl_material</a> (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>,
105 <em class="parameter"><code><span class="type">CoglHandle</span> cogl_material</code></em>);
106 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="ClutterTexture.html#clutter-texture-get-sync-size" title="clutter_texture_get_sync_size ()">clutter_texture_get_sync_size</a> (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>);
107 <span class="returnvalue">void</span> <a class="link" href="ClutterTexture.html#clutter-texture-set-sync-size" title="clutter_texture_set_sync_size ()">clutter_texture_set_sync_size</a> (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>,
108 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> sync_size</code></em>);
109 <span class="returnvalue">void</span> <a class="link" href="ClutterTexture.html#clutter-texture-get-repeat" title="clutter_texture_get_repeat ()">clutter_texture_get_repeat</a> (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>,
110 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *repeat_x</code></em>,
111 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *repeat_y</code></em>);
112 <span class="returnvalue">void</span> <a class="link" href="ClutterTexture.html#clutter-texture-set-repeat" title="clutter_texture_set_repeat ()">clutter_texture_set_repeat</a> (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>,
113 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> repeat_x</code></em>,
114 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> repeat_y</code></em>);
115 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <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>
116 (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>);
117 <span class="returnvalue">void</span> <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>
118 (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>,
119 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> keep_aspect</code></em>);
120 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="ClutterTexture.html#clutter-texture-get-load-async" title="clutter_texture_get_load_async ()">clutter_texture_get_load_async</a> (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>);
121 <span class="returnvalue">void</span> <a class="link" href="ClutterTexture.html#clutter-texture-set-load-async" title="clutter_texture_set_load_async ()">clutter_texture_set_load_async</a> (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>,
122 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> load_async</code></em>);
123 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <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> (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>);
124 <span class="returnvalue">void</span> <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> (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>,
125 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> load_async</code></em>);
126 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <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> (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>);
127 <span class="returnvalue">void</span> <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> (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>,
128 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> pick_with_alpha</code></em>);
131 <div class="refsect1">
132 <a name="ClutterTexture.object-hierarchy"></a><h2>Object Hierarchy</h2>
133 <pre class="synopsis">
134 <a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
135 +----<a href="../gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
136 +----<a class="link" href="ClutterActor.html" title="ClutterActor">ClutterActor</a>
138 +----<a class="link" href="ClutterCairoTexture.html" title="ClutterCairoTexture">ClutterCairoTexture</a>
141 <div class="refsect1">
142 <a name="ClutterTexture.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
144 ClutterTexture implements
145 <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>
147 <div class="refsect1">
148 <a name="ClutterTexture.properties"></a><h2>Properties</h2>
149 <pre class="synopsis">
150 "<a class="link" href="ClutterTexture.html#ClutterTexture--cogl-material" title='The "cogl-material" property'>cogl-material</a>" <span class="type">CoglHandle</span>* : Read / Write
151 "<a class="link" href="ClutterTexture.html#ClutterTexture--cogl-texture" title='The "cogl-texture" property'>cogl-texture</a>" <span class="type">CoglHandle</span>* : Read / Write
152 "<a class="link" href="ClutterTexture.html#ClutterTexture--disable-slicing" title='The "disable-slicing" property'>disable-slicing</a>" <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write / Construct Only
153 "<a class="link" href="ClutterTexture.html#ClutterTexture--filename" title='The "filename" property'>filename</a>" <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write
154 "<a class="link" href="ClutterTexture.html#ClutterTexture--filter-quality" title='The "filter-quality" property'>filter-quality</a>" <a class="link" href="ClutterTexture.html#ClutterTextureQuality" title="enum ClutterTextureQuality"><span class="type">ClutterTextureQuality</span></a> : Read / Write / Construct
155 "<a class="link" href="ClutterTexture.html#ClutterTexture--keep-aspect-ratio" title='The "keep-aspect-ratio" property'>keep-aspect-ratio</a>" <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
156 "<a class="link" href="ClutterTexture.html#ClutterTexture--load-async" title='The "load-async" property'>load-async</a>" <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Write
157 "<a class="link" href="ClutterTexture.html#ClutterTexture--load-data-async" title='The "load-data-async" property'>load-data-async</a>" <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Write
158 "<a class="link" href="ClutterTexture.html#ClutterTexture--pick-with-alpha" title='The "pick-with-alpha" property'>pick-with-alpha</a>" <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
159 "<a class="link" href="ClutterTexture.html#ClutterTexture--pixel-format" title='The "pixel-format" property'>pixel-format</a>" <span class="type">CoglPixelFormat</span> : Read
160 "<a class="link" href="ClutterTexture.html#ClutterTexture--repeat-x" title='The "repeat-x" property'>repeat-x</a>" <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
161 "<a class="link" href="ClutterTexture.html#ClutterTexture--repeat-y" title='The "repeat-y" property'>repeat-y</a>" <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
162 "<a class="link" href="ClutterTexture.html#ClutterTexture--sync-size" title='The "sync-size" property'>sync-size</a>" <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
163 "<a class="link" href="ClutterTexture.html#ClutterTexture--tile-waste" title='The "tile-waste" property'>tile-waste</a>" <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read
166 <div class="refsect1">
167 <a name="ClutterTexture.signals"></a><h2>Signals</h2>
168 <pre class="synopsis">
169 "<a class="link" href="ClutterTexture.html#ClutterTexture-load-finished" title='The "load-finished" signal'>load-finished</a>" : <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
170 "<a class="link" href="ClutterTexture.html#ClutterTexture-pixbuf-change" title='The "pixbuf-change" signal'>pixbuf-change</a>" : <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
171 "<a class="link" href="ClutterTexture.html#ClutterTexture-size-change" title='The "size-change" signal'>size-change</a>" : <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
174 <div class="refsect1">
175 <a name="ClutterTexture.description"></a><h2>Description</h2>
177 <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> is a base class for displaying and manipulating pixel
181 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
182 <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
183 data into texture memory and subsequently realize the texture.
186 Note: a ClutterTexture will scale its contents to fit the bounding
187 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
188 a texture without scaling, you should set the clip area using
189 <a class="link" href="ClutterActor.html#clutter-actor-set-clip" title="clutter_actor_set_clip ()"><code class="function">clutter_actor_set_clip()</code></a>.
192 <div class="refsect1">
193 <a name="ClutterTexture.details"></a><h2>Details</h2>
194 <div class="refsect2">
195 <a name="ClutterTexture-struct"></a><h3>struct ClutterTexture</h3>
196 <pre class="programlisting">struct ClutterTexture;</pre>
198 The <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> structure contains only private data
199 and should be accessed using the provided API
201 <p class="since">Since 0.1</p>
204 <div class="refsect2">
205 <a name="ClutterTextureClass"></a><h3>struct ClutterTextureClass</h3>
206 <pre class="programlisting">struct ClutterTextureClass {
207 void (* size_change) (ClutterTexture *texture,
210 void (* pixbuf_change) (ClutterTexture *texture);
211 void (* load_finished) (ClutterTexture *texture,
212 const GError *error);
216 The <a class="link" href="ClutterTexture.html#ClutterTextureClass" title="struct ClutterTextureClass"><span class="type">ClutterTextureClass</span></a> structure contains only private data
218 <div class="variablelist"><table border="0">
219 <col align="left" valign="top">
222 <td><p><span class="term"><em class="structfield"><code><a name="ClutterTextureClass.size-change"></a>size_change</code></em> ()</span></p></td>
223 <td>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</td>
226 <td><p><span class="term"><em class="structfield"><code><a name="ClutterTextureClass.pixbuf-change"></a>pixbuf_change</code></em> ()</span></p></td>
227 <td>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</td>
230 <td><p><span class="term"><em class="structfield"><code><a name="ClutterTextureClass.load-finished"></a>load_finished</code></em> ()</span></p></td>
231 <td>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</td>
235 <p class="since">Since 0.1</p>
238 <div class="refsect2">
239 <a name="ClutterTextureFlags"></a><h3>enum ClutterTextureFlags</h3>
240 <pre class="programlisting">typedef enum {
241 /*< prefix=CLUTTER_TEXTURE >*/
242 CLUTTER_TEXTURE_NONE = 0,
243 CLUTTER_TEXTURE_RGB_FLAG_BGR = 1 << 1,
244 CLUTTER_TEXTURE_RGB_FLAG_PREMULT = 1 << 2, /* FIXME: not handled */
245 CLUTTER_TEXTURE_YUV_FLAG_YUV2 = 1 << 3
247 /* FIXME: add compressed types ? */
248 } ClutterTextureFlags;
251 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
252 <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>.
254 <div class="variablelist"><table border="0">
255 <col align="left" valign="top">
258 <td><p><a name="CLUTTER-TEXTURE-NONE:CAPS"></a><span class="term"><code class="literal">CLUTTER_TEXTURE_NONE</code></span></p></td>
263 <td><p><a name="CLUTTER-TEXTURE-RGB-FLAG-BGR:CAPS"></a><span class="term"><code class="literal">CLUTTER_TEXTURE_RGB_FLAG_BGR</code></span></p></td>
268 <td><p><a name="CLUTTER-TEXTURE-RGB-FLAG-PREMULT:CAPS"></a><span class="term"><code class="literal">CLUTTER_TEXTURE_RGB_FLAG_PREMULT</code></span></p></td>
273 <td><p><a name="CLUTTER-TEXTURE-YUV-FLAG-YUV2:CAPS"></a><span class="term"><code class="literal">CLUTTER_TEXTURE_YUV_FLAG_YUV2</code></span></p></td>
279 <p class="since">Since 0.4</p>
282 <div class="refsect2">
283 <a name="ClutterTextureQuality"></a><h3>enum ClutterTextureQuality</h3>
284 <pre class="programlisting">typedef enum {
285 /*< prefix=CLUTTER_TEXTURE_QUALITY >*/
286 CLUTTER_TEXTURE_QUALITY_LOW,
287 CLUTTER_TEXTURE_QUALITY_MEDIUM,
288 CLUTTER_TEXTURE_QUALITY_HIGH
289 } ClutterTextureQuality;
292 Enumaration controlling the texture quality.
294 <div class="variablelist"><table border="0">
295 <col align="left" valign="top">
298 <td><p><a name="CLUTTER-TEXTURE-QUALITY-LOW:CAPS"></a><span class="term"><code class="literal">CLUTTER_TEXTURE_QUALITY_LOW</code></span></p></td>
299 <td>fastest rendering will use nearest neighbour
300 interpolation when rendering. good setting.
304 <td><p><a name="CLUTTER-TEXTURE-QUALITY-MEDIUM:CAPS"></a><span class="term"><code class="literal">CLUTTER_TEXTURE_QUALITY_MEDIUM</code></span></p></td>
305 <td>higher quality rendering without using
310 <td><p><a name="CLUTTER-TEXTURE-QUALITY-HIGH:CAPS"></a><span class="term"><code class="literal">CLUTTER_TEXTURE_QUALITY_HIGH</code></span></p></td>
311 <td>render the texture with the best quality
312 available using extra memory.
317 <p class="since">Since 0.8</p>
320 <div class="refsect2">
321 <a name="clutter-texture-new"></a><h3>clutter_texture_new ()</h3>
322 <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>
324 Creates a new empty <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> object.
326 <div class="variablelist"><table border="0">
327 <col align="left" valign="top">
329 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
330 <td>A newly created <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> object.</td>
335 <div class="refsect2">
336 <a name="clutter-texture-new-from-file"></a><h3>clutter_texture_new_from_file ()</h3>
337 <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 <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>,
338 <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
340 Creates a new ClutterTexture actor to display the image contained a
341 file. If the image failed to load then NULL is returned and <em class="parameter"><code>error</code></em>
344 <div class="variablelist"><table border="0">
345 <col align="left" valign="top">
348 <td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
349 <td>The name of an image file to load.</td>
352 <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
353 <td>Return locatoin for an error.</td>
356 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
357 <td>A newly created <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> object or NULL on
362 <p class="since">Since 0.8</p>
365 <div class="refsect2">
366 <a name="clutter-texture-new-from-actor"></a><h3>clutter_texture_new_from_actor ()</h3>
367 <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>
368 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
369 <h3 class="title">Warning</h3>
370 <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. 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>
371 directly on the intended <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> to replace the functionality of
375 Creates a new <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> object with its source a prexisting
376 actor (and associated children). The textures content will contain
377 'live' redirected output of the actors scene.
380 Note this function is intented as a utility call for uniformly applying
381 shaders to groups and other potential visual effects. It requires that
382 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
383 and the target system.
390 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
391 <li class="listitem"><p>The source actor must be made visible (i.e by calling
392 <a class="link" href="ClutterActor.html#clutter-actor-show" title="clutter_actor_show ()"><span class="type">clutter_actor_show</span></a>).</p></li>
393 <li class="listitem"><p>The source actor must have a parent in order for it to be
394 allocated a size from the layouting mechanism. If the source
395 actor does not have a parent when this function is called then
396 the ClutterTexture will adopt it and allocate it at its
397 preferred size. Using this you can clone an actor that is
398 otherwise not displayed. Because of this feature if you do
399 intend to display the source actor then you must make sure that
400 the actor is parented before calling
401 <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
402 adding it to a container.</p></li>
403 <li class="listitem"><p>When getting the image for the clone texture, Clutter
404 will attempt to render the source actor exactly as it would
405 appear if it was rendered on screen. The source actor's parent
406 transformations are taken into account. Therefore if your
407 source actor is rotated along the X or Y axes so that it has
408 some depth, the texture will appear differently depending on
409 the on-screen location of the source actor. While painting the
410 source actor, Clutter will set up a temporary asymmetric
411 perspective matrix as the projection matrix so that the source
412 actor will be projected as if a small section of the screen was
413 being viewed. Before version 0.8.2, an orthogonal identity
414 projection was used which meant that the source actor would be
415 clipped if any part of it was not on the zero Z-plane.</p></li>
416 <li class="listitem"><p>Avoid reparenting the source with the created texture.</p></li>
417 <li class="listitem"><p>A group can be padded with a transparent rectangle as to
418 provide a border to contents for shader output (blurring text
419 for example).</p></li>
420 <li class="listitem"><p>The texture will automatically resize to contain a further
421 transformed source. However, this involves overhead and can be
422 avoided by placing the source actor in a bounding group
423 sized large enough to contain any child tranformations.</p></li>
424 <li class="listitem"><p>Uploading pixel data to the texture (e.g by using
425 <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
426 data and end redirection.</p></li>
427 <li class="listitem"><p><code class="function">cogl_texture_get_data()</code> with the handle returned by
428 <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
429 offscreen texture pixels into a pixbuf.</p></li>
433 <div class="variablelist"><table border="0">
434 <col align="left" valign="top">
437 <td><p><span class="term"><em class="parameter"><code>actor</code></em> :</span></p></td>
438 <td>A source <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>
442 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
443 <td>A newly created <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> object, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> on failure.</td>
447 <p class="since">Since 0.6</p>
450 <div class="refsect2">
451 <a name="CLUTTER-TEXTURE-ERROR:CAPS"></a><h3>CLUTTER_TEXTURE_ERROR</h3>
452 <pre class="programlisting">#define CLUTTER_TEXTURE_ERROR (clutter_texture_error_quark ())
455 Error domain for <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> errors
457 <p class="since">Since 0.4</p>
460 <div class="refsect2">
461 <a name="ClutterTextureError"></a><h3>enum ClutterTextureError</h3>
462 <pre class="programlisting">typedef enum {
463 CLUTTER_TEXTURE_ERROR_OUT_OF_MEMORY,
464 CLUTTER_TEXTURE_ERROR_NO_YUV,
465 CLUTTER_TEXTURE_ERROR_BAD_FORMAT
466 } ClutterTextureError;
469 Error enumeration for <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a>
471 <div class="variablelist"><table border="0">
472 <col align="left" valign="top">
475 <td><p><a name="CLUTTER-TEXTURE-ERROR-OUT-OF-MEMORY:CAPS"></a><span class="term"><code class="literal">CLUTTER_TEXTURE_ERROR_OUT_OF_MEMORY</code></span></p></td>
480 <td><p><a name="CLUTTER-TEXTURE-ERROR-NO-YUV:CAPS"></a><span class="term"><code class="literal">CLUTTER_TEXTURE_ERROR_NO_YUV</code></span></p></td>
481 <td>YUV operation attempted but no YUV support
486 <td><p><a name="CLUTTER-TEXTURE-ERROR-BAD-FORMAT:CAPS"></a><span class="term"><code class="literal">CLUTTER_TEXTURE_ERROR_BAD_FORMAT</code></span></p></td>
487 <td>The requested format for
488 clutter_texture_set_from_rgb_data or
489 clutter_texture_set_from_yuv_data is unsupported.
494 <p class="since">Since 0.4</p>
497 <div class="refsect2">
498 <a name="clutter-texture-set-from-file"></a><h3>clutter_texture_set_from_file ()</h3>
499 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 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>,
500 <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>,
501 <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
503 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
504 failure, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is returned and <em class="parameter"><code>error</code></em> is set.
507 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 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, this function
508 will return as soon as possible, and the actual image loading
509 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>
510 will be emitten when the size of the texture is available and
511 <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
512 loaded or if an error occurred.
514 <div class="variablelist"><table border="0">
515 <col align="left" valign="top">
518 <td><p><span class="term"><em class="parameter"><code>texture</code></em> :</span></p></td>
519 <td>A <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a>
523 <td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
524 <td>The filename of the image in GLib file name encoding</td>
527 <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
528 <td>Return location for a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>
532 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
534 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the image was successfully loaded and set</td>
538 <p class="since">Since 0.8</p>
541 <div class="refsect2">
542 <a name="clutter-texture-set-from-rgb-data"></a><h3>clutter_texture_set_from_rgb_data ()</h3>
543 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 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>,
544 <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> *data</code></em>,
545 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> has_alpha</code></em>,
546 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> width</code></em>,
547 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> height</code></em>,
548 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> rowstride</code></em>,
549 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> bpp</code></em>,
550 <em class="parameter"><code><a class="link" href="ClutterTexture.html#ClutterTextureFlags" title="enum ClutterTextureFlags"><span class="type">ClutterTextureFlags</span></a> flags</code></em>,
551 <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
553 Sets <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> image data.
555 <div class="variablelist"><table border="0">
556 <col align="left" valign="top">
559 <td><p><span class="term"><em class="parameter"><code>texture</code></em> :</span></p></td>
560 <td>a <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a>
564 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
565 <td>image data in RGBA type colorspace. <span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym>]</span>
569 <td><p><span class="term"><em class="parameter"><code>has_alpha</code></em> :</span></p></td>
570 <td>set to <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if image data has an alpha channel.</td>
573 <td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
574 <td>width in pixels of image data.</td>
577 <td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
578 <td>height in pixels of image data</td>
581 <td><p><span class="term"><em class="parameter"><code>rowstride</code></em> :</span></p></td>
582 <td>distance in bytes between row starts.</td>
585 <td><p><span class="term"><em class="parameter"><code>bpp</code></em> :</span></p></td>
586 <td>bytes per pixel (currently only 3 and 4 supported, depending
587 on the value of <em class="parameter"><code>has_alpha</code></em>)</td>
590 <td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
591 <td><a class="link" href="ClutterTexture.html#ClutterTextureFlags" title="enum ClutterTextureFlags"><span class="type">ClutterTextureFlags</span></a></td>
594 <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
595 <td>return location for a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>.</td>
598 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
600 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on failure.</td>
604 <p class="since">Since 0.4.</p>
607 <div class="refsect2">
608 <a name="clutter-texture-set-from-yuv-data"></a><h3>clutter_texture_set_from_yuv_data ()</h3>
609 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 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>,
610 <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> *data</code></em>,
611 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> width</code></em>,
612 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> height</code></em>,
613 <em class="parameter"><code><a class="link" href="ClutterTexture.html#ClutterTextureFlags" title="enum ClutterTextureFlags"><span class="type">ClutterTextureFlags</span></a> flags</code></em>,
614 <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
615 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
616 <h3 class="title">Warning</h3>
617 <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. 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> and
618 the Cogl API to install a fragment shader for decoding YUV
619 formats on the GPU</p>
622 Sets a <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> from YUV image data. If an error occurred,
623 <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is returned and <em class="parameter"><code>error</code></em> is set.
626 The YUV support depends on the driver; the format supported by the
627 few drivers exposing this capability are not really useful.
630 The proper way to convert image data in any YUV colorspace to any
631 RGB colorspace is to use a fragment shader associated with the
632 <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> material.
634 <div class="variablelist"><table border="0">
635 <col align="left" valign="top">
638 <td><p><span class="term"><em class="parameter"><code>texture</code></em> :</span></p></td>
639 <td>A <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a>
643 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
644 <td>Image data in YUV type colorspace. <span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym>]</span>
648 <td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
649 <td>Width in pixels of image data.</td>
652 <td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
653 <td>Height in pixels of image data</td>
656 <td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
657 <td><a class="link" href="ClutterTexture.html#ClutterTextureFlags" title="enum ClutterTextureFlags"><span class="type">ClutterTextureFlags</span></a></td>
660 <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
661 <td>Return location for a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>.</td>
664 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
666 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the texture was successfully updated</td>
670 <p class="since">Since 0.4</p>
673 <div class="refsect2">
674 <a name="clutter-texture-set-area-from-rgb-data"></a><h3>clutter_texture_set_area_from_rgb_data ()</h3>
675 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> clutter_texture_set_area_from_rgb_data
676 (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>,
677 <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> *data</code></em>,
678 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> has_alpha</code></em>,
679 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> x</code></em>,
680 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> y</code></em>,
681 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> width</code></em>,
682 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> height</code></em>,
683 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> rowstride</code></em>,
684 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> bpp</code></em>,
685 <em class="parameter"><code><a class="link" href="ClutterTexture.html#ClutterTextureFlags" title="enum ClutterTextureFlags"><span class="type">ClutterTextureFlags</span></a> flags</code></em>,
686 <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
688 Updates a sub-region of the pixel data in a <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a>.
690 <div class="variablelist"><table border="0">
691 <col align="left" valign="top">
694 <td><p><span class="term"><em class="parameter"><code>texture</code></em> :</span></p></td>
695 <td>A <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a>
699 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
700 <td>Image data in RGB type colorspace. <span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym>]</span>
704 <td><p><span class="term"><em class="parameter"><code>has_alpha</code></em> :</span></p></td>
705 <td>Set to TRUE if image data has an alpha channel.</td>
708 <td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
709 <td>X coordinate of upper left corner of region to update.</td>
712 <td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
713 <td>Y coordinate of upper left corner of region to update.</td>
716 <td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
717 <td>Width in pixels of region to update.</td>
720 <td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
721 <td>Height in pixels of region to update.</td>
724 <td><p><span class="term"><em class="parameter"><code>rowstride</code></em> :</span></p></td>
725 <td>Distance in bytes between row starts on source buffer.</td>
728 <td><p><span class="term"><em class="parameter"><code>bpp</code></em> :</span></p></td>
729 <td>bytes per pixel (Currently only 3 and 4 supported,
730 depending on <em class="parameter"><code>has_alpha</code></em>)</td>
733 <td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
734 <td><a class="link" href="ClutterTexture.html#ClutterTextureFlags" title="enum ClutterTextureFlags"><span class="type">ClutterTextureFlags</span></a></td>
737 <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
738 <td>return location for a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>
742 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
744 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on failure.</td>
748 <p class="since">Since 0.6</p>
751 <div class="refsect2">
752 <a name="clutter-texture-get-base-size"></a><h3>clutter_texture_get_base_size ()</h3>
753 <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>,
754 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *width</code></em>,
755 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *height</code></em>);</pre>
757 Gets the size in pixels of the untransformed underlying image
759 <div class="variablelist"><table border="0">
760 <col align="left" valign="top">
763 <td><p><span class="term"><em class="parameter"><code>texture</code></em> :</span></p></td>
764 <td>a <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a>
768 <td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
769 <td>return location for the width, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
773 <td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
774 <td>return location for the height, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
781 <div class="refsect2">
782 <a name="clutter-texture-get-pixel-format"></a><h3>clutter_texture_get_pixel_format ()</h3>
783 <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>
785 Retrieves the pixel format used by <em class="parameter"><code>texture</code></em>. This is
790 <div class="informalexample">
791 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
794 <td class="listing_lines" align="right"><pre>1
798 <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>
800 <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>
801 <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>
809 <div class="variablelist"><table border="0">
810 <col align="left" valign="top">
813 <td><p><span class="term"><em class="parameter"><code>texture</code></em> :</span></p></td>
814 <td>a <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a>
818 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
819 <td>a <span class="type">CoglPixelFormat</span> value</td>
823 <p class="since">Since 1.0</p>
826 <div class="refsect2">
827 <a name="clutter-texture-get-max-tile-waste"></a><h3>clutter_texture_get_max_tile_waste ()</h3>
828 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> 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>
830 Gets the maximum waste that will be used when creating a texture or
831 -1 if slicing is disabled.
833 <div class="variablelist"><table border="0">
834 <col align="left" valign="top">
837 <td><p><span class="term"><em class="parameter"><code>texture</code></em> :</span></p></td>
838 <td>A <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a>
842 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
843 <td>The maximum waste or -1 if the texture waste is
848 <p class="since">Since 0.8</p>
851 <div class="refsect2">
852 <a name="clutter-texture-get-filter-quality"></a><h3>clutter_texture_get_filter_quality ()</h3>
853 <pre class="programlisting"><a class="link" href="ClutterTexture.html#ClutterTextureQuality" title="enum ClutterTextureQuality"><span class="returnvalue">ClutterTextureQuality</span></a> clutter_texture_get_filter_quality
854 (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>);</pre>
856 Gets the filter quality used when scaling a texture.
858 <div class="variablelist"><table border="0">
859 <col align="left" valign="top">
862 <td><p><span class="term"><em class="parameter"><code>texture</code></em> :</span></p></td>
863 <td>A <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a>
867 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
868 <td>The filter quality value.</td>
872 <p class="since">Since 0.8</p>
875 <div class="refsect2">
876 <a name="clutter-texture-set-filter-quality"></a><h3>clutter_texture_set_filter_quality ()</h3>
877 <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>,
878 <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>
880 Sets the filter quality when scaling a texture. The quality is an
881 enumeration currently the following values are supported:
882 <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
883 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
884 bit more expensive (bilinear interpolation), and
885 <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
886 improve scaled down rendering as well (by using mipmaps). The default value
887 is <a class="link" href="ClutterTexture.html#CLUTTER-TEXTURE-QUALITY-MEDIUM:CAPS"><code class="literal">CLUTTER_TEXTURE_QUALITY_MEDIUM</code></a>.
889 <div class="variablelist"><table border="0">
890 <col align="left" valign="top">
893 <td><p><span class="term"><em class="parameter"><code>texture</code></em> :</span></p></td>
894 <td>a <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a>
898 <td><p><span class="term"><em class="parameter"><code>filter_quality</code></em> :</span></p></td>
899 <td>new filter quality value</td>
903 <p class="since">Since 0.8</p>
906 <div class="refsect2">
907 <a name="clutter-texture-get-cogl-texture"></a><h3>clutter_texture_get_cogl_texture ()</h3>
908 <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>
910 Retrieves the handle to the underlying COGL texture used for drawing
911 the actor. No extra reference is taken so if you need to keep the
912 handle then you should call <code class="function">cogl_handle_ref()</code> on it.
915 The texture handle returned is the first layer of the material
916 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
917 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
918 and use the <span class="type">CoglMaterial</span> API.
920 <div class="variablelist"><table border="0">
921 <col align="left" valign="top">
924 <td><p><span class="term"><em class="parameter"><code>texture</code></em> :</span></p></td>
925 <td>A <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a>
929 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
930 <td>a <span class="type">CoglHandle</span> for the texture. The returned
931 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. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
936 <p class="since">Since 0.8</p>
939 <div class="refsect2">
940 <a name="clutter-texture-set-cogl-texture"></a><h3>clutter_texture_set_cogl_texture ()</h3>
941 <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>,
942 <em class="parameter"><code><span class="type">CoglHandle</span> cogl_tex</code></em>);</pre>
944 Replaces the underlying COGL texture drawn by this actor with
945 <em class="parameter"><code>cogl_tex</code></em>. A reference to the texture is taken so if the handle is
946 no longer needed it should be deref'd with cogl_handle_unref.
948 <div class="variablelist"><table border="0">
949 <col align="left" valign="top">
952 <td><p><span class="term"><em class="parameter"><code>texture</code></em> :</span></p></td>
953 <td>A <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a>
957 <td><p><span class="term"><em class="parameter"><code>cogl_tex</code></em> :</span></p></td>
958 <td>A CoglHandle for a texture</td>
962 <p class="since">Since 0.8</p>
965 <div class="refsect2">
966 <a name="clutter-texture-get-cogl-material"></a><h3>clutter_texture_get_cogl_material ()</h3>
967 <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>
969 Returns a handle to the underlying COGL material used for drawing
972 <div class="variablelist"><table border="0">
973 <col align="left" valign="top">
976 <td><p><span class="term"><em class="parameter"><code>texture</code></em> :</span></p></td>
977 <td>A <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a>
981 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
982 <td>a handle for a <span class="type">CoglMaterial</span>. The
983 material is owned by the <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> and it should not be
984 unreferenced. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
989 <p class="since">Since 1.0</p>
992 <div class="refsect2">
993 <a name="clutter-texture-set-cogl-material"></a><h3>clutter_texture_set_cogl_material ()</h3>
994 <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>,
995 <em class="parameter"><code><span class="type">CoglHandle</span> cogl_material</code></em>);</pre>
997 Replaces the underlying Cogl material drawn by this actor with
998 <em class="parameter"><code>cogl_material</code></em>. A reference to the material is taken so if the
999 handle is no longer needed it should be deref'd with
1000 cogl_handle_unref. Texture data is attached to the material so
1001 calling this function also replaces the Cogl
1002 texture. <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> requires that the material have a texture
1003 layer so you should set one on the material before calling this
1006 <div class="variablelist"><table border="0">
1007 <col align="left" valign="top">
1010 <td><p><span class="term"><em class="parameter"><code>texture</code></em> :</span></p></td>
1011 <td>A <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a>
1015 <td><p><span class="term"><em class="parameter"><code>cogl_material</code></em> :</span></p></td>
1016 <td>A CoglHandle for a material</td>
1020 <p class="since">Since 0.8</p>
1023 <div class="refsect2">
1024 <a name="clutter-texture-get-sync-size"></a><h3>clutter_texture_get_sync_size ()</h3>
1025 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 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>
1027 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>
1029 <div class="variablelist"><table border="0">
1030 <col align="left" valign="top">
1033 <td><p><span class="term"><em class="parameter"><code>texture</code></em> :</span></p></td>
1034 <td>a <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a>
1038 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1040 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> should have the same
1041 preferred size of the underlying image data</td>
1045 <p class="since">Since 1.0</p>
1048 <div class="refsect2">
1049 <a name="clutter-texture-set-sync-size"></a><h3>clutter_texture_set_sync_size ()</h3>
1050 <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>,
1051 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> sync_size</code></em>);</pre>
1053 Sets whether <em class="parameter"><code>texture</code></em> should have the same preferred size as the
1054 underlying image data.
1056 <div class="variablelist"><table border="0">
1057 <col align="left" valign="top">
1060 <td><p><span class="term"><em class="parameter"><code>texture</code></em> :</span></p></td>
1061 <td>a <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a>
1065 <td><p><span class="term"><em class="parameter"><code>sync_size</code></em> :</span></p></td>
1067 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the texture should have the same size of the
1068 underlying image data</td>
1072 <p class="since">Since 1.0</p>
1075 <div class="refsect2">
1076 <a name="clutter-texture-get-repeat"></a><h3>clutter_texture_get_repeat ()</h3>
1077 <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>,
1078 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *repeat_x</code></em>,
1079 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *repeat_y</code></em>);</pre>
1081 Retrieves the horizontal and vertical repeat values set
1082 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>
1084 <div class="variablelist"><table border="0">
1085 <col align="left" valign="top">
1088 <td><p><span class="term"><em class="parameter"><code>texture</code></em> :</span></p></td>
1089 <td>a <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a>
1093 <td><p><span class="term"><em class="parameter"><code>repeat_x</code></em> :</span></p></td>
1094 <td>return location for the horizontal repeat. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
1098 <td><p><span class="term"><em class="parameter"><code>repeat_y</code></em> :</span></p></td>
1099 <td>return location for the vertical repeat. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
1104 <p class="since">Since 1.0</p>
1107 <div class="refsect2">
1108 <a name="clutter-texture-set-repeat"></a><h3>clutter_texture_set_repeat ()</h3>
1109 <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>,
1110 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> repeat_x</code></em>,
1111 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> repeat_y</code></em>);</pre>
1113 Sets whether the <em class="parameter"><code>texture</code></em> should repeat horizontally or
1114 vertically when the actor size is bigger than the image size
1116 <div class="variablelist"><table border="0">
1117 <col align="left" valign="top">
1120 <td><p><span class="term"><em class="parameter"><code>texture</code></em> :</span></p></td>
1121 <td>a <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a>
1125 <td><p><span class="term"><em class="parameter"><code>repeat_x</code></em> :</span></p></td>
1127 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the texture should repeat horizontally</td>
1130 <td><p><span class="term"><em class="parameter"><code>repeat_y</code></em> :</span></p></td>
1132 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the texture should repeat vertically</td>
1136 <p class="since">Since 1.0</p>
1139 <div class="refsect2">
1140 <a name="clutter-texture-get-keep-aspect-ratio"></a><h3>clutter_texture_get_keep_aspect_ratio ()</h3>
1141 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> clutter_texture_get_keep_aspect_ratio
1142 (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>);</pre>
1144 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>
1146 <div class="variablelist"><table border="0">
1147 <col align="left" valign="top">
1150 <td><p><span class="term"><em class="parameter"><code>texture</code></em> :</span></p></td>
1151 <td>a <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a>
1155 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1157 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> should maintain the
1158 aspect ratio of the underlying image</td>
1162 <p class="since">Since 1.0</p>
1165 <div class="refsect2">
1166 <a name="clutter-texture-set-keep-aspect-ratio"></a><h3>clutter_texture_set_keep_aspect_ratio ()</h3>
1167 <pre class="programlisting"><span class="returnvalue">void</span> clutter_texture_set_keep_aspect_ratio
1168 (<em class="parameter"><code><a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> *texture</code></em>,
1169 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> keep_aspect</code></em>);</pre>
1171 Sets whether <em class="parameter"><code>texture</code></em> should have a preferred size maintaining
1172 the aspect ratio of the underlying image
1174 <div class="variablelist"><table border="0">
1175 <col align="left" valign="top">
1178 <td><p><span class="term"><em class="parameter"><code>texture</code></em> :</span></p></td>
1179 <td>a <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a>
1183 <td><p><span class="term"><em class="parameter"><code>keep_aspect</code></em> :</span></p></td>
1185 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to maintain aspect ratio</td>
1189 <p class="since">Since 1.0</p>
1192 <div class="refsect2">
1193 <a name="clutter-texture-get-load-async"></a><h3>clutter_texture_get_load_async ()</h3>
1194 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 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>
1196 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>
1198 <div class="variablelist"><table border="0">
1199 <col align="left" valign="top">
1202 <td><p><span class="term"><em class="parameter"><code>texture</code></em> :</span></p></td>
1203 <td>a <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a>
1207 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1209 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> should load the data from
1210 disk asynchronously</td>
1214 <p class="since">Since 1.0</p>
1217 <div class="refsect2">
1218 <a name="clutter-texture-set-load-async"></a><h3>clutter_texture_set_load_async ()</h3>
1219 <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>,
1220 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> load_async</code></em>);</pre>
1222 Sets whether <em class="parameter"><code>texture</code></em> should use a worker thread to load the data
1223 from disk asynchronously. Setting <em class="parameter"><code>load_async</code></em> to <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> will make
1224 <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.
1227 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
1228 <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>.
1230 <div class="variablelist"><table border="0">
1231 <col align="left" valign="top">
1234 <td><p><span class="term"><em class="parameter"><code>texture</code></em> :</span></p></td>
1235 <td>a <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a>
1239 <td><p><span class="term"><em class="parameter"><code>load_async</code></em> :</span></p></td>
1241 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the texture should asynchronously load data
1242 from a filename</td>
1246 <p class="since">Since 1.0</p>
1249 <div class="refsect2">
1250 <a name="clutter-texture-get-load-data-async"></a><h3>clutter_texture_get_load_data_async ()</h3>
1251 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 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>
1253 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>
1255 <div class="variablelist"><table border="0">
1256 <col align="left" valign="top">
1259 <td><p><span class="term"><em class="parameter"><code>texture</code></em> :</span></p></td>
1260 <td>a <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a>
1264 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1266 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> should load the image
1267 data from a file asynchronously</td>
1271 <p class="since">Since 1.0</p>
1274 <div class="refsect2">
1275 <a name="clutter-texture-set-load-data-async"></a><h3>clutter_texture_set_load_data_async ()</h3>
1276 <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>,
1277 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> load_async</code></em>);</pre>
1279 Sets whether <em class="parameter"><code>texture</code></em> should use a worker thread to load the data
1280 from disk asynchronously. Setting <em class="parameter"><code>load_async</code></em> to <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> will make
1281 <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
1282 determined the width and height of the image data.
1285 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
1286 <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>.
1288 <div class="variablelist"><table border="0">
1289 <col align="left" valign="top">
1292 <td><p><span class="term"><em class="parameter"><code>texture</code></em> :</span></p></td>
1293 <td>a <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a>
1297 <td><p><span class="term"><em class="parameter"><code>load_async</code></em> :</span></p></td>
1299 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the texture should asynchronously load data
1300 from a filename</td>
1304 <p class="since">Since 1.0</p>
1307 <div class="refsect2">
1308 <a name="clutter-texture-get-pick-with-alpha"></a><h3>clutter_texture_get_pick_with_alpha ()</h3>
1309 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> 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>
1311 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>
1313 <div class="variablelist"><table border="0">
1314 <col align="left" valign="top">
1317 <td><p><span class="term"><em class="parameter"><code>texture</code></em> :</span></p></td>
1318 <td>a <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a>
1322 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1324 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a> should define its shape
1325 using the alpha channel when picking.</td>
1329 <p class="since">Since 1.4</p>
1332 <div class="refsect2">
1333 <a name="clutter-texture-set-pick-with-alpha"></a><h3>clutter_texture_set_pick_with_alpha ()</h3>
1334 <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>,
1335 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> pick_with_alpha</code></em>);</pre>
1337 Sets whether <em class="parameter"><code>texture</code></em> should have it's shape defined by the alpha
1338 channel when picking.
1341 Be aware that this is a bit more costly than the default picking
1342 due to the texture lookup, extra test against the alpha value and
1343 the fact that it will also interrupt the batching of geometry done
1347 Also there is currently no control over the threshold used to
1348 determine what value of alpha is considered pickable, and so only
1349 fully opaque parts of the texture will react to picking.
1351 <div class="variablelist"><table border="0">
1352 <col align="left" valign="top">
1355 <td><p><span class="term"><em class="parameter"><code>texture</code></em> :</span></p></td>
1356 <td>a <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a>
1360 <td><p><span class="term"><em class="parameter"><code>pick_with_alpha</code></em> :</span></p></td>
1362 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the alpha channel should affect the
1367 <p class="since">Since 1.4</p>
1370 <div class="refsect1">
1371 <a name="ClutterTexture.property-details"></a><h2>Property Details</h2>
1372 <div class="refsect2">
1373 <a name="ClutterTexture--cogl-material"></a><h3>The <code class="literal">"cogl-material"</code> property</h3>
1374 <pre class="programlisting"> "cogl-material" <span class="type">CoglHandle</span>* : Read / Write</pre>
1375 <p>The underlying Cogl material handle used to draw this actor.</p>
1378 <div class="refsect2">
1379 <a name="ClutterTexture--cogl-texture"></a><h3>The <code class="literal">"cogl-texture"</code> property</h3>
1380 <pre class="programlisting"> "cogl-texture" <span class="type">CoglHandle</span>* : Read / Write</pre>
1381 <p>The underlying Cogl texture handle used to draw this actor.</p>
1384 <div class="refsect2">
1385 <a name="ClutterTexture--disable-slicing"></a><h3>The <code class="literal">"disable-slicing"</code> property</h3>
1386 <pre class="programlisting"> "disable-slicing" <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write / Construct Only</pre>
1387 <p>Forces the underlying texture to be singular and not made of smaller space saving individual textures.</p>
1388 <p>Default value: FALSE</p>
1391 <div class="refsect2">
1392 <a name="ClutterTexture--filename"></a><h3>The <code class="literal">"filename"</code> property</h3>
1393 <pre class="programlisting"> "filename" <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre>
1395 The path of the file containing the image data to be displayed by
1399 This property is unset when using the clutter_texture_set_from_*_data()
1400 family of functions.
1402 <p>Default value: NULL</p>
1405 <div class="refsect2">
1406 <a name="ClutterTexture--filter-quality"></a><h3>The <code class="literal">"filter-quality"</code> property</h3>
1407 <pre class="programlisting"> "filter-quality" <a class="link" href="ClutterTexture.html#ClutterTextureQuality" title="enum ClutterTextureQuality"><span class="type">ClutterTextureQuality</span></a> : Read / Write / Construct</pre>
1408 <p>Rendering quality used when drawing the texture.</p>
1409 <p>Default value: CLUTTER_TEXTURE_QUALITY_MEDIUM</p>
1412 <div class="refsect2">
1413 <a name="ClutterTexture--keep-aspect-ratio"></a><h3>The <code class="literal">"keep-aspect-ratio"</code> property</h3>
1414 <pre class="programlisting"> "keep-aspect-ratio" <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
1415 <p>Keep the aspect ratio of the texture when requesting the preferred width or height.</p>
1416 <p>Default value: FALSE</p>
1419 <div class="refsect2">
1420 <a name="ClutterTexture--load-async"></a><h3>The <code class="literal">"load-async"</code> property</h3>
1421 <pre class="programlisting"> "load-async" <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Write</pre>
1423 Tries to load a texture from a filename by using a local thread to perform
1424 the read operations. The initially created texture has dimensions 0x0 when
1425 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
1426 emitted and when the image has completed loading the
1427 <a class="link" href="ClutterTexture.html#ClutterTexture-load-finished" title='The "load-finished" signal'><span class="type">"load-finished"</span></a> signal is emitted.
1430 Threading is only enabled if <a href="../glib/glib-Deprecated-Thread-APIs.html#g-thread-init"><code class="function">g_thread_init()</code></a> has been called prior to
1431 <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
1435 The upload of the texture data on the GL pipeline is not asynchronous, as
1436 it must be performed from within the same thread that called
1437 <a class="link" href="clutter-General.html#clutter-main" title="clutter_main ()"><code class="function">clutter_main()</code></a>.
1439 <p>Default value: FALSE</p>
1440 <p class="since">Since 1.0</p>
1443 <div class="refsect2">
1444 <a name="ClutterTexture--load-data-async"></a><h3>The <code class="literal">"load-data-async"</code> property</h3>
1445 <pre class="programlisting"> "load-data-async" <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Write</pre>
1447 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
1448 synchronously causing some blocking.
1450 <p>Default value: FALSE</p>
1451 <p class="since">Since 1.0</p>
1454 <div class="refsect2">
1455 <a name="ClutterTexture--pick-with-alpha"></a><h3>The <code class="literal">"pick-with-alpha"</code> property</h3>
1456 <pre class="programlisting"> "pick-with-alpha" <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
1457 <p>Shape actor with alpha channel when picking.</p>
1458 <p>Default value: FALSE</p>
1461 <div class="refsect2">
1462 <a name="ClutterTexture--pixel-format"></a><h3>The <code class="literal">"pixel-format"</code> property</h3>
1463 <pre class="programlisting"> "pixel-format" <span class="type">CoglPixelFormat</span> : Read</pre>
1464 <p>The Cogl pixel format to use.</p>
1465 <p>Default value: COGL_PIXEL_FORMAT_RGBA_8888</p>
1468 <div class="refsect2">
1469 <a name="ClutterTexture--repeat-x"></a><h3>The <code class="literal">"repeat-x"</code> property</h3>
1470 <pre class="programlisting"> "repeat-x" <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
1471 <p>Repeat the contents rather than scaling them horizontally.</p>
1472 <p>Default value: FALSE</p>
1475 <div class="refsect2">
1476 <a name="ClutterTexture--repeat-y"></a><h3>The <code class="literal">"repeat-y"</code> property</h3>
1477 <pre class="programlisting"> "repeat-y" <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
1478 <p>Repeat the contents rather than scaling them vertically.</p>
1479 <p>Default value: FALSE</p>
1482 <div class="refsect2">
1483 <a name="ClutterTexture--sync-size"></a><h3>The <code class="literal">"sync-size"</code> property</h3>
1484 <pre class="programlisting"> "sync-size" <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
1485 <p>Auto sync size of actor to underlying pixbuf dimensions.</p>
1486 <p>Default value: TRUE</p>
1489 <div class="refsect2">
1490 <a name="ClutterTexture--tile-waste"></a><h3>The <code class="literal">"tile-waste"</code> property</h3>
1491 <pre class="programlisting"> "tile-waste" <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read</pre>
1492 <p>Maximum waste area of a sliced texture.</p>
1493 <p>Allowed values: >= G_MAXULONG</p>
1494 <p>Default value: 127</p>
1497 <div class="refsect1">
1498 <a name="ClutterTexture.signal-details"></a><h2>Signal Details</h2>
1499 <div class="refsect2">
1500 <a name="ClutterTexture-load-finished"></a><h3>The <code class="literal">"load-finished"</code> signal</h3>
1501 <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,
1502 <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *error,
1503 <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
1505 The ::load-finished signal is emitted when a texture load has
1506 completed. If there was an error during loading, <em class="parameter"><code>error</code></em> will
1507 be set, otherwise it will be <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>
1509 <div class="variablelist"><table border="0">
1510 <col align="left" valign="top">
1513 <td><p><span class="term"><em class="parameter"><code>texture</code></em> :</span></p></td>
1514 <td>the texture which received the signal</td>
1517 <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
1518 <td>A set error, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>
1522 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
1523 <td>user data set when the signal handler was connected.</td>
1527 <p class="since">Since 1.0</p>
1530 <div class="refsect2">
1531 <a name="ClutterTexture-pixbuf-change"></a><h3>The <code class="literal">"pixbuf-change"</code> signal</h3>
1532 <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,
1533 <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
1535 The ::pixbuf-change signal is emitted each time the pixbuf
1536 used by <em class="parameter"><code>texture</code></em> changes.
1538 <div class="variablelist"><table border="0">
1539 <col align="left" valign="top">
1542 <td><p><span class="term"><em class="parameter"><code>texture</code></em> :</span></p></td>
1543 <td>the texture which received the signal</td>
1546 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
1547 <td>user data set when the signal handler was connected.</td>
1553 <div class="refsect2">
1554 <a name="ClutterTexture-size-change"></a><h3>The <code class="literal">"size-change"</code> signal</h3>
1555 <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,
1556 <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> width,
1557 <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> height,
1558 <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
1560 The ::size-change signal is emitted each time the size of the
1561 pixbuf used by <em class="parameter"><code>texture</code></em> changes. The new size is given as
1562 argument to the callback.
1564 <div class="variablelist"><table border="0">
1565 <col align="left" valign="top">
1568 <td><p><span class="term"><em class="parameter"><code>texture</code></em> :</span></p></td>
1569 <td>the texture which received the signal</td>
1572 <td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
1573 <td>the width of the new texture</td>
1576 <td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
1577 <td>the height of the new texture</td>
1580 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
1581 <td>user data set when the signal handler was connected.</td>
1588 <div class="footer">
1590 Generated by GTK-Doc V1.18.1</div>