]> Pileus Git - ~andy/gtk/blob - docs/reference/gdk-pixbuf/gdk-pixbuf-csource.1
a98fde75e774ccb5e335eb05085b8190d14f2d23
[~andy/gtk] / docs / reference / gdk-pixbuf / gdk-pixbuf-csource.1
1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
2 .de Sh \" Subsection
3 .br
4 .if t .Sp
5 .ne 5
6 .PP
7 \fB\\$1\fR
8 .PP
9 ..
10 .de Sp \" Vertical space (when we can't use .PP)
11 .if t .sp .5v
12 .if n .sp
13 ..
14 .de Ip \" List item
15 .br
16 .ie \\n(.$>=3 .ne \\$3
17 .el .ne 3
18 .IP "\\$1" \\$2
19 ..
20 .TH "GDK-PIXBUF-CSOURCE" 1 "" "" ""
21 .SH NAME
22 gdk-pixbuf-csource \- C code generation utility for GdkPixbuf images
23 .SH "SYNOPSIS"
24 .ad l
25 .hy 0
26 .HP 19
27 \fBgdk\-pixbuf\-csource\fR [options] [image]
28 .ad
29 .hy
30 .ad l
31 .hy 0
32 .HP 19
33 \fBgdk\-pixbuf\-csource\fR [options] \-\-build\-list [[name]\ [image]...]
34 .ad
35 .hy
36
37 .SH "DESCRIPTION"
38
39 .PP
40  \fBgdk\-pixbuf\-csource\fR is a small utility that generates C code containing images, useful for compiling images directly into programs\&.
41
42 .SH "INVOCATION"
43
44 .PP
45  \fBgdk\-pixbuf\-csource\fR either takes as input one image file name to generate code for, or, using the \fB\-\-build\-list\fR option, a list of (\fIname\fR, \fIimage\fR) pairs to generate code for a list of images into named variables\&.
46
47 .SS "Options"
48
49 .TP
50 \fB\-\-stream\fR
51 Generate pixbuf data stream (a single string containing a serialized GdkPixdata structure in network byte order)\&.
52
53 .TP
54 \fB\-\-struct\fR
55 Generate GdkPixdata structure (needs the GdkPixdata structure definition from \fIgdk\-pixdata\&.h\fR)\&.
56
57 .TP
58 \fB\-\-macros\fR
59 Generate *_ROWSTRIDE, *_WIDTH, *_HEIGHT, *_BYTES_PER_PIXEL and *_RLE_PIXEL_DATA or *_PIXEL_DATA macro definitions for the image\&.
60
61 .TP
62 \fB\-\-rle\fR
63 Enables run\-length encoding for the generated pixel data (default)\&.
64
65 .TP
66 \fB\-\-raw\fR
67 Disables run\-length encoding for the generated pixel data\&.
68
69 .TP
70 \fB\-\-extern\fR
71 Generate extern symbols\&.
72
73 .TP
74 \fB\-\-static\fR
75 Generate static symbols (default)\&.
76
77 .TP
78 \fB\-\-decoder\fR
79 Provide a *_RUN_LENGTH_DECODE(image_buf, rle_data, size, bpp) macro definition to decode run\-length encoded image data\&.
80
81 .TP
82 \fB\-\-name=identifier\fR
83 Specifies the identifier name (prefix) for the generated variables or macros (useful only if \fB\-\-build\-list\fR was not specified)\&.
84
85 .TP
86 \fB\-\-build\-list\fR
87 Enables (\fIname\fR, \fIimage\fR) pair parsing mode\&.
88
89 .TP
90 \fB\-h\fR, \fB\-\-help\fR
91 Print brief help and exit\&.
92
93 .TP
94 \fB\-v\fR, \fB\-\-version\fR
95 Print version and exit\&.
96
97 .TP
98 \fB\-\-g\-fatal\-warnings\fR
99 Make warnings fatal (causes the program to abort)\&.
100
101 .SH "SEE ALSO"
102
103 .PP
104 The GdkPixbuf documentation, shipped with the Gtk+ distribution, available from www\&.gtk\&.org: \fIhttp://www.gtk.org\fR\&.
105
106 .SH "BUGS"
107
108 .PP
109 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\&.
110
111 .SH "AUTHOR"
112
113 .PP
114  \fBgdk\-pixbuf\-csource\fR was written by Tim Janik <timj@gtk\&.org>\&.
115
116 .PP
117 This manual page was provided by Tim Janik <timj@gtk\&.org>\&.
118