365 lines
15 KiB
HTML
365 lines
15 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||
<html>
|
||
<head>
|
||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||
<title>gimpmemsize</title>
|
||
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
|
||
<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-gimprectangle.html" title="gimprectangle">
|
||
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
|
||
<link rel="stylesheet" href="style.css" type="text/css">
|
||
<link rel="part" href="libgimpbase.html" title="Part I. GIMP Base Library">
|
||
<link rel="index" href="libgimpbase-index.html" title="Index">
|
||
<link rel="index" href="libgimpbase-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
|
||
<link rel="index" href="libgimpbase-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
|
||
<link rel="index" href="libgimpbase-index-new-in-2-6.html" title="Index of new symbols in GIMP 2.6">
|
||
<link rel="index" href="libgimpbase-index-deprecated.html" title="Index of deprecated symbols">
|
||
</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-gimprectangle.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="#libgimpbase-gimpmemsize.synopsis" class="shortcut">Top</a>
|
||
|
|
||
<a href="#libgimpbase-gimpmemsize.description" 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><span class="refentrytitle"><a name="libgimpbase-gimpmemsize.top_of_page"></a>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">
|
||
<a name="libgimpbase-gimpmemsize.synopsis"></a><h2>Synopsis</h2>
|
||
<pre class="synopsis">
|
||
<a
|
||
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
|
||
>gchar</a>* <a class="link" href="libgimpbase-gimpmemsize.html#gimp-memsize-serialize" title="gimp_memsize_serialize ()">gimp_memsize_serialize</a> (<a
|
||
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"
|
||
>guint64</a> memsize);
|
||
<a
|
||
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
|
||
>gboolean</a> <a class="link" href="libgimpbase-gimpmemsize.html#gimp-memsize-deserialize" title="gimp_memsize_deserialize ()">gimp_memsize_deserialize</a> (const <a
|
||
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
|
||
>gchar</a> *string,
|
||
<a
|
||
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"
|
||
>guint64</a> *memsize);
|
||
<a
|
||
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
|
||
>gchar</a>* <a class="link" href="libgimpbase-gimpmemsize.html#gimp-memsize-to-string" title="gimp_memsize_to_string ()">gimp_memsize_to_string</a> (<a
|
||
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"
|
||
>guint64</a> memsize);
|
||
#define <a class="link" href="libgimpbase-gimpmemsize.html#GIMP-TYPE-MEMSIZE:CAPS" title="GIMP_TYPE_MEMSIZE">GIMP_TYPE_MEMSIZE</a>
|
||
#define <a class="link" href="libgimpbase-gimpmemsize.html#GIMP-TYPE-PARAM-MEMSIZE:CAPS" title="GIMP_TYPE_PARAM_MEMSIZE">GIMP_TYPE_PARAM_MEMSIZE</a>
|
||
#define <a class="link" href="libgimpbase-gimpmemsize.html#GIMP-IS-PARAM-SPEC-MEMSIZE:CAPS" title="GIMP_IS_PARAM_SPEC_MEMSIZE()">GIMP_IS_PARAM_SPEC_MEMSIZE</a> (pspec)
|
||
<a
|
||
href="/usr/share/gtk-doc/html/gobject/gobject-GParamSpec.html#GParamSpec"
|
||
>GParamSpec</a>* <a class="link" href="libgimpbase-gimpmemsize.html#gimp-param-spec-memsize" title="gimp_param_spec_memsize ()">gimp_param_spec_memsize</a> (const <a
|
||
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
|
||
>gchar</a> *name,
|
||
const <a
|
||
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
|
||
>gchar</a> *nick,
|
||
const <a
|
||
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
|
||
>gchar</a> *blurb,
|
||
<a
|
||
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"
|
||
>guint64</a> minimum,
|
||
<a
|
||
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"
|
||
>guint64</a> maximum,
|
||
<a
|
||
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"
|
||
>guint64</a> default_value,
|
||
<a
|
||
href="/usr/share/gtk-doc/html/gobject/gobject-GParamSpec.html#GParamFlags"
|
||
>GParamFlags</a> flags);
|
||
#define <a class="link" href="libgimpbase-gimpmemsize.html#GIMP-VALUE-HOLDS-MEMSIZE:CAPS" title="GIMP_VALUE_HOLDS_MEMSIZE()">GIMP_VALUE_HOLDS_MEMSIZE</a> (value)
|
||
</pre>
|
||
</div>
|
||
<div class="refsect1" lang="en">
|
||
<a name="libgimpbase-gimpmemsize.description"></a><h2>Description</h2>
|
||
<p>
|
||
Functions to (de)serialize a given memory size.
|
||
</p>
|
||
</div>
|
||
<div class="refsect1" lang="en">
|
||
<a name="libgimpbase-gimpmemsize.details"></a><h2>Details</h2>
|
||
<div class="refsect2" lang="en">
|
||
<a name="gimp-memsize-serialize"></a><h3>gimp_memsize_serialize ()</h3>
|
||
<pre class="programlisting"><a
|
||
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
|
||
>gchar</a>* gimp_memsize_serialize (<a
|
||
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"
|
||
>guint64</a> memsize);</pre>
|
||
<p>
|
||
Creates a string representation of a given memory size. This string
|
||
can be parsed by <a class="link" href="libgimpbase-gimpmemsize.html#gimp-memsize-deserialize" title="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="/usr/share/gtk-doc/html/glib/glib-Miscellaneous-Utility-Functions.html#g-format-size-for-display"
|
||
><code class="function">g_format_size_for_display()</code></a>.</p>
|
||
<p>
|
||
|
||
</p>
|
||
<div class="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>memsize</code></em> :</span></p></td>
|
||
<td> memory size in bytes
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td> A newly allocated string representation of <em class="parameter"><code>memsize</code></em>.
|
||
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
<p class="since">Since GIMP 2.2
|
||
</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2" lang="en">
|
||
<a name="gimp-memsize-deserialize"></a><h3>gimp_memsize_deserialize ()</h3>
|
||
<pre class="programlisting"><a
|
||
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
|
||
>gboolean</a> gimp_memsize_deserialize (const <a
|
||
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
|
||
>gchar</a> *string,
|
||
<a
|
||
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"
|
||
>guint64</a> *memsize);</pre>
|
||
<p>
|
||
Parses a string representation of a memory size as returned by
|
||
<a class="link" href="libgimpbase-gimpmemsize.html#gimp-memsize-serialize" title="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><p><span class="term"><em class="parameter"><code>string</code></em> :</span></p></td>
|
||
<td> a string as returned by <a class="link" href="libgimpbase-gimpmemsize.html#gimp-memsize-serialize" title="gimp_memsize_serialize ()"><code class="function">gimp_memsize_serialize()</code></a>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>memsize</code></em> :</span></p></td>
|
||
<td> return location for memory size in bytes
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></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 class="since">Since GIMP 2.2
|
||
</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2" lang="en">
|
||
<a name="gimp-memsize-to-string"></a><h3>gimp_memsize_to_string ()</h3>
|
||
<pre class="programlisting"><a
|
||
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
|
||
>gchar</a>* gimp_memsize_to_string (<a
|
||
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"
|
||
>guint64</a> memsize);</pre>
|
||
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
|
||
<h3 class="title">Warning</h3>
|
||
<p><code class="literal">gimp_memsize_to_string</code> is deprecated and should not be used in newly-written code.</p>
|
||
</div>
|
||
<p>
|
||
This function is deprecated! Use <a
|
||
href="/usr/share/gtk-doc/html/glib/glib-Miscellaneous-Utility-Functions.html#g-format-size-for-display"
|
||
><code class="function">g_format_size_for_display()</code></a> instead.</p>
|
||
<p>
|
||
|
||
</p>
|
||
<div class="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>memsize</code></em> :</span></p></td>
|
||
<td> A memory size in bytes.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td> A newly allocated human-readable, translated string.
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2" lang="en">
|
||
<a name="GIMP-TYPE-MEMSIZE:CAPS"></a><h3>GIMP_TYPE_MEMSIZE</h3>
|
||
<pre class="programlisting">#define GIMP_TYPE_MEMSIZE (gimp_memsize_get_type ())
|
||
</pre>
|
||
<p>
|
||
<a class="link" href="libgimpbase-gimpmemsize.html#GIMP-TYPE-MEMSIZE:CAPS" title="GIMP_TYPE_MEMSIZE"><span class="type">GIMP_TYPE_MEMSIZE</span></a> is a <a
|
||
href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"
|
||
><span class="type">GType</span></a> derived from <span class="type">G_TYPE_UINT64</span>.
|
||
</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2" lang="en">
|
||
<a name="GIMP-TYPE-PARAM-MEMSIZE:CAPS"></a><h3>GIMP_TYPE_PARAM_MEMSIZE</h3>
|
||
<pre class="programlisting">#define GIMP_TYPE_PARAM_MEMSIZE (gimp_param_memsize_get_type ())
|
||
</pre>
|
||
<p>
|
||
|
||
</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2" lang="en">
|
||
<a name="GIMP-IS-PARAM-SPEC-MEMSIZE:CAPS"></a><h3>GIMP_IS_PARAM_SPEC_MEMSIZE()</h3>
|
||
<pre class="programlisting">#define GIMP_IS_PARAM_SPEC_MEMSIZE(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), GIMP_TYPE_PARAM_MEMSIZE))
|
||
</pre>
|
||
<p>
|
||
|
||
</p>
|
||
<div class="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody><tr>
|
||
<td><p><span class="term"><em class="parameter"><code>pspec</code></em> :</span></p></td>
|
||
<td>
|
||
|
||
|
||
</td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2" lang="en">
|
||
<a name="gimp-param-spec-memsize"></a><h3>gimp_param_spec_memsize ()</h3>
|
||
<pre class="programlisting"><a
|
||
href="/usr/share/gtk-doc/html/gobject/gobject-GParamSpec.html#GParamSpec"
|
||
>GParamSpec</a>* gimp_param_spec_memsize (const <a
|
||
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
|
||
>gchar</a> *name,
|
||
const <a
|
||
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
|
||
>gchar</a> *nick,
|
||
const <a
|
||
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
|
||
>gchar</a> *blurb,
|
||
<a
|
||
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"
|
||
>guint64</a> minimum,
|
||
<a
|
||
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"
|
||
>guint64</a> maximum,
|
||
<a
|
||
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"
|
||
>guint64</a> default_value,
|
||
<a
|
||
href="/usr/share/gtk-doc/html/gobject/gobject-GParamSpec.html#GParamFlags"
|
||
>GParamFlags</a> flags);</pre>
|
||
<p>
|
||
Creates a param spec to hold a memory size value.
|
||
See <a
|
||
href="/usr/share/gtk-doc/html/gobject/gobject-GParamSpec.html#g-param-spec-internal"
|
||
><code class="function">g_param_spec_internal()</code></a> for more information.</p>
|
||
<p>
|
||
|
||
</p>
|
||
<div class="variablelist"><table border="0">
|
||
<col align="left" valign="top">
|
||
<tbody>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
|
||
<td> Canonical name of the param
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>nick</code></em> :</span></p></td>
|
||
<td> Nickname of the param
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>blurb</code></em> :</span></p></td>
|
||
<td> Brief desciption of param.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>minimum</code></em> :</span></p></td>
|
||
<td> Smallest allowed value of the parameter.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>maximum</code></em> :</span></p></td>
|
||
<td> Largest allowed value of the parameter.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>default_value</code></em> :</span></p></td>
|
||
<td> Value to use if none is assigned.
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
|
||
<td> a combination of <a
|
||
href="/usr/share/gtk-doc/html/gobject/gobject-GParamSpec.html#GParamFlags"
|
||
><span class="type">GParamFlags</span></a>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
||
<td> a newly allocated <a
|
||
href="/usr/share/gtk-doc/html/gobject/gobject-GParamSpec.html#GParamSpec"
|
||
><span class="type">GParamSpec</span></a> instance
|
||
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
<p class="since">Since GIMP 2.4
|
||
</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2" lang="en">
|
||
<a name="GIMP-VALUE-HOLDS-MEMSIZE:CAPS"></a><h3>GIMP_VALUE_HOLDS_MEMSIZE()</h3>
|
||
<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><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
|
||
<td>
|
||
|
||
|
||
</td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="footer">
|
||
<hr>
|
||
Generated by GTK-Doc V1.10</div>
|
||
</body>
|
||
</html>
|