/usr/share/gtk-doc/html/meta/MetaShapedTexture.html is in libmutter-dev 3.10.4-0ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Mutter Reference Manual: MetaShapedTexture</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Mutter Reference Manual">
<link rel="up" href="core-reference.html" title="Part III. Mutter Core Reference">
<link rel="prev" href="MetaShadowFactory.html" title="MetaShadowFactory">
<link rel="next" href="MetaWindowActor.html" title="MetaWindowActor">
<meta name="generator" content="GTK-Doc V1.19.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="10"><tr valign="middle">
<td width="100%" align="left">
<a href="#" class="shortcut">Top</a>
|
<a href="#MetaShapedTexture.description" class="shortcut">Description</a>
|
<a href="#MetaShapedTexture.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#MetaShapedTexture.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
</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="core-reference.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="MetaShadowFactory.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="MetaWindowActor.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="MetaShapedTexture"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="MetaShapedTexture.top_of_page"></a>MetaShapedTexture</span></h2>
<p>MetaShapedTexture — An actor to draw a masked texture.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="MetaShapedTexture.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="MetaShapedTexture.html#MetaShapedTexture-struct" title="struct MetaShapedTexture">MetaShapedTexture</a>;
struct <a class="link" href="MetaShapedTexture.html#MetaShapedTextureClass" title="struct MetaShapedTextureClass">MetaShapedTextureClass</a>;
<span class="returnvalue">ClutterActor</span> * <a class="link" href="MetaShapedTexture.html#meta-shaped-texture-new" title="meta_shaped_texture_new ()">meta_shaped_texture_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="MetaShapedTexture.html#meta-shaped-texture-set-create-mipmaps" title="meta_shaped_texture_set_create_mipmaps ()">meta_shaped_texture_set_create_mipmaps</a>
(<em class="parameter"><code><a class="link" href="MetaShapedTexture.html" title="MetaShapedTexture"><span class="type">MetaShapedTexture</span></a> *stex</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> create_mipmaps</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="MetaShapedTexture.html#meta-shaped-texture-update-area" title="meta_shaped_texture_update_area ()">meta_shaped_texture_update_area</a> (<em class="parameter"><code><a class="link" href="MetaShapedTexture.html" title="MetaShapedTexture"><span class="type">MetaShapedTexture</span></a> *stex</code></em>,
<em class="parameter"><code><span class="type">int</span> x</code></em>,
<em class="parameter"><code><span class="type">int</span> y</code></em>,
<em class="parameter"><code><span class="type">int</span> width</code></em>,
<em class="parameter"><code><span class="type">int</span> height</code></em>,
<em class="parameter"><code><span class="type">cairo_region_t</span> *unobscured_region</code></em>);
<span class="returnvalue">void</span> <a class="link" href="MetaShapedTexture.html#meta-shaped-texture-set-pixmap" title="meta_shaped_texture_set_pixmap ()">meta_shaped_texture_set_pixmap</a> (<em class="parameter"><code><a class="link" href="MetaShapedTexture.html" title="MetaShapedTexture"><span class="type">MetaShapedTexture</span></a> *stex</code></em>,
<em class="parameter"><code><span class="type">Pixmap</span> pixmap</code></em>);
<span class="returnvalue">CoglTexture</span> * <a class="link" href="MetaShapedTexture.html#meta-shaped-texture-get-texture" title="meta_shaped_texture_get_texture ()">meta_shaped_texture_get_texture</a> (<em class="parameter"><code><a class="link" href="MetaShapedTexture.html" title="MetaShapedTexture"><span class="type">MetaShapedTexture</span></a> *stex</code></em>);
<span class="returnvalue">void</span> <a class="link" href="MetaShapedTexture.html#meta-shaped-texture-set-mask-texture" title="meta_shaped_texture_set_mask_texture ()">meta_shaped_texture_set_mask_texture</a>
(<em class="parameter"><code><a class="link" href="MetaShapedTexture.html" title="MetaShapedTexture"><span class="type">MetaShapedTexture</span></a> *stex</code></em>,
<em class="parameter"><code><span class="type">CoglTexture</span> *mask_texture</code></em>);
<span class="returnvalue">void</span> <a class="link" href="MetaShapedTexture.html#meta-shaped-texture-set-clip-region" title="meta_shaped_texture_set_clip_region ()">meta_shaped_texture_set_clip_region</a> (<em class="parameter"><code><a class="link" href="MetaShapedTexture.html" title="MetaShapedTexture"><span class="type">MetaShapedTexture</span></a> *stex</code></em>,
<em class="parameter"><code><span class="type">cairo_region_t</span> *clip_region</code></em>);
<span class="returnvalue">cairo_surface_t</span> * <a class="link" href="MetaShapedTexture.html#meta-shaped-texture-get-image" title="meta_shaped_texture_get_image ()">meta_shaped_texture_get_image</a> (<em class="parameter"><code><a class="link" href="MetaShapedTexture.html" title="MetaShapedTexture"><span class="type">MetaShapedTexture</span></a> *stex</code></em>,
<em class="parameter"><code><span class="type">cairo_rectangle_int_t</span> *clip</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="MetaShapedTexture.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----GInitiallyUnowned
+----ClutterActor
+----MetaShapedTexture
</pre>
</div>
<div class="refsect1">
<a name="MetaShapedTexture.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
MetaShapedTexture implements
ClutterContainer, ClutterScriptable, ClutterAnimatable and AtkImplementorIface.</p>
</div>
<div class="refsect1">
<a name="MetaShapedTexture.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="MetaShapedTexture.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="MetaShapedTexture-struct"></a><h3>struct MetaShapedTexture</h3>
<pre class="programlisting">struct MetaShapedTexture;</pre>
<p>
The <span class="structname">MetaShapedTexture</span> structure contains
only private data and should be accessed using the provided API
</p>
</div>
<hr>
<div class="refsect2">
<a name="MetaShapedTextureClass"></a><h3>struct MetaShapedTextureClass</h3>
<pre class="programlisting">struct MetaShapedTextureClass {
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="meta-shaped-texture-new"></a><h3>meta_shaped_texture_new ()</h3>
<pre class="programlisting"><span class="returnvalue">ClutterActor</span> * meta_shaped_texture_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="meta-shaped-texture-set-create-mipmaps"></a><h3>meta_shaped_texture_set_create_mipmaps ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> meta_shaped_texture_set_create_mipmaps
(<em class="parameter"><code><a class="link" href="MetaShapedTexture.html" title="MetaShapedTexture"><span class="type">MetaShapedTexture</span></a> *stex</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> create_mipmaps</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="meta-shaped-texture-update-area"></a><h3>meta_shaped_texture_update_area ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> meta_shaped_texture_update_area (<em class="parameter"><code><a class="link" href="MetaShapedTexture.html" title="MetaShapedTexture"><span class="type">MetaShapedTexture</span></a> *stex</code></em>,
<em class="parameter"><code><span class="type">int</span> x</code></em>,
<em class="parameter"><code><span class="type">int</span> y</code></em>,
<em class="parameter"><code><span class="type">int</span> width</code></em>,
<em class="parameter"><code><span class="type">int</span> height</code></em>,
<em class="parameter"><code><span class="type">cairo_region_t</span> *unobscured_region</code></em>);</pre>
<p>
Repairs the damaged area indicated by <em class="parameter"><code>x</code></em>, <em class="parameter"><code>y</code></em>, <em class="parameter"><code>width</code></em> and <em class="parameter"><code>height</code></em>
and queues a redraw for the intersection <em class="parameter"><code>visibible_region</code></em> and
the damage area. If <em class="parameter"><code>visibible_region</code></em> is <code class="literal">NULL</code> a redraw will always
get queued.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>stex</code></em> :</span></p></td>
<td><a class="link" href="MetaShapedTexture.html" title="MetaShapedTexture"><span class="type">MetaShapedTexture</span></a></td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
<td>the x coordinate of the damaged area</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
<td>the y coordinate of the damaged area</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
<td>the width of the damaged area</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
<td>the height of the damaged area</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>unobscured_region</code></em> :</span></p></td>
<td>The unobscured region of the window or <code class="literal">NULL</code> if
there is no valid one (like when the actor is transformed or
has a mapped clone)</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Whether a redraw have been queued or not</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="meta-shaped-texture-set-pixmap"></a><h3>meta_shaped_texture_set_pixmap ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> meta_shaped_texture_set_pixmap (<em class="parameter"><code><a class="link" href="MetaShapedTexture.html" title="MetaShapedTexture"><span class="type">MetaShapedTexture</span></a> *stex</code></em>,
<em class="parameter"><code><span class="type">Pixmap</span> pixmap</code></em>);</pre>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>stex</code></em> :</span></p></td>
<td>The <a class="link" href="MetaShapedTexture.html" title="MetaShapedTexture"><span class="type">MetaShapedTexture</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>pixmap</code></em> :</span></p></td>
<td>The pixmap you want the stex to assume</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="meta-shaped-texture-get-texture"></a><h3>meta_shaped_texture_get_texture ()</h3>
<pre class="programlisting"><span class="returnvalue">CoglTexture</span> * meta_shaped_texture_get_texture (<em class="parameter"><code><a class="link" href="MetaShapedTexture.html" title="MetaShapedTexture"><span class="type">MetaShapedTexture</span></a> *stex</code></em>);</pre>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>stex</code></em> :</span></p></td>
<td>The <a class="link" href="MetaShapedTexture.html" title="MetaShapedTexture"><span class="type">MetaShapedTexture</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the unshaped texture. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="meta-shaped-texture-set-mask-texture"></a><h3>meta_shaped_texture_set_mask_texture ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> meta_shaped_texture_set_mask_texture
(<em class="parameter"><code><a class="link" href="MetaShapedTexture.html" title="MetaShapedTexture"><span class="type">MetaShapedTexture</span></a> *stex</code></em>,
<em class="parameter"><code><span class="type">CoglTexture</span> *mask_texture</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="meta-shaped-texture-set-clip-region"></a><h3>meta_shaped_texture_set_clip_region ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> meta_shaped_texture_set_clip_region (<em class="parameter"><code><a class="link" href="MetaShapedTexture.html" title="MetaShapedTexture"><span class="type">MetaShapedTexture</span></a> *stex</code></em>,
<em class="parameter"><code><span class="type">cairo_region_t</span> *clip_region</code></em>);</pre>
<p>
Provides a hint to the texture about what areas of the texture
are not completely obscured and thus need to be painted. This
is an optimization and is not supposed to have any effect on
the output.
</p>
<p>
Typically a parent container will set the clip region before
painting its children, and then unset it afterwards.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>stex</code></em> :</span></p></td>
<td>a <a class="link" href="MetaShapedTexture.html" title="MetaShapedTexture"><span class="type">MetaShapedTexture</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>clip_region</code></em> :</span></p></td>
<td>the region of the texture that is visible and
should be painted.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="meta-shaped-texture-get-image"></a><h3>meta_shaped_texture_get_image ()</h3>
<pre class="programlisting"><span class="returnvalue">cairo_surface_t</span> * meta_shaped_texture_get_image (<em class="parameter"><code><a class="link" href="MetaShapedTexture.html" title="MetaShapedTexture"><span class="type">MetaShapedTexture</span></a> *stex</code></em>,
<em class="parameter"><code><span class="type">cairo_rectangle_int_t</span> *clip</code></em>);</pre>
<p>
Flattens the two layers of the shaped texture into one ARGB32
image by alpha blending the two images, and returns the flattened
image.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>stex</code></em> :</span></p></td>
<td>A <a class="link" href="MetaShapedTexture.html" title="MetaShapedTexture"><span class="type">MetaShapedTexture</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>clip</code></em> :</span></p></td>
<td>A clipping rectangle, to help prevent extra processing.
In the case that the clipping rectangle is partially or fully
outside the bounds of the texture, the rectangle will be clipped.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new cairo surface to be freed with
<code class="function">cairo_surface_destroy()</code>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19.1</div>
</body>
</html>
|