3
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4
<title>gimpmemsize</title>
5
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
6
<link rel="start" href="index.html" title="GIMP Base Library Reference Manual">
7
<link rel="up" href="libgimpbase.html" title="Part I. GIMP Base Library">
8
<link rel="prev" href="libgimpbase-gimpenv.html" title="gimpenv">
9
<link rel="next" href="libgimpbase-gimpparasite.html" title="gimpparasite">
10
<meta name="generator" content="GTK-Doc V1.4 (XML mode)">
11
<link rel="stylesheet" href="style.css" type="text/css">
12
<link rel="part" href="libgimpbase.html" title="Part I. GIMP Base Library">
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
<table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
16
<td><a accesskey="p" href="libgimpbase-gimpenv.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
17
<td><a accesskey="u" href="libgimpbase.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
18
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
19
<th width="100%" align="center">GIMP Base Library Reference Manual</th>
20
<td><a accesskey="n" href="libgimpbase-gimpparasite.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22
<div class="refentry" lang="en">
23
<a name="libgimpbase-gimpmemsize"></a><div class="titlepage"></div>
24
<div class="refnamediv"><table width="100%"><tr>
26
<h2><span class="refentrytitle">gimpmemsize</span></h2>
27
<p>gimpmemsize — Functions to (de)serialize a given memory size.</p>
29
<td valign="top" align="right"></td>
31
<div class="refsynopsisdiv">
33
<pre class="synopsis">
37
gchar* <a href="libgimpbase-gimpmemsize.html#gimp-memsize-serialize">gimp_memsize_serialize</a> (guint64 memsize);
38
gboolean <a href="libgimpbase-gimpmemsize.html#gimp-memsize-deserialize">gimp_memsize_deserialize</a> (const gchar *string,
40
gchar* <a href="libgimpbase-gimpmemsize.html#gimp-memsize-to-string">gimp_memsize_to_string</a> (guint64 memsize);
41
#define <a href="libgimpbase-gimpmemsize.html#GIMP-TYPE-MEMSIZE:CAPS">GIMP_TYPE_MEMSIZE</a>
42
#define <a href="libgimpbase-gimpmemsize.html#GIMP-VALUE-HOLDS-MEMSIZE:CAPS">GIMP_VALUE_HOLDS_MEMSIZE</a> (value)
46
<div class="refsect1" lang="en">
47
<a name="id2551625"></a><h2>Description</h2>
49
Functions to (de)serialize a given memory size.
52
<div class="refsect1" lang="en">
53
<a name="id2551636"></a><h2>Details</h2>
54
<div class="refsect2" lang="en">
55
<a name="id2551643"></a><h3>
56
<a name="gimp-memsize-serialize"></a>gimp_memsize_serialize ()</h3>
57
<a class="indexterm" name="id2527744"></a><pre class="programlisting">gchar* gimp_memsize_serialize (guint64 memsize);</pre>
59
Creates a string representation of a given memory size. This string
60
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
61
config files. It should not be displayed to the user. If you need a
62
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>
66
<div class="variablelist"><table border="0">
67
<col align="left" valign="top">
71
<span class="term"><em class="parameter"><code>memsize</code></em> :</span></td>
72
<td> memory size in bytes
77
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
78
<td> A newly allocated string representation of <em class="parameter"><code>memsize</code></em>.
88
<div class="refsect2" lang="en">
89
<a name="id2527835"></a><h3>
90
<a name="gimp-memsize-deserialize"></a>gimp_memsize_deserialize ()</h3>
91
<a class="indexterm" name="id2527844"></a><pre class="programlisting">gboolean gimp_memsize_deserialize (const gchar *string,
92
guint64 *memsize);</pre>
94
Parses a string representation of a memory size as returned by
95
<a href="libgimpbase-gimpmemsize.html#gimp-memsize-serialize"><code class="function">gimp_memsize_serialize()</code></a>.</p>
99
<div class="variablelist"><table border="0">
100
<col align="left" valign="top">
104
<span class="term"><em class="parameter"><code>string</code></em> :</span></td>
105
<td> a string as returned by <a href="libgimpbase-gimpmemsize.html#gimp-memsize-serialize"><code class="function">gimp_memsize_serialize()</code></a>
110
<span class="term"><em class="parameter"><code>memsize</code></em> :</span></td>
111
<td> return location for memory size in bytes
116
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
117
<td> <code class="literal">TRUE</code> if the <em class="parameter"><code>string</code></em> was successfully parsed and
118
<em class="parameter"><code>memsize</code></em> has been set, <code class="literal">FALSE</code> otherwise.
128
<div class="refsect2" lang="en">
129
<a name="id2547893"></a><h3>
130
<a name="gimp-memsize-to-string"></a>gimp_memsize_to_string ()</h3>
131
<a class="indexterm" name="id2547902"></a><pre class="programlisting">gchar* gimp_memsize_to_string (guint64 memsize);</pre>
133
This function returns a human readable, translated representation
134
of the passed <em class="parameter"><code>memsize</code></em>. Large values are displayed using a
135
reasonable memsize unit, e.g.: "345" becomes "345 Bytes", "4500"
136
becomes "4.4 KB" and so on.</p>
140
<div class="variablelist"><table border="0">
141
<col align="left" valign="top">
145
<span class="term"><em class="parameter"><code>memsize</code></em> :</span></td>
146
<td> A memory size in bytes.
151
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
152
<td> A newly allocated human-readable, translated string.
159
<div class="refsect2" lang="en">
160
<a name="id2520294"></a><h3>
161
<a name="GIMP-TYPE-MEMSIZE:CAPS"></a>GIMP_TYPE_MEMSIZE</h3>
162
<a class="indexterm" name="id2520304"></a><pre class="programlisting">#define GIMP_TYPE_MEMSIZE (gimp_memsize_get_type ())
165
<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>.
169
<div class="refsect2" lang="en">
170
<a name="id2520341"></a><h3>
171
<a name="GIMP-VALUE-HOLDS-MEMSIZE:CAPS"></a>GIMP_VALUE_HOLDS_MEMSIZE()</h3>
172
<a class="indexterm" name="id2520350"></a><pre class="programlisting">#define GIMP_VALUE_HOLDS_MEMSIZE(value) (G_TYPE_CHECK_VALUE_TYPE ((value), GIMP_TYPE_MEMSIZE))
177
<div class="variablelist"><table border="0">
178
<col align="left" valign="top">
181
<span class="term"><em class="parameter"><code>value</code></em> :</span></td>
191
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle">
192
<td align="left"><a accesskey="p" href="libgimpbase-gimpenv.html"><b><< gimpenv</b></a></td>
193
<td align="right"><a accesskey="n" href="libgimpbase-gimpparasite.html"><b>gimpparasite >></b></a></td>
added
removed
devel-docs/libgimpbase/html/libgimpbase-gimpmemsize.html
