/usr/share/gtk-doc/html/cinnamon-st/StTextureCache.html is in cinnamon-doc 3.6.7-8ubuntu1.
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 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>StTextureCache: Cinnamon St Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Cinnamon 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.27 (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="#StTextureCache.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#StTextureCache.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#StTextureCache.signals" class="shortcut">Signals</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="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 class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="StTextureCache.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="StTextureCache.html" title="StTextureCache"><span class="returnvalue">StTextureCache</span></a> *
</td>
<td class="function_name">
<a class="link" href="StTextureCache.html#st-texture-cache-get-default" title="st_texture_cache_get_default ()">st_texture_cache_get_default</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">ClutterActor</span> *
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">ClutterActor</span> *
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">ClutterActor</span> *
</td>
<td class="function_name">
<a class="link" href="StTextureCache.html#st-texture-cache-load-gicon" title="st_texture_cache_load_gicon ()">st_texture_cache_load_gicon</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">ClutterActor</span> *
</td>
<td class="function_name">
<a class="link" href="StTextureCache.html#st-texture-cache-load-icon-name" title="st_texture_cache_load_icon_name ()">st_texture_cache_load_icon_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">ClutterActor</span> *
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">ClutterActor</span> *
</td>
<td class="function_name">
<a class="link" href="StTextureCache.html#st-texture-cache-load-uri-sync" title="st_texture_cache_load_uri_sync ()">st_texture_cache_load_uri_sync</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="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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">cairo_surface_t</span> *
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">ClutterActor</span> *
</td>
<td class="function_name">
<a class="link" href="StTextureCache.html#st-texture-cache-load-from-raw" title="st_texture_cache_load_from_raw ()">st_texture_cache_load_from_raw</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">ClutterActor</span> *
</td>
<td class="function_name">
<a class="link" href="StTextureCache.html#st-texture-cache-load-file-simple" title="st_texture_cache_load_file_simple ()">st_texture_cache_load_file_simple</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">CoglTexture</span> *
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="StTextureCache.html#StTextureCacheLoader" title="StTextureCacheLoader ()">*StTextureCacheLoader</a><span class="c_punctuation">)</span> <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="StTextureCache.html#st-texture-cache-load" title="st_texture_cache_load ()">st_texture_cache_load</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="StTextureCache.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="StTextureCache.html#StTextureCache-icon-theme-changed" title="The “icon-theme-changed” signal">icon-theme-changed</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="StTextureCache.html#StTextureCache-texture-file-changed" title="The “texture-file-changed” signal">texture-file-changed</a></td>
<td class="signal_flags">Run Last</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="StTextureCache.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="StTextureCache.html#StTextureCachePolicy" title="enum StTextureCachePolicy">StTextureCachePolicy</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="StTextureCache.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> StTextureCache
</pre>
</div>
<div class="refsect1">
<a name="StTextureCache.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="StTextureCache.functions_details"></a><h2>Functions</h2>
<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="refsect3">
<a name="st-texture-cache-get-default.returns"></a><h4>Returns</h4>
<p>The global texture cache. </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>
</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="refsect3">
<a name="st-texture-cache-load-sliced-image.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cache</p></td>
<td class="parameter_description"><p>A <a class="link" href="StTextureCache.html" title="StTextureCache"><span class="type">StTextureCache</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>Path to a filename</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>grid_width</p></td>
<td class="parameter_description"><p>Width in pixels</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>grid_height</p></td>
<td class="parameter_description"><p>Height in pixels</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>load_callback</p></td>
<td class="parameter_description"><p>Function called when the image is loaded, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><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 class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>Data to pass to the load callback</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="st-texture-cache-load-sliced-image.returns"></a><h4>Returns</h4>
<p>A new <span class="type">ClutterActor</span>. </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>
</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
<span class="type">CoglTexture</span> 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="refsect3">
<a name="st-texture-cache-bind-pixbuf-property.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>object</p></td>
<td class="parameter_description"><p>A <span class="type">GObject</span> with a property <em class="parameter"><code>property_name</code></em>
of type <span class="type">GdkPixbuf</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>property_name</p></td>
<td class="parameter_description"><p>Name of a property</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="st-texture-cache-bind-pixbuf-property.returns"></a><h4>Returns</h4>
<p>A new <span class="type">ClutterActor</span>. </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>
</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="cinnamon-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="refsect3">
<a name="st-texture-cache-load-gicon.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cache</p></td>
<td class="parameter_description"><p>The texture cache instance</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>theme_node</p></td>
<td class="parameter_description"><p>The <a class="link" href="cinnamon-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. </p></td>
<td class="parameter_annotations"><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 class="parameter_name"><p>icon</p></td>
<td class="parameter_description"><p>the <span class="type">GIcon</span> to load</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>size</p></td>
<td class="parameter_description"><p>Size of themed</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="st-texture-cache-load-gicon.returns"></a><h4>Returns</h4>
<p>A new <span class="type">ClutterActor</span> for the icon, or an empty ClutterActor
if none was found. </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>
</div>
<hr>
<div class="refsect2">
<a name="st-texture-cache-load-icon-name"></a><h3>st_texture_cache_load_icon_name ()</h3>
<pre class="programlisting"><span class="returnvalue">ClutterActor</span> *
st_texture_cache_load_icon_name (<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="cinnamon-st-st-theme-node.html#StThemeNode"><span class="type">StThemeNode</span></a> *theme_node</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
<em class="parameter"><code><span class="type">StIconType</span> icon_type</code></em>,
<em class="parameter"><code><span class="type">gint</span> size</code></em>);</pre>
<p>Load a themed icon into a texture. See the <span class="type">StIconType</span> documentation
for an explanation of how <em class="parameter"><code>icon_type</code></em>
affects the returned icon. The
colors used for symbolic icons are derived from <em class="parameter"><code>theme_node</code></em>
.</p>
<div class="refsect3">
<a name="st-texture-cache-load-icon-name.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cache</p></td>
<td class="parameter_description"><p>The texture cache instance</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>theme_node</p></td>
<td class="parameter_description"><p>a <a class="link" href="cinnamon-st-st-theme-node.html#StThemeNode"><span class="type">StThemeNode</span></a>. </p></td>
<td class="parameter_annotations"><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 class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>Name of a themed icon</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>icon_type</p></td>
<td class="parameter_description"><p>the type of icon to load</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>size</p></td>
<td class="parameter_description"><p>Size of themed</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="st-texture-cache-load-icon-name.returns"></a><h4>Returns</h4>
<p>A new <span class="type">ClutterTexture</span> for the icon. </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>
</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="refsect3">
<a name="st-texture-cache-load-uri-async.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cache</p></td>
<td class="parameter_description"><p>The texture cache instance</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>uri</p></td>
<td class="parameter_description"><p>uri of the image file from which to create a pixbuf</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>available_width</p></td>
<td class="parameter_description"><p>available width for the image, can be -1 if not limited</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>available_height</p></td>
<td class="parameter_description"><p>available height for the image, can be -1 if not limited</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="st-texture-cache-load-uri-async.returns"></a><h4>Returns</h4>
<p>A new <span class="type">ClutterActor</span> with no image loaded initially. </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>
</div>
<hr>
<div class="refsect2">
<a name="st-texture-cache-load-uri-sync"></a><h3>st_texture_cache_load_uri_sync ()</h3>
<pre class="programlisting"><span class="returnvalue">ClutterActor</span> *
st_texture_cache_load_uri_sync (<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="StTextureCache.html#StTextureCachePolicy" title="enum StTextureCachePolicy"><span class="type">StTextureCachePolicy</span></a> policy</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>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Synchronously load an image from a uri. The image is scaled down to fit the
available width and height imensions, but the image is never scaled up beyond
its actual size. The pixbuf is rotated according to the associated orientation
setting.</p>
<div class="refsect3">
<a name="st-texture-cache-load-uri-sync.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cache</p></td>
<td class="parameter_description"><p>The texture cache instance</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>policy</p></td>
<td class="parameter_description"><p>Requested lifecycle of cached data</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>uri</p></td>
<td class="parameter_description"><p>uri of the image file from which to create a pixbuf</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>available_width</p></td>
<td class="parameter_description"><p>available width for the image, can be -1 if not limited</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>available_height</p></td>
<td class="parameter_description"><p>available height for the image, can be -1 if not limited</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 error</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="st-texture-cache-load-uri-sync.returns"></a><h4>Returns</h4>
<p>A new <span class="type">ClutterActor</span> with the image file loaded if it was
generated successfully, <code class="literal">NULL</code> otherwise. </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>
</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">CoglTexture</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">NULL</code> is returned.</p>
<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
<div class="refsect3">
<a name="st-texture-cache-load-file-to-cogl-texture.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cache</p></td>
<td class="parameter_description"><p>A <a class="link" href="StTextureCache.html" title="StTextureCache"><span class="type">StTextureCache</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>file_path</p></td>
<td class="parameter_description"><p>Path to a file in supported image format</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="st-texture-cache-load-file-to-cogl-texture.returns"></a><h4>Returns</h4>
<p>a new <span class="type">CoglTexture</span>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</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="refsect3">
<a name="st-texture-cache-load-file-to-cairo-surface.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cache</p></td>
<td class="parameter_description"><p>A <a class="link" href="StTextureCache.html" title="StTextureCache"><span class="type">StTextureCache</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>file_path</p></td>
<td class="parameter_description"><p>Path to a file in supported image format</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="st-texture-cache-load-file-to-cairo-surface.returns"></a><h4>Returns</h4>
<p>a new <span class="type">cairo_surface_t</span>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="st-texture-cache-load-from-raw"></a><h3>st_texture_cache_load_from_raw ()</h3>
<pre class="programlisting"><span class="returnvalue">ClutterActor</span> *
st_texture_cache_load_from_raw (<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">guchar</span> *data</code></em>,
<em class="parameter"><code><span class="type">gsize</span> len</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> has_alpha</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">int</span> rowstride</code></em>,
<em class="parameter"><code><span class="type">int</span> size</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Creates (or retrieves from cache) an icon based on raw pixel data.</p>
<div class="refsect3">
<a name="st-texture-cache-load-from-raw.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cache</p></td>
<td class="parameter_description"><p>a <a class="link" href="StTextureCache.html" title="StTextureCache"><span class="type">StTextureCache</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>raw pixel data. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=len]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>len</p></td>
<td class="parameter_description"><p>the length of <em class="parameter"><code>data</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>has_alpha</p></td>
<td class="parameter_description"><p>whether <em class="parameter"><code>data</code></em>
includes an alpha channel</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>width</p></td>
<td class="parameter_description"><p>width in pixels of <em class="parameter"><code>data</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>height</p></td>
<td class="parameter_description"><p>width in pixels of <em class="parameter"><code>data</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>rowstride</p></td>
<td class="parameter_description"><p>rowstride of <em class="parameter"><code>data</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>size</p></td>
<td class="parameter_description"><p>size of icon to return</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="st-texture-cache-load-from-raw.returns"></a><h4>Returns</h4>
<p>a new <span class="type">ClutterActor</span> displaying a
pixbuf created from <em class="parameter"><code>data</code></em>
and the other parameters. </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>
</div>
<hr>
<div class="refsect2">
<a name="st-texture-cache-load-file-simple"></a><h3>st_texture_cache_load_file_simple ()</h3>
<pre class="programlisting"><span class="returnvalue">ClutterActor</span> *
st_texture_cache_load_file_simple (<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>Synchronously load an image into a texture. The texture will be cached
indefinitely. On error, this function returns an empty texture and prints a warning.</p>
<div class="refsect3">
<a name="st-texture-cache-load-file-simple.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cache</p></td>
<td class="parameter_description"><p>A <a class="link" href="StTextureCache.html" title="StTextureCache"><span class="type">StTextureCache</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>file_path</p></td>
<td class="parameter_description"><p>Filesystem path</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="st-texture-cache-load-file-simple.returns"></a><h4>Returns</h4>
<p>A new <span class="type">ClutterTexture</span>. </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>
</div>
<hr>
<div class="refsect2">
<a name="StTextureCacheLoader"></a><h3>StTextureCacheLoader ()</h3>
<pre class="programlisting"><span class="returnvalue">CoglTexture</span> *
<span class="c_punctuation">(</span>*StTextureCacheLoader<span class="c_punctuation">)</span> (<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>
<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
<div class="refsect3">
<a name="StTextureCacheLoader.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cache</p></td>
<td class="parameter_description"><p>a <a class="link" href="StTextureCache.html" title="StTextureCache"><span class="type">StTextureCache</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>key</p></td>
<td class="parameter_description"><p>Unique identifier for this texture</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>Callback user data</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>A <span class="type">GError</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</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">CoglTexture</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>
<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
<div class="refsect3">
<a name="st-texture-cache-load.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cache</p></td>
<td class="parameter_description"><p>A <a class="link" href="StTextureCache.html" title="StTextureCache"><span class="type">StTextureCache</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>key</p></td>
<td class="parameter_description"><p>Arbitrary string used to refer to item</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>policy</p></td>
<td class="parameter_description"><p>Caching policy</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>load</p></td>
<td class="parameter_description"><p>Function to create the texture, if not already cached</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>User data passed to <em class="parameter"><code>load</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>A <span class="type">GError</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="st-texture-cache-load.returns"></a><h4>Returns</h4>
<p>A newly-referenced handle to the texture. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="StTextureCache.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="StTextureCachePolicy"></a><h3>enum StTextureCachePolicy</h3>
<div class="refsect3">
<a name="StTextureCachePolicy.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="ST-TEXTURE-CACHE-POLICY-NONE:CAPS"></a>ST_TEXTURE_CACHE_POLICY_NONE</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="ST-TEXTURE-CACHE-POLICY-FOREVER:CAPS"></a>ST_TEXTURE_CACHE_POLICY_FOREVER</p></td>
<td> </td>
<td> </td>
</tr>
</tbody>
</table></div>
</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)</pre>
<p>Flags: Run Last</p>
</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)</pre>
<p>Flags: Run Last</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>
|