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
|
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="libgimpbase-gimpmemsize">
<refmeta>
<refentrytitle>gimpmemsize</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMPBASE Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gimpmemsize</refname><refpurpose>Functions to (de)serialize a given memory size.</refpurpose>
</refnamediv>
<refsynopsisdiv><title>Synopsis</title>
<synopsis>
<link linkend="gchar">gchar</link>* <link linkend="gimp-memsize-serialize">gimp_memsize_serialize</link> (<link linkend="guint64">guint64</link> memsize);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-memsize-deserialize">gimp_memsize_deserialize</link> (const <link linkend="gchar">gchar</link> *string,
<link linkend="guint64">guint64</link> *memsize);
<link linkend="gchar">gchar</link>* <link linkend="gimp-memsize-to-string">gimp_memsize_to_string</link> (<link linkend="guint64">guint64</link> memsize);
#define <link linkend="GIMP-TYPE-MEMSIZE:CAPS">GIMP_TYPE_MEMSIZE</link>
#define <link linkend="GIMP-VALUE-HOLDS-MEMSIZE:CAPS">GIMP_VALUE_HOLDS_MEMSIZE</link> (value)
</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Functions to (de)serialize a given memory size.
</para>
</refsect1>
<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="gimp-memsize-serialize"/>gimp_memsize_serialize ()</title>
<indexterm role="GIMP"><primary>gimp_memsize_serialize</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_memsize_serialize (<link linkend="guint64">guint64</link> memsize);</programlisting>
<para>
Creates a string representation of a given memory size. This string
can be parsed by <link linkend="gimp-memsize-deserialize"><function>gimp_memsize_deserialize()</function></link> 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 <link linkend="gimp-memsize-to-string"><function>gimp_memsize_to_string()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>memsize</parameter> :</term>
<listitem><simpara> memory size in bytes
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A newly allocated string representation of <parameter>memsize</parameter>.
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-memsize-deserialize"/>gimp_memsize_deserialize ()</title>
<indexterm role="GIMP"><primary>gimp_memsize_deserialize</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_memsize_deserialize (const <link linkend="gchar">gchar</link> *string,
<link linkend="guint64">guint64</link> *memsize);</programlisting>
<para>
Parses a string representation of a memory size as returned by
<link linkend="gimp-memsize-serialize"><function>gimp_memsize_serialize()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>string</parameter> :</term>
<listitem><simpara> a string as returned by <link linkend="gimp-memsize-serialize"><function>gimp_memsize_serialize()</function></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>memsize</parameter> :</term>
<listitem><simpara> return location for memory size in bytes
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <literal>TRUE</literal> if the <parameter>string</parameter> was successfully parsed and
<parameter>memsize</parameter> has been set, <literal>FALSE</literal> otherwise.
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-memsize-to-string"/>gimp_memsize_to_string ()</title>
<indexterm><primary>gimp_memsize_to_string</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_memsize_to_string (<link linkend="guint64">guint64</link> memsize);</programlisting>
<para>
This function returns a human readable, translated representation
of the passed <parameter>memsize</parameter>. Large values are displayed using a
reasonable memsize unit, e.g.: "345" becomes "345 Bytes", "4500"
becomes "4.4 KB" and so on.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>memsize</parameter> :</term>
<listitem><simpara> A memory size in bytes.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A newly allocated human-readable, translated string.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="GIMP-TYPE-MEMSIZE:CAPS"/>GIMP_TYPE_MEMSIZE</title>
<indexterm><primary>GIMP_TYPE_MEMSIZE</primary></indexterm><programlisting>#define GIMP_TYPE_MEMSIZE (gimp_memsize_get_type ())
</programlisting>
<para>
<link linkend="GIMP-TYPE-MEMSIZE:CAPS"><type>GIMP_TYPE_MEMSIZE</type></link> is a <link linkend="GType"><type>GType</type></link> derived from <link linkend="G-TYPE-UINT64:CAPS"><type>G_TYPE_UINT64</type></link>.
</para></refsect2>
<refsect2>
<title><anchor id="GIMP-VALUE-HOLDS-MEMSIZE:CAPS"/>GIMP_VALUE_HOLDS_MEMSIZE()</title>
<indexterm><primary>GIMP_VALUE_HOLDS_MEMSIZE</primary></indexterm><programlisting>#define GIMP_VALUE_HOLDS_MEMSIZE(value) (G_TYPE_CHECK_VALUE_TYPE ((value), GIMP_TYPE_MEMSIZE))
</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>value</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
