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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gimpmemsize</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="GIMP Base Library Reference Manual">
<link rel="up" href="libgimpbase.html" title="Part I. GIMP Base Library">
<link rel="prev" href="libgimpbase-gimpenv.html" title="gimpenv">
<link rel="next" href="libgimpbase-gimpparasite.html" title="gimpparasite">
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimpbase.html" title="Part I. GIMP Base Library">
</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="2">
<tr valign="middle">
<td><a accesskey="p" href="libgimpbase-gimpenv.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimpbase.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GIMP Base Library Reference Manual</th>
<td><a accesskey="n" href="libgimpbase-gimpparasite.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2561991" class="shortcut">Top</a>
 | 
<a href="#id2543707" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libgimpbase-gimpmemsize"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2561991"></a><span class="refentrytitle">gimpmemsize</span>
</h2>
<p>gimpmemsize — Functions to (de)serialize a given memory size.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
gchar* <a href="libgimpbase-gimpmemsize.html#gimp-memsize-serialize">gimp_memsize_serialize</a> (guint64 memsize);
gboolean <a href="libgimpbase-gimpmemsize.html#gimp-memsize-deserialize">gimp_memsize_deserialize</a> (const gchar *string,
guint64 *memsize);
gchar* <a href="libgimpbase-gimpmemsize.html#gimp-memsize-to-string">gimp_memsize_to_string</a> (guint64 memsize);
#define <a href="libgimpbase-gimpmemsize.html#GIMP-TYPE-MEMSIZE:CAPS">GIMP_TYPE_MEMSIZE</a>
#define <a href="libgimpbase-gimpmemsize.html#GIMP-VALUE-HOLDS-MEMSIZE:CAPS">GIMP_VALUE_HOLDS_MEMSIZE</a> (value)
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2543707"></a><h2>Description</h2>
<p>
Functions to (de)serialize a given memory size.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2543723"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2543734"></a><h3>
<a name="gimp-memsize-serialize"></a>gimp_memsize_serialize ()</h3>
<a class="indexterm" name="id2543747"></a><pre class="programlisting">gchar* gimp_memsize_serialize (guint64 memsize);</pre>
<p>
Creates a string representation of a given memory size. This string
can be parsed by <a href="libgimpbase-gimpmemsize.html#gimp-memsize-deserialize"><code class="function">gimp_memsize_deserialize()</code></a> and can thus be used in
config files. It should not be displayed to the user. If you need a
nice human-readable string please use <a href="libgimpbase-gimpmemsize.html#gimp-memsize-to-string"><code class="function">gimp_memsize_to_string()</code></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>memsize</code></em> :</span></td>
<td> memory size in bytes
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> A newly allocated string representation of <em class="parameter"><code>memsize</code></em>.
</td>
</tr>
</tbody>
</table></div>
<p>Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2544691"></a><h3>
<a name="gimp-memsize-deserialize"></a>gimp_memsize_deserialize ()</h3>
<a class="indexterm" name="id2544704"></a><pre class="programlisting">gboolean gimp_memsize_deserialize (const gchar *string,
guint64 *memsize);</pre>
<p>
Parses a string representation of a memory size as returned by
<a href="libgimpbase-gimpmemsize.html#gimp-memsize-serialize"><code class="function">gimp_memsize_serialize()</code></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>string</code></em> :</span></td>
<td> a string as returned by <a href="libgimpbase-gimpmemsize.html#gimp-memsize-serialize"><code class="function">gimp_memsize_serialize()</code></a>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>memsize</code></em> :</span></td>
<td> return location for memory size in bytes
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> <code class="literal">TRUE</code> if the <em class="parameter"><code>string</code></em> was successfully parsed and
<em class="parameter"><code>memsize</code></em> has been set, <code class="literal">FALSE</code> otherwise.
</td>
</tr>
</tbody>
</table></div>
<p>Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2555586"></a><h3>
<a name="gimp-memsize-to-string"></a>gimp_memsize_to_string ()</h3>
<a class="indexterm" name="id2555597"></a><pre class="programlisting">gchar* gimp_memsize_to_string (guint64 memsize);</pre>
<p>
This function returns a human readable, translated representation
of the passed <em class="parameter"><code>memsize</code></em>. Large values are displayed using a
reasonable memsize unit, e.g.: "345" becomes "345 Bytes", "4500"
becomes "4.4 KB" and so on.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>memsize</code></em> :</span></td>
<td> A memory size in bytes.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> A newly allocated human-readable, translated string.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2555667"></a><h3>
<a name="GIMP-TYPE-MEMSIZE:CAPS"></a>GIMP_TYPE_MEMSIZE</h3>
<a class="indexterm" name="id2555678"></a><pre class="programlisting">#define GIMP_TYPE_MEMSIZE (gimp_memsize_get_type ())
</pre>
<p>
<a href="libgimpbase-gimpmemsize.html#GIMP-TYPE-MEMSIZE:CAPS"><span class="type">GIMP_TYPE_MEMSIZE</span></a> is a <span class="type">GType</span> derived from <span class="type">G_TYPE_UINT64</span>.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2555715"></a><h3>
<a name="GIMP-VALUE-HOLDS-MEMSIZE:CAPS"></a>GIMP_VALUE_HOLDS_MEMSIZE()</h3>
<a class="indexterm" name="id2555727"></a><pre class="programlisting">#define GIMP_VALUE_HOLDS_MEMSIZE(value) (G_TYPE_CHECK_VALUE_TYPE ((value), GIMP_TYPE_MEMSIZE))
</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>value</code></em> :</span></td>
<td>
</td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>
|