Blame docs/reference/gdk-pixbuf/gdk-pixbuf-csource.1

Packit a4058c
'\" t
Packit a4058c
.\"     Title: gdk-pixbuf-csource
Packit a4058c
.\"    Author: Tim Janik
Packit a4058c
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
Packit a4058c
.\"      Date: 10/02/2017
Packit a4058c
.\"    Manual: User Commands
Packit a4058c
.\"    Source: gdk-pixbuf
Packit a4058c
.\"  Language: English
Packit a4058c
.\"
Packit a4058c
.TH "GDK\-PIXBUF\-CSOURCE" "1" "" "gdk-pixbuf" "User Commands"
Packit a4058c
.\" -----------------------------------------------------------------
Packit a4058c
.\" * Define some portability stuff
Packit a4058c
.\" -----------------------------------------------------------------
Packit a4058c
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Packit a4058c
.\" http://bugs.debian.org/507673
Packit a4058c
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
Packit a4058c
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Packit a4058c
.ie \n(.g .ds Aq \(aq
Packit a4058c
.el       .ds Aq '
Packit a4058c
.\" -----------------------------------------------------------------
Packit a4058c
.\" * set default formatting
Packit a4058c
.\" -----------------------------------------------------------------
Packit a4058c
.\" disable hyphenation
Packit a4058c
.nh
Packit a4058c
.\" disable justification (adjust text to left margin only)
Packit a4058c
.ad l
Packit a4058c
.\" -----------------------------------------------------------------
Packit a4058c
.\" * MAIN CONTENT STARTS HERE *
Packit a4058c
.\" -----------------------------------------------------------------
Packit a4058c
.SH "NAME"
Packit a4058c
gdk-pixbuf-csource \- C code generation utility for GdkPixbuf images
Packit a4058c
.SH "SYNOPSIS"
Packit a4058c
.HP \w'\fBgdk\-pixbuf\-csource\fR\ 'u
Packit a4058c
\fBgdk\-pixbuf\-csource\fR [OPTION...] [IMAGE]
Packit a4058c
.HP \w'\fBgdk\-pixbuf\-csource\fR\ 'u
Packit a4058c
\fBgdk\-pixbuf\-csource\fR [OPTION...] \-\-build\-list [[NAME]\ [IMAGE]...]
Packit a4058c
.SH "DESCRIPTION"
Packit a4058c
.PP
Packit a4058c
\fBgdk\-pixbuf\-csource\fR
Packit a4058c
is a small utility that generates C code containing images, useful for compiling images directly into programs\&.
Packit a4058c
.PP
Packit a4058c
\fBgdk\-pixbuf\-csource\fR
Packit a4058c
either takes as input one image file name to generate code for, or, using the
Packit a4058c
\fB\-\-build\-list\fR
Packit a4058c
option, a list of (\fIname\fR,
Packit a4058c
\fIimage\fR) pairs to generate code for a list of images into named variables\&.
Packit a4058c
.SH "OPTIONS"
Packit a4058c
.PP
Packit a4058c
\fB\-\-stream\fR
Packit a4058c
.RS 4
Packit a4058c
Generate pixbuf data stream (a single string containing a serialized
Packit a4058c
GdkPixdata
Packit a4058c
structure in network byte order)\&.
Packit a4058c
.RE
Packit a4058c
.PP
Packit a4058c
\fB\-\-struct\fR
Packit a4058c
.RS 4
Packit a4058c
Generate GdkPixdata structure (needs the
Packit a4058c
GdkPixdata
Packit a4058c
structure definition from
Packit a4058c
gdk\-pixdata\&.h)\&.
Packit a4058c
.RE
Packit a4058c
.PP
Packit a4058c
\fB\-\-macros\fR
Packit a4058c
.RS 4
Packit a4058c
Generate *_ROWSTRIDE, *_WIDTH, *_HEIGHT, *_BYTES_PER_PIXEL and *_RLE_PIXEL_DATA or *_PIXEL_DATA macro definitions for the image\&.
Packit a4058c
.RE
Packit a4058c
.PP
Packit a4058c
\fB\-\-rle\fR
Packit a4058c
.RS 4
Packit a4058c
Enables run\-length encoding for the generated pixel data (default)\&.
Packit a4058c
.RE
Packit a4058c
.PP
Packit a4058c
\fB\-\-raw\fR
Packit a4058c
.RS 4
Packit a4058c
Disables run\-length encoding for the generated pixel data\&.
Packit a4058c
.RE
Packit a4058c
.PP
Packit a4058c
\fB\-\-extern\fR
Packit a4058c
.RS 4
Packit a4058c
Generate extern symbols\&.
Packit a4058c
.RE
Packit a4058c
.PP
Packit a4058c
\fB\-\-static\fR
Packit a4058c
.RS 4
Packit a4058c
Generate static symbols (default)\&.
Packit a4058c
.RE
Packit a4058c
.PP
Packit a4058c
\fB\-\-decoder\fR
Packit a4058c
.RS 4
Packit a4058c
Provide a *_RUN_LENGTH_DECODE(image_buf, rle_data, size, bpp) macro definition to decode run\-length encoded image data\&.
Packit a4058c
.RE
Packit a4058c
.PP
Packit a4058c
\fB\-\-name=identifier\fR
Packit a4058c
.RS 4
Packit a4058c
Specifies the identifier name (prefix) for the generated variables or macros (useful only if
Packit a4058c
\fB\-\-build\-list\fR
Packit a4058c
was not specified)\&.
Packit a4058c
.RE
Packit a4058c
.PP
Packit a4058c
\fB\-\-build\-list\fR
Packit a4058c
.RS 4
Packit a4058c
Enables (\fIname\fR,
Packit a4058c
\fIimage\fR) pair parsing mode\&.
Packit a4058c
.RE
Packit a4058c
.PP
Packit a4058c
\fB\-h\fR, \fB\-\-help\fR
Packit a4058c
.RS 4
Packit a4058c
Print brief help and exit\&.
Packit a4058c
.RE
Packit a4058c
.PP
Packit a4058c
\fB\-v\fR, \fB\-\-version\fR
Packit a4058c
.RS 4
Packit a4058c
Print version and exit\&.
Packit a4058c
.RE
Packit a4058c
.PP
Packit a4058c
\fB\-\-g\-fatal\-warnings\fR
Packit a4058c
.RS 4
Packit a4058c
Make warnings fatal (causes the program to abort)\&.
Packit a4058c
.RE
Packit a4058c
.SH "SEE ALSO"
Packit a4058c
.PP
Packit a4058c
The
Packit a4058c
GdkPixbuf
Packit a4058c
documentation, shipped with the Gtk+ distribution, available from
Packit a4058c
\m[blue]\fBwww\&.gtk\&.org\fR\m[]\&\s-2\u[1]\d\s+2\&.
Packit a4058c
.SH "BUGS"
Packit a4058c
.PP
Packit a4058c
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\&.
Packit a4058c
.SH "NOTES"
Packit a4058c
.IP " 1." 4
Packit a4058c
www.gtk.org
Packit a4058c
.RS 4
Packit a4058c
\%http://www.gtk.org
Packit a4058c
.RE