summaryrefslogtreecommitdiffstats
path: root/doc/man/man3/tqpngimagepacker.3qt
blob: b8452a86ca90d916fcdab78b36d865489a443e15 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
'\" t
.TH QPNGImagePacker 3qt "2 February 2007" "Trolltech AS" \" -*- nroff -*-
.\" Copyright 1992-2007 Trolltech ASA.  All rights reserved.  See the
.\" license file included in the distribution for a complete license
.\" statement.
.\"
.ad l
.nh
.SH NAME
QPNGImagePacker \- Creates well-compressed PNG animations
.SH SYNOPSIS
\fC#include <ntqpngio.h>\fR
.PP
.SS "Public Members"
.in +1c
.ti -1c
.BI "\fBQPNGImagePacker\fR ( QIODevice * iod, int storage_depth, int conversionflags )"
.br
.ti -1c
.BI "void \fBsetPixelAlignment\fR ( int x )"
.br
.ti -1c
.BI "bool \fBpackImage\fR ( const QImage & img )"
.br
.in -1c
.SH DESCRIPTION
The QPNGImagePacker class creates well-compressed PNG animations.
.PP
By using transparency, QPNGImagePacker allows you to build a PNG image from a sequence of QImages.
.PP
Images are added using packImage().
.PP
See also Graphics Classes and Image Processing Classes.
.SH MEMBER FUNCTION DOCUMENTATION
.SH "QPNGImagePacker::QPNGImagePacker ( QIODevice * iod, int storage_depth, int conversionflags )"
Creates an image packer that writes PNG data to IO device \fIiod\fR using a \fIstorage_depth\fR bit encoding (use 8 or 32, depending on the desired quality and compression requirements).
.PP
If the image needs to be modified to fit in a lower-resolution result (e.g. converting from 32-bit to 8-bit), use the \fIconversionflags\fR to specify how you'd prefer this to happen.
.PP
See also Qt::ImageConversionFlags.
.SH "bool QPNGImagePacker::packImage ( const QImage & img )"
Adds the image \fIimg\fR to the PNG animation, analyzing the differences between this and the previous image to improve compression.
.SH "void QPNGImagePacker::setPixelAlignment ( int x )"
Aligns pixel differences to \fIx\fR pixels. For example, using 8 can
improve playback on certain hardware. Normally the default of
1-pixel alignment (i.e. no alignment) gives better compression and
performance.

.SH "SEE ALSO"
.BR http://doc.trolltech.com/qpngimagepacker.html
.BR http://www.trolltech.com/faq/tech.html
.SH COPYRIGHT
Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com.  See the
license file included in the distribution for a complete license
statement.
.SH AUTHOR
Generated automatically from the source code.
.SH BUGS
If you find a bug in Qt, please report it as described in
.BR http://doc.trolltech.com/bughowto.html .
Good bug reports help us to help you. Thank you.
.P
The definitive TQt documentation is provided in HTML format; it is
located at $QTDIR/doc/html and can be read using TQt Assistant or with
a web browser. This man page is provided as a convenience for those
users who prefer man pages, although this format is not officially
supported by Trolltech. 
.P
If you find errors in this manual page, please report them to
.BR qt-bugs@trolltech.com .
Please include the name of the manual page (tqpngimagepacker.3qt) and the Qt
version (3.3.8).