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

   1 '\" t
   2 .\"     Title: gdk-pixbuf-csource
   3 .\"    Author: [see the "Author" section]
   4 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
   5 .\"      Date: 04/14/2012
   6 .\"    Manual: [FIXME: manual]
   7 .\"    Source: [FIXME: source]
   8 .\"  Language: English
   9 .\"
  10 .TH "GDK\-PIXBUF\-CSOURCE" "1" "04/14/2012" "[FIXME: source]" "[FIXME: manual]"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 gdk-pixbuf-csource \- C code generation utility for GdkPixbuf images
  32 .SH "SYNOPSIS"
  33 .HP \w'\fBgdk\-pixbuf\-csource\fR\ 'u
  34 \fBgdk\-pixbuf\-csource\fR [options] [image]
  35 .HP \w'\fBgdk\-pixbuf\-csource\fR\ 'u
  36 \fBgdk\-pixbuf\-csource\fR [options] \-\-build\-list [[name]\ [image]...]
  37 .SH "DESCRIPTION"
  38 .PP
  39
  40 \fBgdk\-pixbuf\-csource\fR
  41 is a small utility that generates C code containing images, useful for compiling images directly into programs\&.
  42 .SH "INVOCATION"
  43 .PP
  44
  45 \fBgdk\-pixbuf\-csource\fR
  46 either takes as input one image file name to generate code for, or, using the
  47 \fB\-\-build\-list\fR
  48 option, a list of (\fIname\fR,
  49 \fIimage\fR) pairs to generate code for a list of images into named variables\&.
  50 .SS "Options"
  51 .PP
  52 \fB\-\-stream\fR
  53 .RS 4
  54 Generate pixbuf data stream (a single string containing a serialized
  55 GdkPixdata
  56 structure in network byte order)\&.
  57 .RE
  58 .PP
  59 \fB\-\-struct\fR
  60 .RS 4
  61 Generate GdkPixdata structure (needs the
  62 GdkPixdata
  63 structure definition from
  64 gdk\-pixdata\&.h)\&.
  65 .RE
  66 .PP
  67 \fB\-\-macros\fR
  68 .RS 4
  69 Generate *_ROWSTRIDE, *_WIDTH, *_HEIGHT, *_BYTES_PER_PIXEL and *_RLE_PIXEL_DATA or *_PIXEL_DATA macro definitions for the image\&.
  70 .RE
  71 .PP
  72 \fB\-\-rle\fR
  73 .RS 4
  74 Enables run\-length encoding for the generated pixel data (default)\&.
  75 .RE
  76 .PP
  77 \fB\-\-raw\fR
  78 .RS 4
  79 Disables run\-length encoding for the generated pixel data\&.
  80 .RE
  81 .PP
  82 \fB\-\-extern\fR
  83 .RS 4
  84 Generate extern symbols\&.
  85 .RE
  86 .PP
  87 \fB\-\-static\fR
  88 .RS 4
  89 Generate static symbols (default)\&.
  90 .RE
  91 .PP
  92 \fB\-\-decoder\fR
  93 .RS 4
  94 Provide a *_RUN_LENGTH_DECODE(image_buf, rle_data, size, bpp) macro definition to decode run\-length encoded image data\&.
  95 .RE
  96 .PP
  97 \fB\-\-name=identifier\fR
  98 .RS 4
  99 Specifies the identifier name (prefix) for the generated variables or macros (useful only if
 100 \fB\-\-build\-list\fR
 101 was not specified)\&.
 102 .RE
 103 .PP
 104 \fB\-\-build\-list\fR
 105 .RS 4
 106 Enables (\fIname\fR,
 107 \fIimage\fR) pair parsing mode\&.
 108 .RE
 109 .PP
 110 \fB\-h\fR, \fB\-\-help\fR
 111 .RS 4
 112 Print brief help and exit\&.
 113 .RE
 114 .PP
 115 \fB\-v\fR, \fB\-\-version\fR
 116 .RS 4
 117 Print version and exit\&.
 118 .RE
 119 .PP
 120 \fB\-\-g\-fatal\-warnings\fR
 121 .RS 4
 122 Make warnings fatal (causes the program to abort)\&.
 123 .RE
 124 .SH "SEE ALSO"
 125 .PP
 126 The
 127 GdkPixbuf
 128 documentation, shipped with the Gtk+ distribution, available from
 129 \m[blue]\fBwww\&.gtk\&.org\fR\m[]\&\s-2\u[1]\d\s+2\&.
 130 .SH "BUGS"
 131 .PP
 132 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\&.
 133 .SH "AUTHOR"
 134 .PP
 135
 136 \fBgdk\-pixbuf\-csource\fR
 137 was written by Tim Janik
 138 timj@gtk\&.org\&.
 139 .PP
 140 This manual page was provided by Tim Janik
 141 timj@gtk\&.org\&.
 142 .SH "NOTES"
 143 .IP " 1." 4
 144 www.gtk.org
 145 .RS 4
 146 \%http://www.gtk.org
 147 .RE