diff options
Diffstat (limited to 'doc/man/man3/tqimageformat.3qt')
| -rw-r--r-- | doc/man/man3/tqimageformat.3qt | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/doc/man/man3/tqimageformat.3qt b/doc/man/man3/tqimageformat.3qt new file mode 100644 index 000000000..9590ac32f --- /dev/null +++ b/doc/man/man3/tqimageformat.3qt @@ -0,0 +1,63 @@ +'\" t +.TH QImageFormat 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 +QImageFormat \- Incremental image decoder for a specific image format +.SH SYNOPSIS +\fC#include <ntqasyncimageio.h>\fR +.PP +.SS "Public Members" +.in +1c +.ti -1c +.BI "virtual int \fBdecode\fR ( QImage & img, QImageConsumer * consumer, const uchar * buffer, int length ) = 0" +.br +.in -1c +.SH DESCRIPTION +The QImageFormat class is an incremental image decoder for a specific image format. +.PP +By making a derived class of QImageFormatType, which in turn creates objects that are a subclass of QImageFormat, you can add support for more incremental image formats, allowing such formats to be sources for a QMovie or for the first frame of the image stream to be loaded as a QImage or QPixmap. +.PP +Your new subclass must reimplement the decode() function in order to process your new format. +.PP +New QImageFormat objects are generated by new QImageFormatType factories. +.PP +See also Graphics Classes, Image Processing Classes, and Multimedia Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "int QImageFormat::decode ( QImage & img, QImageConsumer * consumer, const uchar * buffer, int length )\fC [pure virtual]\fR" +New subclasses must reimplement this method. +.PP +It should decode some or all of the bytes from \fIbuffer\fR into \fIimg\fR, calling the methods of \fIconsumer\fR as the decoding proceeds to inform that consumer of changes to the image. The length of the data is given in \fIlength\fR. The consumer may be 0, in which case the function should just process the data into \fIimg\fR without telling any consumer about the changes. Note that the decoder must store enough state to be able to continue in subsequent calls to this method - this is the essence of the incremental image loading. +.PP +The function should return without processing all the data if it reaches the end of a frame in the input. +.PP +The function must return the number of bytes it has processed. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qimageformat.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 Qt documentation is provided in HTML format; it is +located at $QTDIR/doc/html and can be read using Qt 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 (tqimageformat.3qt) and the Qt +version (3.3.8). |