File: //usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-csource.html
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gdk-pixbuf-csource</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
<link rel="start" href="index.html" title="The gdk-pixbuf Library">
<link rel="up" href="rn02.html" title="Tools Reference">
<link rel="prev" href="rn02.html" title="Tools Reference">
<link rel="next" href="gdk-pixbuf-query-loaders.html" title="gdk-pixbuf-query-loaders">
<meta name="generator" content="GTK-Doc V1.6 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="reference" href="rn01.html" title="API Reference">
<link rel="reference" href="rn02.html" title="Tools Reference">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of deprecated symbols">
<link rel="index" href="ix03.html" title="Index of new symbols in 2.2">
<link rel="index" href="ix04.html" title="Index of new symbols in 2.4">
<link rel="index" href="ix05.html" title="Index of new symbols in 2.6">
<link rel="index" href="ix06.html" title="Index of new symbols in 2.8">
<link rel="appendix" href="apa.html" title="Appendix A. Porting applications from Imlib to gdk-pixbuf">
<link rel="appendix" href="license.html" title="Appendix B. License">
</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="rn02.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="rn02.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">The <span class="application">gdk-pixbuf</span> Library</th>
<td><a accesskey="n" href="gdk-pixbuf-query-loaders.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry" lang="en">
<a name="gdk-pixbuf-csource"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle">gdk-pixbuf-csource</span></h2>
<p>gdk-pixbuf-csource — C code generation utility for GdkPixbuf images</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<div class="cmdsynopsis"><p><code class="command">gdk-pixbuf-csource</code> [options] [image]</p></div>
<div class="cmdsynopsis"><p><code class="command">gdk-pixbuf-csource</code> [options] --build-list [
[name]
[image]
...]</p></div>
</div>
<div class="refsect1" lang="en">
<a name="id3149782"></a><h2>Description</h2>
<p>
<span><strong class="command">gdk-pixbuf-csource</strong></span> is a small utility that generates C code
containing images, useful for compiling images directly into programs.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id3149798"></a><h2>Invocation</h2>
<p>
<span><strong class="command">gdk-pixbuf-csource</strong></span> either takes as input one image file name
to generate code for, or, using the <code class="option">--build-list</code> option, a
list of (<em class="replaceable"><code>name</code></em>, <em class="replaceable"><code>image</code></em>)
pairs to generate code for a list of images into named variables.
</p>
<div class="refsect2" lang="en">
<a name="id3149825"></a><h3>Options</h3>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><code class="option">--stream</code></span></td>
<td><p>
Generate pixbuf data stream (a single string containing a serialized
<span class="structname">GdkPixdata</span> structure in network byte order).
</p></td>
</tr>
<tr>
<td>
<span class="term"><code class="option">--struct</code></span></td>
<td><p>
Generate GdkPixdata structure (needs the <span class="structname">GdkPixdata</span>
structure definition from <code class="filename">gdk-pixdata.h</code>).
</p></td>
</tr>
<tr>
<td>
<span class="term"><code class="option">--macros</code></span></td>
<td><p>
Generate *_ROWSTRIDE, *_WIDTH, *_HEIGHT, *_BYTES_PER_PIXEL and
*_RLE_PIXEL_DATA or *_PIXEL_DATA macro definitions for the image.
</p></td>
</tr>
<tr>
<td>
<span class="term"><code class="option">--rle</code></span></td>
<td><p>
Enables run-length encoding for the generated pixel data (default).
</p></td>
</tr>
<tr>
<td>
<span class="term"><code class="option">--raw</code></span></td>
<td><p>
Disables run-length encoding for the generated pixel data.
</p></td>
</tr>
<tr>
<td>
<span class="term"><code class="option">--extern</code></span></td>
<td><p>
Generate extern symbols.
</p></td>
</tr>
<tr>
<td>
<span class="term"><code class="option">--static</code></span></td>
<td><p>
Generate static symbols (default).
</p></td>
</tr>
<tr>
<td>
<span class="term"><code class="option">--decoder</code></span></td>
<td><p>
Provide a *_RUN_LENGTH_DECODE(image_buf, rle_data, size, bpp) macro definition
to decode run-length encoded image data.
</p></td>
</tr>
<tr>
<td>
<span class="term"><code class="option">--name=identifier</code></span></td>
<td><p>
Specifies the identifier name (prefix) for the generated variables or
macros (useful only if <code class="option">--build-list</code> was not specified).
</p></td>
</tr>
<tr>
<td>
<span class="term"><code class="option">--build-list</code></span></td>
<td><p>
Enables (<em class="replaceable"><code>name</code></em>, <em class="replaceable"><code>image</code></em>)
pair parsing mode.
</p></td>
</tr>
<tr>
<td>
<span class="term"><code class="option">-h</code>, <code class="option">--help</code></span></td>
<td><p>
Print brief help and exit.
</p></td>
</tr>
<tr>
<td>
<span class="term"><code class="option">-v</code>, <code class="option">--version</code></span></td>
<td><p>
Print version and exit.
</p></td>
</tr>
<tr>
<td>
<span class="term"><code class="option">--g-fatal-warnings</code></span></td>
<td><p>
Make warnings fatal (causes the program to abort).
</p></td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id3150038"></a><h2>See also</h2>
<p>
The <span class="structname">GdkPixbuf</span> documentation, shipped with the
Gtk+ distribution, available from <a href="http://www.gtk.org" target="_top">www.gtk.org</a>.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id3150058"></a><h2>Bugs</h2>
<p>
The runlength encoder gets out of sync with the pixel boundaries, since
it includes the rowstride padding in the encoded stream. Furthermore, it
generates pixbufs with suboptimal rowstride in some cases.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id3150070"></a><h2>Author</h2>
<p>
<span><strong class="command">gdk-pixbuf-csource</strong></span> was written by Tim Janik
<code class="email"><<a href="mailto:timj@gtk.org">timj@gtk.org</a>></code>.
</p>
<p>
This manual page was provided by Tim Janik <code class="email"><<a href="mailto:timj@gtk.org">timj@gtk.org</a>></code>.
</p>
</div>
</div>
</body>
</html>