summaryrefslogtreecommitdiffstats
path: root/doc/html/qimageformat.html
blob: 760d07bff897ce0a01fbe90fdfb5e31de495fa7b (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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/src/kernel/qasyncimageio.cpp:530 -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>QImageFormat Class</title>
<style type="text/css"><!--
fn { margin-left: 1cm; text-indent: -1cm; }
a:link { color: #004faf; text-decoration: none }
a:visited { color: #672967; text-decoration: none }
body { background: #ffffff; color: black; }
--></style>
</head>
<body>

<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr bgcolor="#E5E5E5">
<td valign=center>
 <a href="index.html">
<font color="#004faf">Home</font></a>
 | <a href="classes.html">
<font color="#004faf">All&nbsp;Classes</font></a>
 | <a href="mainclasses.html">
<font color="#004faf">Main&nbsp;Classes</font></a>
 | <a href="annotated.html">
<font color="#004faf">Annotated</font></a>
 | <a href="groups.html">
<font color="#004faf">Grouped&nbsp;Classes</font></a>
 | <a href="functions.html">
<font color="#004faf">Functions</font></a>
</td>
<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>QImageFormat Class Reference</h1>

<p>The QImageFormat class is an incremental image decoder for a specific image format.
<a href="#details">More...</a>
<p><tt>#include &lt;<a href="qasyncimageio-h.html">qasyncimageio.h</a>&gt;</tt>
<p><a href="qimageformat-members.html">List of all member functions.</a>
<h2>Public Members</h2>
<ul>
<li class=fn>virtual int <a href="#decode"><b>decode</b></a> ( QImage&nbsp;&amp;&nbsp;img, QImageConsumer&nbsp;*&nbsp;consumer, const&nbsp;uchar&nbsp;*&nbsp;buffer, int&nbsp;length ) = 0</li>
</ul>
<hr><a name="details"></a><h2>Detailed Description</h2>


The QImageFormat class is an incremental image decoder for a specific image format.
<p> 


<p> By making a derived class of <a href="qimageformattype.html">QImageFormatType</a>, 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 <a href="qmovie.html">QMovie</a> or for the first frame of the image
stream to be loaded as a <a href="qimage.html">QImage</a> or <a href="qpixmap.html">QPixmap</a>.
<p> Your new subclass must reimplement the <a href="#decode">decode</a>() function in order
to process your new format.
<p> New QImageFormat objects are generated by new QImageFormatType
factories.
<p>See also <a href="graphics.html">Graphics Classes</a>, <a href="images.html">Image Processing Classes</a>, and <a href="multimedia.html">Multimedia Classes</a>.

<hr><h2>Member Function Documentation</h2>
<h3 class=fn>int <a name="decode"></a>QImageFormat::decode ( <a href="qimage.html">QImage</a>&nbsp;&amp;&nbsp;img, <a href="qimageconsumer.html">QImageConsumer</a>&nbsp;*&nbsp;consumer, const&nbsp;uchar&nbsp;*&nbsp;buffer, int&nbsp;length )<tt> [pure virtual]</tt>
</h3>

<p> New subclasses must reimplement this method.
<p> It should decode some or all of the bytes from <em>buffer</em> into <em>img</em>, calling the methods of <em>consumer</em> as the decoding proceeds
to inform that consumer of changes to the image. The length of the
data is given in <em>length</em>. The consumer may be 0, in which case
the function should just process the data into <em>img</em> 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.
<p> The function should return without processing all the data if it
reaches the end of a frame in the input.
<p> The function must return the number of bytes it has processed.

<!-- eof -->
<hr><p>
This file is part of the <a href="index.html">Qt toolkit</a>.
Copyright &copy; 1995-2007
<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
<table width=100% cellspacing=0 border=0><tr>
<td>Copyright &copy; 2007
<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
<td align=right><div align=right>Qt 3.3.8</div>
</table></div></address></body>
</html>