/usr/share/gtk-doc/html/st/StTextureCache.html is in gnome-shell-common 3.10.4-0ubuntu5.
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 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>St Reference Manual: StTextureCache</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="St Reference Manual">
<link rel="up" href="styling.html" title="Styling">
<link rel="prev" href="StThemeNodeTransition.html" title="StThemeNodeTransition">
<link rel="next" href="object-tree.html" title="Object Hierarchy">
<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="#StTextureCache.description" class="shortcut">Description</a>
|
<a href="#StTextureCache.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#StTextureCache.signals" class="shortcut">Signals</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="styling.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="StThemeNodeTransition.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="object-tree.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="StTextureCache"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="StTextureCache.top_of_page"></a>StTextureCache</span></h2>
<p>StTextureCache</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="StTextureCache.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="StTextureCache.html#StTextureCache-struct" title="struct StTextureCache">StTextureCache</a>;
struct <a class="link" href="StTextureCache.html#StTextureCacheClass" title="struct StTextureCacheClass">StTextureCacheClass</a>;
enum <a class="link" href="StTextureCache.html#StTextureCachePolicy" title="enum StTextureCachePolicy">StTextureCachePolicy</a>;
<a class="link" href="StTextureCache.html" title="StTextureCache"><span class="returnvalue">StTextureCache</span></a> * <a class="link" href="StTextureCache.html#st-texture-cache-get-default" title="st_texture_cache_get_default ()">st_texture_cache_get_default</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">ClutterActor</span> * <a class="link" href="StTextureCache.html#st-texture-cache-load-sliced-image" title="st_texture_cache_load_sliced_image ()">st_texture_cache_load_sliced_image</a> (<em class="parameter"><code><a class="link" href="StTextureCache.html" title="StTextureCache"><span class="type">StTextureCache</span></a> *cache</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>,
<em class="parameter"><code><span class="type">gint</span> grid_width</code></em>,
<em class="parameter"><code><span class="type">gint</span> grid_height</code></em>,
<em class="parameter"><code><span class="type">GFunc</span> load_callback</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
<span class="returnvalue">ClutterActor</span> * <a class="link" href="StTextureCache.html#st-texture-cache-bind-pixbuf-property" title="st_texture_cache_bind_pixbuf_property ()">st_texture_cache_bind_pixbuf_property</a>
(<em class="parameter"><code><a class="link" href="StTextureCache.html" title="StTextureCache"><span class="type">StTextureCache</span></a> *cache</code></em>,
<em class="parameter"><code><span class="type">GObject</span> *object</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *property_name</code></em>);
<span class="returnvalue">ClutterActor</span> * <a class="link" href="StTextureCache.html#st-texture-cache-load-gicon" title="st_texture_cache_load_gicon ()">st_texture_cache_load_gicon</a> (<em class="parameter"><code><a class="link" href="StTextureCache.html" title="StTextureCache"><span class="type">StTextureCache</span></a> *cache</code></em>,
<em class="parameter"><code><a class="link" href="st-st-theme-node.html#StThemeNode"><span class="type">StThemeNode</span></a> *theme_node</code></em>,
<em class="parameter"><code><span class="type">GIcon</span> *icon</code></em>,
<em class="parameter"><code><span class="type">gint</span> size</code></em>);
<span class="returnvalue">ClutterActor</span> * <a class="link" href="StTextureCache.html#st-texture-cache-load-uri-async" title="st_texture_cache_load_uri_async ()">st_texture_cache_load_uri_async</a> (<em class="parameter"><code><a class="link" href="StTextureCache.html" title="StTextureCache"><span class="type">StTextureCache</span></a> *cache</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *uri</code></em>,
<em class="parameter"><code><span class="type">int</span> available_width</code></em>,
<em class="parameter"><code><span class="type">int</span> available_height</code></em>);
<span class="returnvalue">CoglHandle</span> <a class="link" href="StTextureCache.html#st-texture-cache-load-file-to-cogl-texture" title="st_texture_cache_load_file_to_cogl_texture ()">st_texture_cache_load_file_to_cogl_texture</a>
(<em class="parameter"><code><a class="link" href="StTextureCache.html" title="StTextureCache"><span class="type">StTextureCache</span></a> *cache</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *file_path</code></em>);
<span class="returnvalue">cairo_surface_t</span> * <a class="link" href="StTextureCache.html#st-texture-cache-load-file-to-cairo-surface" title="st_texture_cache_load_file_to_cairo_surface ()">st_texture_cache_load_file_to_cairo_surface</a>
(<em class="parameter"><code><a class="link" href="StTextureCache.html" title="StTextureCache"><span class="type">StTextureCache</span></a> *cache</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *file_path</code></em>);
<span class="returnvalue">CoglHandle</span> (<a class="link" href="StTextureCache.html#StTextureCacheLoader" title="StTextureCacheLoader ()">*StTextureCacheLoader</a>) (<em class="parameter"><code><a class="link" href="StTextureCache.html" title="StTextureCache"><span class="type">StTextureCache</span></a> *cache</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *key</code></em>,
<em class="parameter"><code><span class="type">void</span> *data</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">CoglHandle</span> <a class="link" href="StTextureCache.html#st-texture-cache-load" title="st_texture_cache_load ()">st_texture_cache_load</a> (<em class="parameter"><code><a class="link" href="StTextureCache.html" title="StTextureCache"><span class="type">StTextureCache</span></a> *cache</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *key</code></em>,
<em class="parameter"><code><a class="link" href="StTextureCache.html#StTextureCachePolicy" title="enum StTextureCachePolicy"><span class="type">StTextureCachePolicy</span></a> policy</code></em>,
<em class="parameter"><code><a class="link" href="StTextureCache.html#StTextureCacheLoader" title="StTextureCacheLoader ()"><span class="type">StTextureCacheLoader</span></a> load</code></em>,
<em class="parameter"><code><span class="type">void</span> *data</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="StTextureCache.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----StTextureCache
</pre>
</div>
<div class="refsect1">
<a name="StTextureCache.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="StTextureCache.html#StTextureCache-icon-theme-changed" title='The "icon-theme-changed" signal'>icon-theme-changed</a>" : <code class="literal">Run Last</code>
"<a class="link" href="StTextureCache.html#StTextureCache-texture-file-changed" title='The "texture-file-changed" signal'>texture-file-changed</a>" : <code class="literal">Run Last</code>
</pre>
</div>
<div class="refsect1">
<a name="StTextureCache.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="StTextureCache.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="StTextureCache-struct"></a><h3>struct StTextureCache</h3>
<pre class="programlisting">struct StTextureCache;</pre>
</div>
<hr>
<div class="refsect2">
<a name="StTextureCacheClass"></a><h3>struct StTextureCacheClass</h3>
<pre class="programlisting">struct StTextureCacheClass {
GObjectClass parent_class;
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="StTextureCachePolicy"></a><h3>enum StTextureCachePolicy</h3>
<pre class="programlisting">typedef enum {
ST_TEXTURE_CACHE_POLICY_NONE,
ST_TEXTURE_CACHE_POLICY_FOREVER
} StTextureCachePolicy;
</pre>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="ST-TEXTURE-CACHE-POLICY-NONE:CAPS"></a><span class="term"><code class="literal">ST_TEXTURE_CACHE_POLICY_NONE</code></span></p></td>
<td></td>
</tr>
<tr>
<td><p><a name="ST-TEXTURE-CACHE-POLICY-FOREVER:CAPS"></a><span class="term"><code class="literal">ST_TEXTURE_CACHE_POLICY_FOREVER</code></span></p></td>
<td></td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="st-texture-cache-get-default"></a><h3>st_texture_cache_get_default ()</h3>
<pre class="programlisting"><a class="link" href="StTextureCache.html" title="StTextureCache"><span class="returnvalue">StTextureCache</span></a> * st_texture_cache_get_default (<em class="parameter"><code><span class="type">void</span></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"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The global texture cache. <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="st-texture-cache-load-sliced-image"></a><h3>st_texture_cache_load_sliced_image ()</h3>
<pre class="programlisting"><span class="returnvalue">ClutterActor</span> * st_texture_cache_load_sliced_image (<em class="parameter"><code><a class="link" href="StTextureCache.html" title="StTextureCache"><span class="type">StTextureCache</span></a> *cache</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>,
<em class="parameter"><code><span class="type">gint</span> grid_width</code></em>,
<em class="parameter"><code><span class="type">gint</span> grid_height</code></em>,
<em class="parameter"><code><span class="type">GFunc</span> load_callback</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>
This function reads a single image file which contains multiple images internally.
The image file will be divided using <em class="parameter"><code>grid_width</code></em> and <em class="parameter"><code>grid_height</code></em>;
note that the dimensions of the image loaded from <em class="parameter"><code>path</code></em>
should be a multiple of the specified grid dimensions.
</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>cache</code></em> :</span></p></td>
<td>A <a class="link" href="StTextureCache.html" title="StTextureCache"><span class="type">StTextureCache</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>Path to a filename</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>grid_width</code></em> :</span></p></td>
<td>Width in pixels</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>grid_height</code></em> :</span></p></td>
<td>Height in pixels</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>load_callback</code></em> :</span></p></td>
<td>Function called when the image is loaded, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="The callback is valid until first called."><span class="acronym">scope async</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>Data to pass to the load callback</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A new <span class="type">ClutterActor</span>. <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="st-texture-cache-bind-pixbuf-property"></a><h3>st_texture_cache_bind_pixbuf_property ()</h3>
<pre class="programlisting"><span class="returnvalue">ClutterActor</span> * st_texture_cache_bind_pixbuf_property
(<em class="parameter"><code><a class="link" href="StTextureCache.html" title="StTextureCache"><span class="type">StTextureCache</span></a> *cache</code></em>,
<em class="parameter"><code><span class="type">GObject</span> *object</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *property_name</code></em>);</pre>
<p>
Create a <span class="type">ClutterTexture</span> which tracks the <span class="type">GdkPixbuf</span> value of a GObject property
named by <em class="parameter"><code>property_name</code></em>. Unlike other methods in StTextureCache, the underlying
CoglHandle is not shared by default with other invocations to this method.
</p>
<p>
If the source object is destroyed, the texture will continue to show the last
value of the property.
</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>object</code></em> :</span></p></td>
<td>A <span class="type">GObject</span> with a property <em class="parameter"><code>property_name</code></em> of type <span class="type">GdkPixbuf</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>property_name</code></em> :</span></p></td>
<td>Name of a property</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A new <span class="type">ClutterActor</span>. <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="st-texture-cache-load-gicon"></a><h3>st_texture_cache_load_gicon ()</h3>
<pre class="programlisting"><span class="returnvalue">ClutterActor</span> * st_texture_cache_load_gicon (<em class="parameter"><code><a class="link" href="StTextureCache.html" title="StTextureCache"><span class="type">StTextureCache</span></a> *cache</code></em>,
<em class="parameter"><code><a class="link" href="st-st-theme-node.html#StThemeNode"><span class="type">StThemeNode</span></a> *theme_node</code></em>,
<em class="parameter"><code><span class="type">GIcon</span> *icon</code></em>,
<em class="parameter"><code><span class="type">gint</span> size</code></em>);</pre>
<p>
This method returns a new <span class="type">ClutterActor</span> for a given <span class="type">GIcon</span>. If the
icon isn't loaded already, the texture will be filled
asynchronously.
</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>cache</code></em> :</span></p></td>
<td>The texture cache instance</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>theme_node</code></em> :</span></p></td>
<td>The <a class="link" href="st-st-theme-node.html#StThemeNode"><span class="type">StThemeNode</span></a> to use for colors, or NULL
if the icon must not be recolored. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>icon</code></em> :</span></p></td>
<td>the <span class="type">GIcon</span> to load</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
<td>Size of themed</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A new <span class="type">ClutterActor</span> for the icon, or <code class="literal">NULL</code> if not found. <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="st-texture-cache-load-uri-async"></a><h3>st_texture_cache_load_uri_async ()</h3>
<pre class="programlisting"><span class="returnvalue">ClutterActor</span> * st_texture_cache_load_uri_async (<em class="parameter"><code><a class="link" href="StTextureCache.html" title="StTextureCache"><span class="type">StTextureCache</span></a> *cache</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *uri</code></em>,
<em class="parameter"><code><span class="type">int</span> available_width</code></em>,
<em class="parameter"><code><span class="type">int</span> available_height</code></em>);</pre>
<p>
Asynchronously load an image. Initially, the returned texture will have a natural
size of zero. At some later point, either the image will be loaded successfully
and at that point size will be negotiated, or upon an error, no image will be set.
</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>cache</code></em> :</span></p></td>
<td>The texture cache instance</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
<td>uri of the image file from which to create a pixbuf</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>available_width</code></em> :</span></p></td>
<td>available width for the image, can be -1 if not limited</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>available_height</code></em> :</span></p></td>
<td>available height for the image, can be -1 if not limited</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A new <span class="type">ClutterActor</span> with no image loaded initially. <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="st-texture-cache-load-file-to-cogl-texture"></a><h3>st_texture_cache_load_file_to_cogl_texture ()</h3>
<pre class="programlisting"><span class="returnvalue">CoglHandle</span> st_texture_cache_load_file_to_cogl_texture
(<em class="parameter"><code><a class="link" href="StTextureCache.html" title="StTextureCache"><span class="type">StTextureCache</span></a> *cache</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *file_path</code></em>);</pre>
<p>
This function synchronously loads the given file path
into a COGL texture. On error, a warning is emitted
and <code class="literal">COGL_INVALID_HANDLE</code> is returned.
</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>cache</code></em> :</span></p></td>
<td>A <a class="link" href="StTextureCache.html" title="StTextureCache"><span class="type">StTextureCache</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>file_path</code></em> :</span></p></td>
<td>Path to a file in supported image format</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <span class="type">CoglHandle</span>. <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>
<hr>
<div class="refsect2">
<a name="st-texture-cache-load-file-to-cairo-surface"></a><h3>st_texture_cache_load_file_to_cairo_surface ()</h3>
<pre class="programlisting"><span class="returnvalue">cairo_surface_t</span> * st_texture_cache_load_file_to_cairo_surface
(<em class="parameter"><code><a class="link" href="StTextureCache.html" title="StTextureCache"><span class="type">StTextureCache</span></a> *cache</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *file_path</code></em>);</pre>
<p>
This function synchronously loads the given file path
into a cairo surface. On error, a warning is emitted
and <code class="literal">NULL</code> is returned.
</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>cache</code></em> :</span></p></td>
<td>A <a class="link" href="StTextureCache.html" title="StTextureCache"><span class="type">StTextureCache</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>file_path</code></em> :</span></p></td>
<td>Path to a file in supported image format</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <span class="type">cairo_surface_t</span>. <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>
<hr>
<div class="refsect2">
<a name="StTextureCacheLoader"></a><h3>StTextureCacheLoader ()</h3>
<pre class="programlisting"><span class="returnvalue">CoglHandle</span> (*StTextureCacheLoader) (<em class="parameter"><code><a class="link" href="StTextureCache.html" title="StTextureCache"><span class="type">StTextureCache</span></a> *cache</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *key</code></em>,
<em class="parameter"><code><span class="type">void</span> *data</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
See <a class="link" href="StTextureCache.html#st-texture-cache-load" title="st_texture_cache_load ()"><code class="function">st_texture_cache_load()</code></a>. Implementations should return a
texture handle for the given key, or set <em class="parameter"><code>error</code></em>.
</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>cache</code></em> :</span></p></td>
<td>a <a class="link" href="StTextureCache.html" title="StTextureCache"><span class="type">StTextureCache</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>Unique identifier for this texture</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>Callback user data</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>A <span class="type">GError</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="st-texture-cache-load"></a><h3>st_texture_cache_load ()</h3>
<pre class="programlisting"><span class="returnvalue">CoglHandle</span> st_texture_cache_load (<em class="parameter"><code><a class="link" href="StTextureCache.html" title="StTextureCache"><span class="type">StTextureCache</span></a> *cache</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *key</code></em>,
<em class="parameter"><code><a class="link" href="StTextureCache.html#StTextureCachePolicy" title="enum StTextureCachePolicy"><span class="type">StTextureCachePolicy</span></a> policy</code></em>,
<em class="parameter"><code><a class="link" href="StTextureCache.html#StTextureCacheLoader" title="StTextureCacheLoader ()"><span class="type">StTextureCacheLoader</span></a> load</code></em>,
<em class="parameter"><code><span class="type">void</span> *data</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Load an arbitrary texture, caching it. The string chosen for <em class="parameter"><code>key</code></em>
should be of the form "type-prefix:type-uuid". For example,
"url:file:///usr/share/icons/hicolor/48x48/apps/firefox.png", or
"stock-icon:gtk-ok".
</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>cache</code></em> :</span></p></td>
<td>A <a class="link" href="StTextureCache.html" title="StTextureCache"><span class="type">StTextureCache</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>Arbitrary string used to refer to item</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>policy</code></em> :</span></p></td>
<td>Caching policy</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>load</code></em> :</span></p></td>
<td>Function to create the texture, if not already cached</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>User data passed to <em class="parameter"><code>load</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>A <span class="type">GError</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A newly-referenced handle to the texture. <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 class="refsect1">
<a name="StTextureCache.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="StTextureCache-icon-theme-changed"></a><h3>The <code class="literal">"icon-theme-changed"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="StTextureCache.html" title="StTextureCache"><span class="type">StTextureCache</span></a> *sttexturecache,
<span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre>
</div>
<hr>
<div class="refsect2">
<a name="StTextureCache-texture-file-changed"></a><h3>The <code class="literal">"texture-file-changed"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="StTextureCache.html" title="StTextureCache"><span class="type">StTextureCache</span></a> *sttexturecache,
<span class="type">gchar</span> *arg1,
<span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19.1</div>
</body>
</html>
|