/usr/share/gtk-doc/html/cogl/cogl-Bitmaps.html is in libcogl-doc 1.18.2-3.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Cogl Reference Manual: Bitmaps</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Cogl Reference Manual">
<link rel="up" href="ch01.html" title="Cogl - a modern 3D graphics API">
<link rel="prev" href="cogl-Offscreen-Buffers.html" title="Offscreen Buffers">
<link rel="next" href="cogl-Fixed-Point-API.html" title="Fixed Point API">
<meta name="generator" content="GTK-Doc V1.21 (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="#cogl-Bitmaps.description" class="shortcut">Description</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="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="cogl-Offscreen-Buffers.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="cogl-Fixed-Point-API.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="cogl-Bitmaps"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="cogl-Bitmaps.top_of_page"></a>Bitmaps</span></h2>
<p>Bitmaps — Functions for loading images</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="cogl-Bitmaps.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="cogl-Bitmaps.html#CoglBitmap" title="CoglBitmap"><span class="returnvalue">CoglBitmap</span></a> *
</td>
<td class="function_name">
<a class="link" href="cogl-Bitmaps.html#cogl-bitmap-new-from-file" title="cogl_bitmap_new_from_file ()">cogl_bitmap_new_from_file</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">CoglBool</span>
</td>
<td class="function_name">
<a class="link" href="cogl-Bitmaps.html#cogl-bitmap-get-size-from-file" title="cogl_bitmap_get_size_from_file ()">cogl_bitmap_get_size_from_file</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">CoglBool</span>
</td>
<td class="function_name">
<a class="link" href="cogl-Bitmaps.html#cogl-is-bitmap" title="cogl_is_bitmap ()">cogl_is_bitmap</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="cogl-Bitmaps.html#COGL-BITMAP-ERROR:CAPS" title="COGL_BITMAP_ERROR">COGL_BITMAP_ERROR</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="cogl-Bitmaps.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="cogl-Bitmaps.html#CoglBitmap" title="CoglBitmap">CoglBitmap</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="cogl-Bitmaps.html#CoglBitmapError" title="enum CoglBitmapError">CoglBitmapError</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="cogl-Bitmaps.description"></a><h2>Description</h2>
<p>Cogl allows loading image data into memory as CoglBitmaps without
loading them immediately into GPU textures.</p>
<p><a class="link" href="cogl-Bitmaps.html#CoglBitmap" title="CoglBitmap"><span class="type">CoglBitmap</span></a> is available since Cogl 1.0</p>
</div>
<div class="refsect1">
<a name="cogl-Bitmaps.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="cogl-bitmap-new-from-file"></a><h3>cogl_bitmap_new_from_file ()</h3>
<pre class="programlisting"><a class="link" href="cogl-Bitmaps.html#CoglBitmap" title="CoglBitmap"><span class="returnvalue">CoglBitmap</span></a> *
cogl_bitmap_new_from_file (<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>,
<em class="parameter"><code><span class="type">CoglError</span> **error</code></em>);</pre>
<p>Loads an image file from disk. This function can be safely called from
within a thread.</p>
<div class="refsect3">
<a name="id-1.2.15.6.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>the file to load.</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">CoglError</span> or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.15.6.2.6"></a><h4>Returns</h4>
<p> a <a class="link" href="cogl-Bitmaps.html#CoglBitmap" title="CoglBitmap"><span class="type">CoglBitmap</span></a> to the new loaded
image data, or <code class="literal">NULL</code> if loading the image failed. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since 1.0</p>
</div>
<hr>
<div class="refsect2">
<a name="cogl-bitmap-get-size-from-file"></a><h3>cogl_bitmap_get_size_from_file ()</h3>
<pre class="programlisting"><span class="returnvalue">CoglBool</span>
cogl_bitmap_get_size_from_file (<em class="parameter"><code>const <span class="type">char</span> *filename</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>);</pre>
<p>Parses an image file enough to extract the width and height
of the bitmap.</p>
<div class="refsect3">
<a name="id-1.2.15.6.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>the file to check</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>width</p></td>
<td class="parameter_description"><p> return location for the bitmap width, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>height</p></td>
<td class="parameter_description"><p> return location for the bitmap height, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.15.6.3.6"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the image was successfully parsed</p>
<p></p>
</div>
<p class="since">Since 1.0</p>
</div>
<hr>
<div class="refsect2">
<a name="cogl-is-bitmap"></a><h3>cogl_is_bitmap ()</h3>
<pre class="programlisting"><span class="returnvalue">CoglBool</span>
cogl_is_bitmap (<em class="parameter"><code><span class="type">void</span> *object</code></em>);</pre>
<p>Checks whether <em class="parameter"><code>object</code></em>
is a <a class="link" href="cogl-Bitmaps.html#CoglBitmap" title="CoglBitmap"><span class="type">CoglBitmap</span></a></p>
<div class="refsect3">
<a name="id-1.2.15.6.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>object</p></td>
<td class="parameter_description"><p>a <a class="link" href="cogl-General-API.html#CoglObject" title="CoglObject"><span class="type">CoglObject</span></a> pointer</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.15.6.4.6"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the passed <em class="parameter"><code>object</code></em>
represents a bitmap,
and <code class="literal">FALSE</code> otherwise</p>
<p></p>
</div>
<p class="since">Since 1.0</p>
</div>
<hr>
<div class="refsect2">
<a name="COGL-BITMAP-ERROR:CAPS"></a><h3>COGL_BITMAP_ERROR</h3>
<pre class="programlisting">#define COGL_BITMAP_ERROR (cogl_bitmap_error_quark ())
</pre>
<p><span class="type">CoglError</span> domain for bitmap errors.</p>
<p class="since">Since 1.4</p>
</div>
</div>
<div class="refsect1">
<a name="cogl-Bitmaps.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="CoglBitmap"></a><h3>CoglBitmap</h3>
<pre class="programlisting">typedef struct _CoglBitmap CoglBitmap;</pre>
</div>
<hr>
<div class="refsect2">
<a name="CoglBitmapError"></a><h3>enum CoglBitmapError</h3>
<p>Error codes that can be thrown when performing bitmap
operations. Note that <code class="function">gdk_pixbuf_new_from_file()</code> can also throw
errors directly from the underlying image loading library. For
example, if GdkPixbuf is used then errors <span class="type">GdkPixbufError</span>s
will be used directly.</p>
<div class="refsect3">
<a name="id-1.2.15.7.3.4"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="COGL-BITMAP-ERROR-FAILED:CAPS"></a>COGL_BITMAP_ERROR_FAILED</p></td>
<td class="enum_member_description">
<p>Generic failure code, something went
wrong.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="COGL-BITMAP-ERROR-UNKNOWN-TYPE:CAPS"></a>COGL_BITMAP_ERROR_UNKNOWN_TYPE</p></td>
<td class="enum_member_description">
<p>Unknown image type.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="COGL-BITMAP-ERROR-CORRUPT-IMAGE:CAPS"></a>COGL_BITMAP_ERROR_CORRUPT_IMAGE</p></td>
<td class="enum_member_description">
<p>An image file was broken somehow.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 1.4</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.21</div>
</body>
</html>
|