RubyGems - clutter - Versions diffs - 2.2.4-x64-mingw32 - Mend

clutter 2.2.4-x64-mingw32

Files changed (744) hide show

data/vendor/local/share/gtk-doc/html/clutter/ClutterGroup.html ADDED Viewed

@@ -0,0 +1,272 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Clutter Reference Manual: ClutterGroup</title>
+<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<link rel="home" href="index.html" title="Clutter Reference Manual">
+<link rel="up" href="deprecated.html" title="Part IX. Deprecated Classes">
+<link rel="prev" href="ClutterCairoTexture.html" title="ClutterCairoTexture">
+<link rel="next" href="ClutterRectangle.html" title="ClutterRectangle">
+<meta name="generator" content="GTK-Doc V1.20.1 (XML mode)">
+<link rel="stylesheet" href="style.css" type="text/css">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
+<td width="100%" align="left" class="shortcuts">
+<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span>
+                  <a href="#ClutterGroup.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span>
+                  <a href="#ClutterGroup.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span>
+                  <a href="#ClutterGroup.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span>
+</td>
+<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
+<td><a accesskey="u" href="deprecated.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
+<td><a accesskey="p" href="ClutterCairoTexture.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
+<td><a accesskey="n" href="ClutterRectangle.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
+</tr></table>
+<div class="refentry">
+<a name="ClutterGroup"></a><div class="titlepage"></div>
+<div class="refnamediv"><table width="100%"><tr>
+<td valign="top">
+<h2><span class="refentrytitle"><a name="ClutterGroup.top_of_page"></a>ClutterGroup</span></h2>
+<p>ClutterGroup — A fixed layout container</p>
+</td>
+<td class="gallery_image" valign="top" align="right"></td>
+</tr></table></div>
+<div class="refsect1">
+<a name="ClutterGroup.functions"></a><h2>Functions</h2>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="functions_return">
+<col class="functions_name">
+</colgroup>
+<tbody>
+<tr>
+<td class="function_type">
+<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
+</td>
+<td class="function_name">
+<a class="link" href="ClutterGroup.html#clutter-group-new" title="clutter_group_new ()">clutter_group_new</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">void</span>
+</td>
+<td class="function_name">
+<a class="link" href="ClutterGroup.html#clutter-group-remove-all" title="clutter_group_remove_all ()">clutter_group_remove_all</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">gint</span>
+</td>
+<td class="function_name">
+<a class="link" href="ClutterGroup.html#clutter-group-get-n-children" title="clutter_group_get_n_children ()">clutter_group_get_n_children</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
+</td>
+<td class="function_name">
+<a class="link" href="ClutterGroup.html#clutter-group-get-nth-child" title="clutter_group_get_nth_child ()">clutter_group_get_nth_child</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect1">
+<a name="ClutterGroup.other"></a><h2>Types and Values</h2>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="name">
+<col class="description">
+</colgroup>
+<tbody>
+<tr>
+<td class="datatype_keyword">struct</td>
+<td class="function_name"><a class="link" href="ClutterGroup.html#ClutterGroup-struct" title="struct ClutterGroup">ClutterGroup</a></td>
+</tr>
+<tr>
+<td class="datatype_keyword">struct</td>
+<td class="function_name"><a class="link" href="ClutterGroup.html#ClutterGroupClass" title="struct ClutterGroupClass">ClutterGroupClass</a></td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect1">
+<a name="ClutterGroup.object-hierarchy"></a><h2>Object Hierarchy</h2>
+<pre class="screen">    GObject
+    <span class="lineart">╰──</span> GInitiallyUnowned
+        <span class="lineart">╰──</span> <a class="link" href="ClutterActor.html" title="ClutterActor">ClutterActor</a>
+            <span class="lineart">╰──</span> ClutterGroup
+                <span class="lineart">╰──</span> <a class="link" href="ClutterStage.html" title="ClutterStage">ClutterStage</a>
+</pre>
+</div>
+<div class="refsect1">
+<a name="ClutterGroup.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
+<p>
+ClutterGroup implements
+ <a class="link" href="ClutterContainer.html" title="ClutterContainer">ClutterContainer</a>,  <a class="link" href="ClutterScriptable.html" title="ClutterScriptable">ClutterScriptable</a>,  <a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable">ClutterAnimatable</a> and  AtkImplementorIface.</p>
+</div>
+<div class="refsect1">
+<a name="ClutterGroup.description"></a><h2>Description</h2>
+<p>A <a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="type">ClutterGroup</span></a> is an Actor which contains multiple child actors positioned
+relative to the <a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="type">ClutterGroup</span></a> position. Other operations such as scaling,
+rotating and clipping of the group will apply to the child actors.</p>
+<p>A <a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="type">ClutterGroup</span></a>'s size is defined by the size and position of its children;
+it will be the smallest non-negative size that covers the right and bottom
+edges of all of its children.</p>
+<p>Setting the size on a Group using <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> methods like
+<a class="link" href="ClutterActor.html#clutter-actor-set-size" title="clutter_actor_set_size ()"><code class="function">clutter_actor_set_size()</code></a> will override the natural size of the Group,
+however this will not affect the size of the children and they may still
+be painted outside of the allocation of the group. One way to constrain
+the visible area of a <a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="type">ClutterGroup</span></a> to a specified allocation is to
+explicitly set the size of the <a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="type">ClutterGroup</span></a> and then use the
+<a class="link" href="ClutterActor.html#ClutterActor--clip-to-allocation" title="The “clip-to-allocation” property"><span class="type">“clip-to-allocation”</span></a> property.</p>
+</div>
+<div class="refsect1">
+<a name="ClutterGroup.functions_details"></a><h2>Functions</h2>
+<div class="refsect2">
+<a name="clutter-group-new"></a><h3>clutter_group_new ()</h3>
+<pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
+clutter_group_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
+<div class="warning">
+<p><code class="literal">clutter_group_new</code> has been deprecated since version 1.10 and should not be used in newly-written code.</p>
+<p>Use <a class="link" href="ClutterActor.html#clutter-actor-new" title="clutter_actor_new ()"><code class="function">clutter_actor_new()</code></a> instead.</p>
+</div>
+<p>Create a new  <a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="type">ClutterGroup</span></a>.</p>
+<div class="refsect3">
+<a name="id-1.10.14.8.2.6"></a><h4>Returns</h4>
+<p> the newly created <a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="type">ClutterGroup</span></a> actor</p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-group-remove-all"></a><h3>clutter_group_remove_all ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>
+clutter_group_remove_all (<em class="parameter"><code><a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="type">ClutterGroup</span></a> *self</code></em>);</pre>
+<div class="warning">
+<p><code class="literal">clutter_group_remove_all</code> has been deprecated since version 1.10 and should not be used in newly-written code.</p>
+<p>Use <a class="link" href="ClutterActor.html#clutter-actor-remove-all-children" title="clutter_actor_remove_all_children ()"><code class="function">clutter_actor_remove_all_children()</code></a> instead.</p>
+</div>
+<p>Removes all children actors from the <a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="type">ClutterGroup</span></a>.</p>
+<div class="refsect3">
+<a name="id-1.10.14.8.3.6"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody><tr>
+<td class="parameter_name"><p>self</p></td>
+<td class="parameter_description"><p>A <a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="type">ClutterGroup</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-group-get-n-children"></a><h3>clutter_group_get_n_children ()</h3>
+<pre class="programlisting"><span class="returnvalue">gint</span>
+clutter_group_get_n_children (<em class="parameter"><code><a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="type">ClutterGroup</span></a> *self</code></em>);</pre>
+<div class="warning">
+<p><code class="literal">clutter_group_get_n_children</code> has been deprecated since version 1.10 and should not be used in newly-written code.</p>
+<p>Use <a class="link" href="ClutterActor.html#clutter-actor-get-n-children" title="clutter_actor_get_n_children ()"><code class="function">clutter_actor_get_n_children()</code></a> instead.</p>
+</div>
+<p>Gets the number of actors held in the group.</p>
+<div class="refsect3">
+<a name="id-1.10.14.8.4.7"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody><tr>
+<td class="parameter_name"><p>self</p></td>
+<td class="parameter_description"><p>A <a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="type">ClutterGroup</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.10.14.8.4.8"></a><h4>Returns</h4>
+<p> The number of child actors held in the group.</p>
+<p></p>
+</div>
+<p class="since">Since 0.2</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-group-get-nth-child"></a><h3>clutter_group_get_nth_child ()</h3>
+<pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
+clutter_group_get_nth_child (<em class="parameter"><code><a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="type">ClutterGroup</span></a> *self</code></em>,
+                             <em class="parameter"><code><span class="type">gint</span> index_</code></em>);</pre>
+<div class="warning">
+<p><code class="literal">clutter_group_get_nth_child</code> has been deprecated since version 1.10 and should not be used in newly-written code.</p>
+<p>Use <a class="link" href="ClutterActor.html#clutter-actor-get-child-at-index" title="clutter_actor_get_child_at_index ()"><code class="function">clutter_actor_get_child_at_index()</code></a> instead.</p>
+</div>
+<p>Gets a groups child held at <em class="parameter"><code>index_</code></em>
+ in stack.</p>
+<div class="refsect3">
+<a name="id-1.10.14.8.5.7"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>self</p></td>
+<td class="parameter_description"><p>A <a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="type">ClutterGroup</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>index_</p></td>
+<td class="parameter_description"><p>the position of the requested actor.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.10.14.8.5.8"></a><h4>Returns</h4>
+<p> A Clutter actor, or <code class="literal">NULL</code> if
+<em class="parameter"><code>index_</code></em>
+is invalid. </p>
+<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
+</div>
+<p class="since">Since 0.2</p>
+</div>
+</div>
+<div class="refsect1">
+<a name="ClutterGroup.other_details"></a><h2>Types and Values</h2>
+<div class="refsect2">
+<a name="ClutterGroup-struct"></a><h3>struct ClutterGroup</h3>
+<pre class="programlisting">struct ClutterGroup;</pre>
+<p>The <a class="link" href="ClutterGroup.html" title="ClutterGroup"><span class="type">ClutterGroup</span></a> structure contains only private data
+and should be accessed using the provided API</p>
+<p class="since">Since 0.1</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="ClutterGroupClass"></a><h3>struct ClutterGroupClass</h3>
+<pre class="programlisting">struct ClutterGroupClass {
+};
+</pre>
+<p>The <a class="link" href="ClutterGroup.html#ClutterGroupClass" title="struct ClutterGroupClass"><span class="type">ClutterGroupClass</span></a> structure contains only private data</p>
+<p class="since">Since 0.1</p>
+</div>
+</div>
+</div>
+<div class="footer">
+<hr>
+          Generated by GTK-Doc V1.20.1</div>
+</body>
+</html>

data/vendor/local/share/gtk-doc/html/clutter/ClutterImage.html ADDED Viewed

@@ -0,0 +1,527 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Clutter Reference Manual: ClutterImage</title>
+<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<link rel="home" href="index.html" title="Clutter Reference Manual">
+<link rel="up" href="ch07.html" title="Content">
+<link rel="prev" href="ClutterCanvas.html" title="ClutterCanvas">
+<link rel="next" href="ch08.html" title="Paint Objects">
+<meta name="generator" content="GTK-Doc V1.20.1 (XML mode)">
+<link rel="stylesheet" href="style.css" type="text/css">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
+<td width="100%" align="left" class="shortcuts">
+<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span>
+                  <a href="#ClutterImage.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span>
+                  <a href="#ClutterImage.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span>
+                  <a href="#ClutterImage.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span>
+</td>
+<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
+<td><a accesskey="u" href="ch07.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
+<td><a accesskey="p" href="ClutterCanvas.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
+<td><a accesskey="n" href="ch08.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
+</tr></table>
+<div class="refentry">
+<a name="ClutterImage"></a><div class="titlepage"></div>
+<div class="refnamediv"><table width="100%"><tr>
+<td valign="top">
+<h2><span class="refentrytitle"><a name="ClutterImage.top_of_page"></a>ClutterImage</span></h2>
+<p>ClutterImage — Image data content</p>
+</td>
+<td class="gallery_image" valign="top" align="right"></td>
+</tr></table></div>
+<div class="refsect1">
+<a name="ClutterImage.functions"></a><h2>Functions</h2>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="functions_return">
+<col class="functions_name">
+</colgroup>
+<tbody>
+<tr>
+<td class="define_keyword">#define</td>
+<td class="function_name"><a class="link" href="ClutterImage.html#CLUTTER-IMAGE-ERROR:CAPS" title="CLUTTER_IMAGE_ERROR">CLUTTER_IMAGE_ERROR</a></td>
+</tr>
+<tr>
+<td class="function_type">
+<a class="link" href="ClutterContent.html" title="ClutterContent"><span class="returnvalue">ClutterContent</span></a> *
+</td>
+<td class="function_name">
+<a class="link" href="ClutterImage.html#clutter-image-new" title="clutter_image_new ()">clutter_image_new</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">gboolean</span>
+</td>
+<td class="function_name">
+<a class="link" href="ClutterImage.html#clutter-image-set-data" title="clutter_image_set_data ()">clutter_image_set_data</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">gboolean</span>
+</td>
+<td class="function_name">
+<a class="link" href="ClutterImage.html#clutter-image-set-bytes" title="clutter_image_set_bytes ()">clutter_image_set_bytes</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">gboolean</span>
+</td>
+<td class="function_name">
+<a class="link" href="ClutterImage.html#clutter-image-set-area" title="clutter_image_set_area ()">clutter_image_set_area</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">CoglTexture</span> *
+</td>
+<td class="function_name">
+<a class="link" href="ClutterImage.html#clutter-image-get-texture" title="clutter_image_get_texture ()">clutter_image_get_texture</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect1">
+<a name="ClutterImage.other"></a><h2>Types and Values</h2>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="name">
+<col class="description">
+</colgroup>
+<tbody>
+<tr>
+<td class="datatype_keyword">struct</td>
+<td class="function_name"><a class="link" href="ClutterImage.html#ClutterImage-struct" title="struct ClutterImage">ClutterImage</a></td>
+</tr>
+<tr>
+<td class="datatype_keyword">struct</td>
+<td class="function_name"><a class="link" href="ClutterImage.html#ClutterImageClass" title="struct ClutterImageClass">ClutterImageClass</a></td>
+</tr>
+<tr>
+<td class="datatype_keyword">enum</td>
+<td class="function_name"><a class="link" href="ClutterImage.html#ClutterImageError" title="enum ClutterImageError">ClutterImageError</a></td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect1">
+<a name="ClutterImage.object-hierarchy"></a><h2>Object Hierarchy</h2>
+<pre class="screen">    GObject
+    <span class="lineart">╰──</span> ClutterImage
+</pre>
+</div>
+<div class="refsect1">
+<a name="ClutterImage.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
+<p>
+ClutterImage implements
+ <a class="link" href="ClutterContent.html" title="ClutterContent">ClutterContent</a>.</p>
+</div>
+<div class="refsect1">
+<a name="ClutterImage.description"></a><h2>Description</h2>
+<p><a class="link" href="ClutterImage.html" title="ClutterImage"><span class="type">ClutterImage</span></a> is a <a class="link" href="ClutterContent.html" title="ClutterContent"><span class="type">ClutterContent</span></a> implementation that displays
+image data inside a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>.</p>
+<p>See <a class="ulink" href="https://git.gnome.org/browse/clutter/tree/examples/image-content.c?h=clutter-1.18" target="_top">image.c</a>
+for an example of how to use <a class="link" href="ClutterImage.html" title="ClutterImage"><span class="type">ClutterImage</span></a>.</p>
+<p><a class="link" href="ClutterImage.html" title="ClutterImage"><span class="type">ClutterImage</span></a> is available since Clutter 1.10.</p>
+</div>
+<div class="refsect1">
+<a name="ClutterImage.functions_details"></a><h2>Functions</h2>
+<div class="refsect2">
+<a name="CLUTTER-IMAGE-ERROR:CAPS"></a><h3>CLUTTER_IMAGE_ERROR</h3>
+<pre class="programlisting">#define CLUTTER_IMAGE_ERROR             (clutter_image_error_quark ())
+</pre>
+<p>Error domain for the <a class="link" href="ClutterImage.html#ClutterImageError" title="enum ClutterImageError"><span class="type">ClutterImageError</span></a> enumeration.</p>
+<p class="since">Since 1.10</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-image-new"></a><h3>clutter_image_new ()</h3>
+<pre class="programlisting"><a class="link" href="ClutterContent.html" title="ClutterContent"><span class="returnvalue">ClutterContent</span></a> *
+clutter_image_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
+<p>Creates a new <a class="link" href="ClutterImage.html" title="ClutterImage"><span class="type">ClutterImage</span></a> instance.</p>
+<div class="refsect3">
+<a name="id-1.5.8.3.8.3.5"></a><h4>Returns</h4>
+<p> the newly created <a class="link" href="ClutterImage.html" title="ClutterImage"><span class="type">ClutterImage</span></a> instance.
+Use <code class="function">g_object_unref()</code> when done. </p>
+<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
+</div>
+<p class="since">Since 1.10</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-image-set-data"></a><h3>clutter_image_set_data ()</h3>
+<pre class="programlisting"><span class="returnvalue">gboolean</span>
+clutter_image_set_data (<em class="parameter"><code><a class="link" href="ClutterImage.html" title="ClutterImage"><span class="type">ClutterImage</span></a> *image</code></em>,
+                        <em class="parameter"><code>const <span class="type">guint8</span> *data</code></em>,
+                        <em class="parameter"><code><span class="type">CoglPixelFormat</span> pixel_format</code></em>,
+                        <em class="parameter"><code><span class="type">guint</span> width</code></em>,
+                        <em class="parameter"><code><span class="type">guint</span> height</code></em>,
+                        <em class="parameter"><code><span class="type">guint</span> row_stride</code></em>,
+                        <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
+<p>Sets the image data to be displayed by <em class="parameter"><code>image</code></em>
+.</p>
+<p>If the image data was successfully loaded, the <em class="parameter"><code>image</code></em>
+ will be invalidated.</p>
+<p>In case of error, the <em class="parameter"><code>error</code></em>
+ value will be set, and this function will
+return <code class="literal">FALSE</code>.</p>
+<p>The image data is copied in texture memory.</p>
+<p>The image data is expected to be a linear array of RGBA or RGB pixel data;
+how to retrieve that data is left to platform specific image loaders. For
+instance, if you use the GdkPixbuf library:</p>
+<div class="informalexample">
+  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
+    <tbody>
+      <tr>
+        <td class="listing_lines" align="right"><pre>1
+2
+3
+4
+5
+6
+7
+8
+9
+10
+11
+12
+13
+14
+15</pre></td>
+        <td class="listing_code"><pre class="programlisting"><span class="usertype">ClutterContent</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">image </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="ClutterImage.html#clutter-image-new">clutter_image_new</a></span><span class="normal"> </span><span class="symbol">();</span>
+<span class="usertype">GdkPixbuf</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">pixbuf </span><span class="symbol">=</span><span class="normal"> </span><span class="function">gdk_pixbuf_new_from_file</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">filename</span><span class="symbol">,</span><span class="normal"> NULL</span><span class="symbol">);</span>
+<span class="function"><a href="ClutterImage.html#clutter-image-set-data">clutter_image_set_data</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">CLUTTER_IMAGE</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">image</span><span class="symbol">),</span>
+<span class="normal">                        </span><span class="function">gdk_pixbuf_get_pixels</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">pixbuf</span><span class="symbol">),</span>
+<span class="normal">                        </span><span class="function">gdk_pixbuf_has_alpha</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">pixbuf</span><span class="symbol">)</span>
+<span class="normal">                          </span><span class="symbol">?</span><span class="normal"> COGL_PIXEL_FORMAT_RGBA_8888</span>
+<span class="normal">                          </span><span class="symbol">:</span><span class="normal"> COGL_PIXEL_FORMAT_RGB_888</span><span class="symbol">,</span>
+<span class="normal">                        </span><span class="function">gdk_pixbuf_get_width</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">pixbuf</span><span class="symbol">),</span>
+<span class="normal">                        </span><span class="function">gdk_pixbuf_get_height</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">pixbuf</span><span class="symbol">),</span>
+<span class="normal">                        </span><span class="function">gdk_pixbuf_get_rowstride</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">pixbuf</span><span class="symbol">),</span>
+<span class="normal">                        </span><span class="symbol">&amp;</span><span class="normal">error</span><span class="symbol">);</span>
+<span class="function">g_object_unref</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">pixbuf</span><span class="symbol">);</span></pre></td>
+      </tr>
+    </tbody>
+  </table>
+</div>
+<p></p>
+<div class="refsect3">
+<a name="id-1.5.8.3.8.4.11"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>image</p></td>
+<td class="parameter_description"><p>a <a class="link" href="ClutterImage.html" title="ClutterImage"><span class="type">ClutterImage</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>data</p></td>
+<td class="parameter_description"><p> the image data, as an array of bytes. </p></td>
+<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym>]</span></td>
+</tr>
+<tr>
+<td class="parameter_name"><p>pixel_format</p></td>
+<td class="parameter_description"><p>the Cogl pixel format of the image data</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>width</p></td>
+<td class="parameter_description"><p>the width of the image data</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>height</p></td>
+<td class="parameter_description"><p>the height of the image data</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>row_stride</p></td>
+<td class="parameter_description"><p>the length of each row inside <em class="parameter"><code>data</code></em>
+</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>error</p></td>
+<td class="parameter_description"><p>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.5.8.3.8.4.12"></a><h4>Returns</h4>
+<p> <code class="literal">TRUE</code> if the image data was successfully loaded,
+and <code class="literal">FALSE</code> otherwise.</p>
+<p></p>
+</div>
+<p class="since">Since 1.10</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-image-set-bytes"></a><h3>clutter_image_set_bytes ()</h3>
+<pre class="programlisting"><span class="returnvalue">gboolean</span>
+clutter_image_set_bytes (<em class="parameter"><code><a class="link" href="ClutterImage.html" title="ClutterImage"><span class="type">ClutterImage</span></a> *image</code></em>,
+                         <em class="parameter"><code><span class="type">GBytes</span> *data</code></em>,
+                         <em class="parameter"><code><span class="type">CoglPixelFormat</span> pixel_format</code></em>,
+                         <em class="parameter"><code><span class="type">guint</span> width</code></em>,
+                         <em class="parameter"><code><span class="type">guint</span> height</code></em>,
+                         <em class="parameter"><code><span class="type">guint</span> row_stride</code></em>,
+                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
+<p>Sets the image data stored inside a <span class="type">GBytes</span> to be displayed by <em class="parameter"><code>image</code></em>
+.</p>
+<p>If the image data was successfully loaded, the <em class="parameter"><code>image</code></em>
+ will be invalidated.</p>
+<p>In case of error, the <em class="parameter"><code>error</code></em>
+ value will be set, and this function will
+return <code class="literal">FALSE</code>.</p>
+<p>The image data contained inside the <span class="type">GBytes</span> is copied in texture memory,
+and no additional reference is acquired on the <em class="parameter"><code>data</code></em>
+.</p>
+<div class="refsect3">
+<a name="id-1.5.8.3.8.5.8"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>image</p></td>
+<td class="parameter_description"><p>a <a class="link" href="ClutterImage.html" title="ClutterImage"><span class="type">ClutterImage</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>data</p></td>
+<td class="parameter_description"><p>the image data, as a <span class="type">GBytes</span></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>pixel_format</p></td>
+<td class="parameter_description"><p>the Cogl pixel format of the image data</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>width</p></td>
+<td class="parameter_description"><p>the width of the image data</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>height</p></td>
+<td class="parameter_description"><p>the height of the image data</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>row_stride</p></td>
+<td class="parameter_description"><p>the length of each row inside <em class="parameter"><code>data</code></em>
+</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>error</p></td>
+<td class="parameter_description"><p>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.5.8.3.8.5.9"></a><h4>Returns</h4>
+<p> <code class="literal">TRUE</code> if the image data was successfully loaded,
+and <code class="literal">FALSE</code> otherwise.</p>
+<p></p>
+</div>
+<p class="since">Since 1.12</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-image-set-area"></a><h3>clutter_image_set_area ()</h3>
+<pre class="programlisting"><span class="returnvalue">gboolean</span>
+clutter_image_set_area (<em class="parameter"><code><a class="link" href="ClutterImage.html" title="ClutterImage"><span class="type">ClutterImage</span></a> *image</code></em>,
+                        <em class="parameter"><code>const <span class="type">guint8</span> *data</code></em>,
+                        <em class="parameter"><code><span class="type">CoglPixelFormat</span> pixel_format</code></em>,
+                        <em class="parameter"><code>const <span class="type">cairo_rectangle_int_t</span> *rect</code></em>,
+                        <em class="parameter"><code><span class="type">guint</span> row_stride</code></em>,
+                        <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
+<p>Sets the image data to be display by <em class="parameter"><code>image</code></em>
+, using <em class="parameter"><code>rect</code></em>
+ to indicate
+the position and size of the image data to be set.</p>
+<p>If the <em class="parameter"><code>image</code></em>
+ does not have any image data set when this function is
+called, a new texture will be created with the size of the width and
+height of the rectangle, i.e. calling this function on a newly created
+<a class="link" href="ClutterImage.html" title="ClutterImage"><span class="type">ClutterImage</span></a> will be the equivalent of calling <a class="link" href="ClutterImage.html#clutter-image-set-data" title="clutter_image_set_data ()"><code class="function">clutter_image_set_data()</code></a>.</p>
+<p>If the image data was successfully loaded, the <em class="parameter"><code>image</code></em>
+ will be invalidated.</p>
+<p>In case of error, the <em class="parameter"><code>error</code></em>
+ value will be set, and this function will
+return <code class="literal">FALSE</code>.</p>
+<p>The image data is copied in texture memory.</p>
+<div class="refsect3">
+<a name="id-1.5.8.3.8.6.9"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>image</p></td>
+<td class="parameter_description"><p>a <a class="link" href="ClutterImage.html" title="ClutterImage"><span class="type">ClutterImage</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>data</p></td>
+<td class="parameter_description"><p> the image data, as an array of bytes. </p></td>
+<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym>]</span></td>
+</tr>
+<tr>
+<td class="parameter_name"><p>pixel_format</p></td>
+<td class="parameter_description"><p>the Cogl pixel format of the image data</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>rect</p></td>
+<td class="parameter_description"><p>a rectangle indicating the area that should be set</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>row_stride</p></td>
+<td class="parameter_description"><p>the length of each row inside <em class="parameter"><code>data</code></em>
+</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>error</p></td>
+<td class="parameter_description"><p>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.5.8.3.8.6.10"></a><h4>Returns</h4>
+<p> <code class="literal">TRUE</code> if the image data was successfully loaded,
+and <code class="literal">FALSE</code> otherwise.</p>
+<p></p>
+</div>
+<p class="since">Since 1.10</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-image-get-texture"></a><h3>clutter_image_get_texture ()</h3>
+<pre class="programlisting"><span class="returnvalue">CoglTexture</span> *
+clutter_image_get_texture (<em class="parameter"><code><a class="link" href="ClutterImage.html" title="ClutterImage"><span class="type">ClutterImage</span></a> *image</code></em>);</pre>
+<p>Retrieves a pointer to the Cogl texture used by <em class="parameter"><code>image</code></em>
+.</p>
+<p>If you change the contents of the returned Cogl texture you will need
+to manually invalidate the <em class="parameter"><code>image</code></em>
+ with <a class="link" href="ClutterContent.html#clutter-content-invalidate" title="clutter_content_invalidate ()"><code class="function">clutter_content_invalidate()</code></a>
+in order to update the actors using <em class="parameter"><code>image</code></em>
+ as their content.</p>
+<div class="refsect3">
+<a name="id-1.5.8.3.8.7.6"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody><tr>
+<td class="parameter_name"><p>image</p></td>
+<td class="parameter_description"><p>a <a class="link" href="ClutterImage.html" title="ClutterImage"><span class="type">ClutterImage</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.5.8.3.8.7.7"></a><h4>Returns</h4>
+<p> a pointer to the Cogl texture, or <code class="literal">NULL</code>. </p>
+<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
+</div>
+<p class="since">Since 1.10</p>
+<p class="stability">Stability Level: <acronym title="Unstable interfaces are experimental or transitional. They are typically used to
+give outside developers early access to new or rapidly changing technology, or
+to provide an interim solution to a problem where a more general solution is
+anticipated. No claims are made about either source or binary compatibility from
+one minor release to the next.
+The Unstable interface level is a warning that these interfaces are  subject to
+change without warning and should not be used in unbundled products.
+Given such caveats, customer impact need not be a factor when considering
+incompatible changes to an Unstable interface in a major or minor release.
+Nonetheless, when such changes are introduced, the changes should still be
+mentioned in the release notes for the affected release.
+"><span class="acronym">Unstable</span></acronym></p>
+</div>
+</div>
+<div class="refsect1">
+<a name="ClutterImage.other_details"></a><h2>Types and Values</h2>
+<div class="refsect2">
+<a name="ClutterImage-struct"></a><h3>struct ClutterImage</h3>
+<pre class="programlisting">struct ClutterImage;</pre>
+<p>The <a class="link" href="ClutterImage.html" title="ClutterImage"><span class="type">ClutterImage</span></a> structure contains
+private data and should only be accessed using the provided
+API.</p>
+<p class="since">Since 1.10</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="ClutterImageClass"></a><h3>struct ClutterImageClass</h3>
+<pre class="programlisting">struct ClutterImageClass {
+};
+</pre>
+<p>The <a class="link" href="ClutterImage.html#ClutterImageClass" title="struct ClutterImageClass"><span class="type">ClutterImageClass</span></a> structure contains
+private data.</p>
+<p class="since">Since 1.10</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="ClutterImageError"></a><h3>enum ClutterImageError</h3>
+<p>Error enumeration for <a class="link" href="ClutterImage.html" title="ClutterImage"><span class="type">ClutterImage</span></a>.</p>
+<div class="refsect3">
+<a name="id-1.5.8.3.9.4.4"></a><h4>Members</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="300px" class="enum_members_name">
+<col class="enum_members_description">
+<col width="200px" class="enum_members_annotations">
+</colgroup>
+<tbody><tr>
+<td class="enum_member_name"><p><a name="CLUTTER-IMAGE-ERROR-INVALID-DATA:CAPS"></a>CLUTTER_IMAGE_ERROR_INVALID_DATA</p></td>
+<td class="enum_member_description">
+<p>Invalid data passed to the
+  <a class="link" href="ClutterImage.html#clutter-image-set-data" title="clutter_image_set_data ()"><code class="function">clutter_image_set_data()</code></a> function.</p>
+</td>
+<td class="enum_member_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<p class="since">Since 1.10</p>
+</div>
+</div>
+</div>
+<div class="footer">
+<hr>
+          Generated by GTK-Doc V1.20.1</div>
+</body>
+</html>