← Back to branch summary

~ubuntu-branches/ubuntu/precise/gdk-pixbuf/precise-proposed

« back to all changes in this revision

Viewing changes to docs/reference/gdk-pixbuf/gdk-pixbuf-csource.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-07-23 11:26:25 UTC
  • mto: (4.1.1 sid) (33.1.2 sid) (1.2.2 experimental)
  • mto: This revision was merged to the branch mainline in revision 5.
  • Revision ID: james.westby@ubuntu.com-20100723112625-1ybus2sr4hyhmlku
Tags: upstream-2.21.6
Import upstream version 2.21.6

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/gdk-pixbuf/gdk-pixbuf-csource.xml
 
1
<?xml version="1.0"?>
 
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
 
3
               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
 
4
]>
 
5
<refentry id="gdk-pixbuf-csource">
 
6
 
 
7
<refmeta>
 
8
<refentrytitle>gdk-pixbuf-csource</refentrytitle>
 
9
<manvolnum>1</manvolnum>
 
10
</refmeta>
 
11
 
 
12
<refnamediv>
 
13
<refname>gdk-pixbuf-csource</refname>
 
14
<refpurpose>C code generation utility for GdkPixbuf images</refpurpose>
 
15
</refnamediv>
 
16
 
 
17
<refsynopsisdiv>
 
18
<cmdsynopsis>
 
19
<command>gdk-pixbuf-csource</command>
 
20
<arg choice="opt">options</arg>
 
21
<arg choice="opt">image</arg>
 
22
</cmdsynopsis>
 
23
<cmdsynopsis>
 
24
<command>gdk-pixbuf-csource</command>
 
25
<arg choice="opt">options</arg>
 
26
<arg choice="plain">--build-list</arg>
 
27
<arg rep="repeat">
 
28
  <arg>name</arg>
 
29
  <arg>image</arg>
 
30
</arg>
 
31
</cmdsynopsis>
 
32
</refsynopsisdiv>
 
33
 
 
34
<refsect1><title>Description</title>
 
35
<para>
 
36
<command>gdk-pixbuf-csource</command> is a small utility that generates
 
37
C code containing images, useful for compiling images directly into programs.
 
38
</para>
 
39
</refsect1>
 
40
 
 
41
<refsect1><title>Invocation</title>
 
42
<para>
 
43
<command>gdk-pixbuf-csource</command> either takes as input one image file
 
44
name to generate code for, or, using the <option>--build-list</option> option,
 
45
a list of (<replaceable>name</replaceable>, <replaceable>image</replaceable>)
 
46
pairs to generate code for a list of images into named variables.
 
47
</para>
 
48
<refsect2><title>Options</title>
 
49
<variablelist>
 
50
 
 
51
<varlistentry>
 
52
<term><option>--stream</option></term>
 
53
<listitem><para>
 
54
Generate pixbuf data stream (a single string containing a serialized
 
55
<structname>GdkPixdata</structname> structure in network byte order).
 
56
</para></listitem>
 
57
</varlistentry>
 
58
 
 
59
<varlistentry>
 
60
<term><option>--struct</option></term>
 
61
<listitem><para>
 
62
Generate GdkPixdata structure (needs the <structname>GdkPixdata</structname>
 
63
structure definition from <filename>gdk-pixdata.h</filename>).
 
64
</para></listitem>
 
65
</varlistentry>
 
66
 
 
67
<varlistentry>
 
68
<term><option>--macros</option></term>
 
69
<listitem><para>
 
70
Generate *_ROWSTRIDE, *_WIDTH, *_HEIGHT, *_BYTES_PER_PIXEL and
 
71
*_RLE_PIXEL_DATA or *_PIXEL_DATA macro definitions for the image.
 
72
</para></listitem>
 
73
</varlistentry>
 
74
 
 
75
<varlistentry>
 
76
<term><option>--rle</option></term>
 
77
<listitem><para>
 
78
Enables run-length encoding for the generated pixel data (default).
 
79
</para></listitem>
 
80
</varlistentry>
 
81
 
 
82
<varlistentry>
 
83
<term><option>--raw</option></term>
 
84
<listitem><para>
 
85
Disables run-length encoding for the generated pixel data.
 
86
</para></listitem>
 
87
</varlistentry>
 
88
 
 
89
<varlistentry>
 
90
<term><option>--extern</option></term>
 
91
<listitem><para>
 
92
Generate extern symbols.
 
93
</para></listitem>
 
94
</varlistentry>
 
95
 
 
96
<varlistentry>
 
97
<term><option>--static</option></term>
 
98
<listitem><para>
 
99
Generate static symbols (default).
 
100
</para></listitem>
 
101
</varlistentry>
 
102
 
 
103
<varlistentry>
 
104
<term><option>--decoder</option></term>
 
105
<listitem><para>
 
106
Provide a *_RUN_LENGTH_DECODE(image_buf, rle_data, size, bpp) macro definition
 
107
to decode run-length encoded image data.
 
108
</para></listitem>
 
109
</varlistentry>
 
110
 
 
111
<varlistentry>
 
112
<term><option>--name=identifier</option></term>
 
113
<listitem><para>
 
114
Specifies the identifier name (prefix) for the generated variables or
 
115
macros (useful only if <option>--build-list</option> was not specified).
 
116
</para></listitem>
 
117
</varlistentry>
 
118
 
 
119
<varlistentry>
 
120
<term><option>--build-list</option></term>
 
121
<listitem><para>
 
122
Enables (<replaceable>name</replaceable>, <replaceable>image</replaceable>)
 
123
pair parsing mode.
 
124
</para></listitem>
 
125
</varlistentry>
 
126
 
 
127
<varlistentry>
 
128
<term><option>-h</option>, <option>--help</option></term>
 
129
<listitem><para>
 
130
Print brief help and exit.
 
131
</para></listitem>
 
132
</varlistentry>
 
133
 
 
134
<varlistentry>
 
135
<term><option>-v</option>, <option>--version</option></term>
 
136
<listitem><para>
 
137
Print version and exit.
 
138
</para></listitem>
 
139
</varlistentry>
 
140
 
 
141
<varlistentry>
 
142
<term><option>--g-fatal-warnings</option></term>
 
143
<listitem><para>
 
144
Make warnings fatal (causes the program to abort).
 
145
</para></listitem>
 
146
</varlistentry>
 
147
 
 
148
</variablelist>
 
149
</refsect2>
 
150
</refsect1>
 
151
 
 
152
<refsect1><title>See also</title>
 
153
<para>
 
154
The <structname>GdkPixbuf</structname> documentation, shipped with the
 
155
Gtk+ distribution, available from <ulink url="http://www.gtk.org">www.gtk.org</ulink>.
 
156
</para>
 
157
</refsect1>
 
158
 
 
159
<refsect1><title>Bugs</title>
 
160
<para>
 
161
The runlength encoder gets out of sync with the pixel boundaries, since
 
162
it includes the rowstride padding in the encoded stream. Furthermore, it
 
163
generates pixbufs with suboptimal rowstride in some cases.
 
164
</para>
 
165
</refsect1>
 
166
 
 
167
<refsect1><title>Author</title>
 
168
<para>
 
169
<command>gdk-pixbuf-csource</command> was written by Tim Janik
 
170
<email>timj@gtk.org</email>.
 
171
</para>
 
172
<para>
 
173
This manual page was provided by Tim Janik <email>timj@gtk.org</email>.
 
174
</para>
 
175
</refsect1>
 
176
</refentry>
 
177