source: OGRE/trunk/ogrenew/Docs/api/html/classOgre_1_1ImageCodec.html @ 692

Revision 692, 30.3 KB checked in by mattausch, 19 years ago (diff)

adding ogre 1.2 and dependencies
Line 
1<html>
2<head>
3<title>Ogre::ImageCodec class Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
4<link type="text/css" rel="stylesheet" href="style.css">
5</head>
6
7<body>
8<!-- Generated by Doxygen 1.3.6 -->
9<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
10<h1>Ogre::ImageCodec Class Reference</h1><a class="el" href="classOgre_1_1Codec.html">Codec</a> specialized in images. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreImageCodec_8h-source.html">OgreImageCodec.h</a>&gt;</code>
14<p>
15<p>Inheritance diagram for Ogre::ImageCodec:
16<p><center><img src="classOgre_1_1ImageCodec.png" usemap="#Ogre::ImageCodec_map" border="0" alt=""></center>
17<map name="Ogre::ImageCodec_map">
18<area href="classOgre_1_1Codec.html" alt="Ogre::Codec" shape="rect" coords="68,0,195,24">
19<area href="classOgre_1_1EXRCodec.html" alt="Ogre::EXRCodec" shape="rect" coords="0,112,127,136">
20<area href="classOgre_1_1ILImageCodec.html" alt="Ogre::ILImageCodec" shape="rect" coords="137,112,264,136">
21</map>
22<a href="classOgre_1_1ImageCodec-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
23<tr><td></td></tr>
24<tr><td colspan=2><br><h2>Public Types</h2></td></tr>
25<tr><td class="memItemLeft" nowrap align=right valign=top>typedef <a class="el" href="classOgre_1_1SharedPtr.html">SharedPtr</a>&lt; CodecData &gt;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodecw0">CodecDataPtr</a></td></tr>
26
27<tr><td class="memItemLeft" nowrap align=right valign=top>typedef <a class="el" href="classOgre_1_1ConstMapIterator.html">ConstMapIterator</a>&lt;<br>
28 <a class="el" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodecx0">CodecList</a> &gt;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodecw1">CodecIterator</a></td></tr>
29
30<tr><td class="memItemLeft" nowrap align=right valign=top>typedef std::pair&lt; <a class="el" href="classOgre_1_1SharedPtr.html">MemoryDataStreamPtr</a>,<br>
31 <a class="el" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodecw0">CodecDataPtr</a> &gt;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodecw2">DecodeResult</a></td></tr>
32
33<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Result of a decoding; both a decoded data stream and <a class="el" href="classOgre_1_1Codec_1_1CodecData.html">CodecData</a> metadata.  <a href="#Ogre_1_1ImageCodecw2"></a><br><br></td></tr>
34<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
35<tr><td class="memItemLeft" nowrap align=right valign=top>virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ImageCodec.html#Ogre_1_1ImageCodeca0">~ImageCodec</a> ()</td></tr>
36
37<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a471">String</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ImageCodec.html#Ogre_1_1ImageCodeca1">getDataType</a> () const </td></tr>
38
39<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the type of the data that supported by this codec as a String.  <a href="#Ogre_1_1ImageCodeca1"></a><br><br></td></tr>
40<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="classOgre_1_1SharedPtr.html">DataStreamPtr</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodeca2">code</a> (<a class="el" href="classOgre_1_1SharedPtr.html">MemoryDataStreamPtr</a> &amp;input, <a class="el" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodecw0">CodecDataPtr</a> &amp;pData) const=0</td></tr>
41
42<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Codes the data in the input stream and saves the result in the output stream.  <a href="#Ogre_1_1ImageCodeca2"></a><br><br></td></tr>
43<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodeca3">codeToFile</a> (<a class="el" href="classOgre_1_1SharedPtr.html">MemoryDataStreamPtr</a> &amp;input, const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;outFileName, <a class="el" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodecw0">CodecDataPtr</a> &amp;pData) const=0</td></tr>
44
45<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Codes the data in the input chunk and saves the result in the output filename provided.  <a href="#Ogre_1_1ImageCodeca3"></a><br><br></td></tr>
46<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodecw2">DecodeResult</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodeca4">decode</a> (<a class="el" href="classOgre_1_1SharedPtr.html">DataStreamPtr</a> &amp;input) const=0</td></tr>
47
48<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Codes the data from the input chunk into the output chunk.  <a href="#Ogre_1_1ImageCodeca4"></a><br><br></td></tr>
49<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="namespaceOgre.html#a471">String</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodeca5">getType</a> () const=0</td></tr>
50
51<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the type of the codec as a String.  <a href="#Ogre_1_1ImageCodeca5"></a><br><br></td></tr>
52<tr><td colspan=2><br><h2>Static Public Member Functions</h2></td></tr>
53<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodece0">registerCodec</a> (<a class="el" href="classOgre_1_1Codec.html">Codec</a> *pCodec)</td></tr>
54
55<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Registers a new codec in the database.  <a href="#Ogre_1_1ImageCodece0"></a><br><br></td></tr>
56<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodece1">unRegisterCodec</a> (<a class="el" href="classOgre_1_1Codec.html">Codec</a> *pCodec)</td></tr>
57
58<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Unregisters a codec from the database.  <a href="#Ogre_1_1ImageCodece1"></a><br><br></td></tr>
59<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodecw1">CodecIterator</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodece2">getCodecIterator</a> (void)</td></tr>
60
61<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the iterator for the registered codecs.  <a href="#Ogre_1_1ImageCodece2"></a><br><br></td></tr>
62<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a580">StringVector</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodece3">getExtensions</a> (void)</td></tr>
63
64<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the file extension list for the registered codecs.  <a href="#Ogre_1_1ImageCodece3"></a><br><br></td></tr>
65<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1Codec.html">Codec</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodece4">getCodec</a> (const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;extension)</td></tr>
66
67<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the codec registered for the passed in file extension.  <a href="#Ogre_1_1ImageCodece4"></a><br><br></td></tr>
68<tr><td colspan=2><br><h2>Protected Types</h2></td></tr>
69<tr><td class="memItemLeft" nowrap align=right valign=top>typedef std::map&lt; <a class="el" href="namespaceOgre.html#a471">String</a>,<br>
70 <a class="el" href="classOgre_1_1Codec.html">Codec</a> * &gt;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodecx0">CodecList</a></td></tr>
71
72<tr><td colspan=2><br><h2>Static Protected Attributes</h2></td></tr>
73<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodecx0">CodecList</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodect0">ms_mapCodecs</a></td></tr>
74
75<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A map that contains all the registered codecs.  <a href="#Ogre_1_1ImageCodect0"></a><br><br></td></tr>
76</table>
77<hr><a name="_details"></a><h2>Detailed Description</h2>
78<a class="el" href="classOgre_1_1Codec.html">Codec</a> specialized in images.
79<p>
80<dl compact><dt><b>Remarks:</b></dt><dd>The users implementing subclasses of <a class="el" href="classOgre_1_1ImageCodec.html">ImageCodec</a> are required to return a valid pointer to a <a class="el" href="classOgre_1_1ImageCodec_1_1ImageData.html">ImageData</a> class from the decode(...) function. </dd></dl>
81
82<p>
83
84<p>
85Definition at line <a class="el" href="OgreImageCodec_8h-source.html#l00038">38</a> of file <a class="el" href="OgreImageCodec_8h-source.html">OgreImageCodec.h</a>.<hr><h2>Member Typedef Documentation</h2>
86<a class="anchor" name="Ogre_1_1ImageCodecw0" doxytag="Ogre::ImageCodec::CodecDataPtr" ></a><p>
87<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
88  <tr>
89    <td class="mdRow">
90      <table cellpadding="0" cellspacing="0" border="0">
91        <tr>
92          <td class="md" nowrap valign="top"> typedef <a class="el" href="classOgre_1_1SharedPtr.html">SharedPtr</a>&lt;CodecData&gt; <a class="el" href="classOgre_1_1SharedPtr.html">Ogre::Codec::CodecDataPtr</a><code> [inherited]</code>
93      </table>
94    </td>
95  </tr>
96</table>
97<table cellspacing=5 cellpadding=0 border=0>
98  <tr>
99    <td>
100      &nbsp;
101    </td>
102    <td>
103
104<p>
105
106<p>
107Definition at line <a class="el" href="OgreCodec_8h-source.html#l00063">63</a> of file <a class="el" href="OgreCodec_8h-source.html">OgreCodec.h</a>.    </td>
108  </tr>
109</table>
110<a class="anchor" name="Ogre_1_1ImageCodecw1" doxytag="Ogre::ImageCodec::CodecIterator" ></a><p>
111<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
112  <tr>
113    <td class="mdRow">
114      <table cellpadding="0" cellspacing="0" border="0">
115        <tr>
116          <td class="md" nowrap valign="top"> typedef <a class="el" href="classOgre_1_1ConstMapIterator.html">ConstMapIterator</a>&lt;<a class="el" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodecx0">CodecList</a>&gt; <a class="el" href="classOgre_1_1ConstMapIterator.html">Ogre::Codec::CodecIterator</a><code> [inherited]</code>
117      </table>
118    </td>
119  </tr>
120</table>
121<table cellspacing=5 cellpadding=0 border=0>
122  <tr>
123    <td>
124      &nbsp;
125    </td>
126    <td>
127
128<p>
129
130<p>
131Definition at line <a class="el" href="OgreCodec_8h-source.html#l00065">65</a> of file <a class="el" href="OgreCodec_8h-source.html">OgreCodec.h</a>.
132<p>
133Referenced by <a class="el" href="OgreCodec_8h-source.html#l00085">Ogre::Codec::getCodecIterator()</a>.    </td>
134  </tr>
135</table>
136<a class="anchor" name="Ogre_1_1ImageCodecx0" doxytag="Ogre::ImageCodec::CodecList" ></a><p>
137<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
138  <tr>
139    <td class="mdRow">
140      <table cellpadding="0" cellspacing="0" border="0">
141        <tr>
142          <td class="md" nowrap valign="top"> typedef std::map&lt; <a class="el" href="namespaceOgre.html#a471">String</a>, <a class="el" href="classOgre_1_1Codec.html">Codec</a>* &gt; <a class="el" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodecx0">Ogre::Codec::CodecList</a><code> [protected, inherited]</code>
143      </table>
144    </td>
145  </tr>
146</table>
147<table cellspacing=5 cellpadding=0 border=0>
148  <tr>
149    <td>
150      &nbsp;
151    </td>
152    <td>
153
154<p>
155
156<p>
157Definition at line <a class="el" href="OgreCodec_8h-source.html#l00048">48</a> of file <a class="el" href="OgreCodec_8h-source.html">OgreCodec.h</a>.    </td>
158  </tr>
159</table>
160<a class="anchor" name="Ogre_1_1ImageCodecw2" doxytag="Ogre::ImageCodec::DecodeResult" ></a><p>
161<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
162  <tr>
163    <td class="mdRow">
164      <table cellpadding="0" cellspacing="0" border="0">
165        <tr>
166          <td class="md" nowrap valign="top"> typedef std::pair&lt;<a class="el" href="classOgre_1_1SharedPtr.html">MemoryDataStreamPtr</a>, <a class="el" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodecw0">CodecDataPtr</a>&gt; <a class="el" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodecw2">Ogre::Codec::DecodeResult</a><code> [inherited]</code>
167      </table>
168    </td>
169  </tr>
170</table>
171<table cellspacing=5 cellpadding=0 border=0>
172  <tr>
173    <td>
174      &nbsp;
175    </td>
176    <td>
177
178<p>
179Result of a decoding; both a decoded data stream and <a class="el" href="classOgre_1_1Codec_1_1CodecData.html">CodecData</a> metadata.
180<p>
181
182<p>
183Definition at line <a class="el" href="OgreCodec_8h-source.html#l00110">110</a> of file <a class="el" href="OgreCodec_8h-source.html">OgreCodec.h</a>.    </td>
184  </tr>
185</table>
186<hr><h2>Constructor &amp; Destructor Documentation</h2>
187<a class="anchor" name="Ogre_1_1ImageCodeca0" doxytag="Ogre::ImageCodec::~ImageCodec" ></a><p>
188<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
189  <tr>
190    <td class="mdRow">
191      <table cellpadding="0" cellspacing="0" border="0">
192        <tr>
193          <td class="md" nowrap valign="top"> virtual Ogre::ImageCodec::~<a class="el" href="classOgre_1_1ImageCodec.html">ImageCodec</a> </td>
194          <td class="md" valign="top">(&nbsp;</td>
195          <td class="mdname1" valign="top" nowrap>          </td>
196          <td class="md" valign="top">&nbsp;)&nbsp;</td>
197          <td class="md" nowrap><code> [virtual]</code></td>
198        </tr>
199
200      </table>
201    </td>
202  </tr>
203</table>
204<table cellspacing=5 cellpadding=0 border=0>
205  <tr>
206    <td>
207      &nbsp;
208    </td>
209    <td>
210
211<p>
212    </td>
213  </tr>
214</table>
215<hr><h2>Member Function Documentation</h2>
216<a class="anchor" name="Ogre_1_1ImageCodeca2" doxytag="Ogre::ImageCodec::code" ></a><p>
217<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
218  <tr>
219    <td class="mdRow">
220      <table cellpadding="0" cellspacing="0" border="0">
221        <tr>
222          <td class="md" nowrap valign="top"> virtual <a class="el" href="classOgre_1_1SharedPtr.html">DataStreamPtr</a> Ogre::Codec::code </td>
223          <td class="md" valign="top">(&nbsp;</td>
224          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1SharedPtr.html">MemoryDataStreamPtr</a> &amp;&nbsp;</td>
225          <td class="mdname" nowrap> <em>input</em>, </td>
226        </tr>
227        <tr>
228          <td class="md" nowrap align="right"></td>
229          <td></td>
230          <td class="md" nowrap><a class="el" href="classOgre_1_1SharedPtr.html">CodecDataPtr</a> &amp;&nbsp;</td>
231          <td class="mdname" nowrap> <em>pData</em></td>
232        </tr>
233        <tr>
234          <td></td>
235          <td class="md">)&nbsp;</td>
236          <td class="md" colspan="2"> const<code> [pure virtual, inherited]</code></td>
237        </tr>
238
239      </table>
240    </td>
241  </tr>
242</table>
243<table cellspacing=5 cellpadding=0 border=0>
244  <tr>
245    <td>
246      &nbsp;
247    </td>
248    <td>
249
250<p>
251Codes the data in the input stream and saves the result in the output stream.
252<p>
253
254<p>
255Implemented in <a class="el" href="classOgre_1_1ILImageCodec.html#Ogre_1_1ILImageCodeca2">Ogre::ILImageCodec</a>, and <a class="el" href="classOgre_1_1EXRCodec.html#Ogre_1_1EXRCodeca2">Ogre::EXRCodec</a>.    </td>
256  </tr>
257</table>
258<a class="anchor" name="Ogre_1_1ImageCodeca3" doxytag="Ogre::ImageCodec::codeToFile" ></a><p>
259<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
260  <tr>
261    <td class="mdRow">
262      <table cellpadding="0" cellspacing="0" border="0">
263        <tr>
264          <td class="md" nowrap valign="top"> virtual void Ogre::Codec::codeToFile </td>
265          <td class="md" valign="top">(&nbsp;</td>
266          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1SharedPtr.html">MemoryDataStreamPtr</a> &amp;&nbsp;</td>
267          <td class="mdname" nowrap> <em>input</em>, </td>
268        </tr>
269        <tr>
270          <td class="md" nowrap align="right"></td>
271          <td></td>
272          <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td>
273          <td class="mdname" nowrap> <em>outFileName</em>, </td>
274        </tr>
275        <tr>
276          <td class="md" nowrap align="right"></td>
277          <td></td>
278          <td class="md" nowrap><a class="el" href="classOgre_1_1SharedPtr.html">CodecDataPtr</a> &amp;&nbsp;</td>
279          <td class="mdname" nowrap> <em>pData</em></td>
280        </tr>
281        <tr>
282          <td></td>
283          <td class="md">)&nbsp;</td>
284          <td class="md" colspan="2"> const<code> [pure virtual, inherited]</code></td>
285        </tr>
286
287      </table>
288    </td>
289  </tr>
290</table>
291<table cellspacing=5 cellpadding=0 border=0>
292  <tr>
293    <td>
294      &nbsp;
295    </td>
296    <td>
297
298<p>
299Codes the data in the input chunk and saves the result in the output filename provided.
300<p>
301Provided for efficiency since coding to memory is progressive therefore memory required is unknown leading to reallocations. <dl compact><dt><b>Parameters:</b></dt><dd>
302  <table border="0" cellspacing="2" cellpadding="0">
303    <tr><td valign=top><em>input</em>&nbsp;</td><td>The input data </td></tr>
304    <tr><td valign=top><em>outFileName</em>&nbsp;</td><td>The filename to write to </td></tr>
305    <tr><td valign=top><em>pData</em>&nbsp;</td><td>Extra information to be passed to the codec (codec type specific) </td></tr>
306  </table>
307</dl>
308
309<p>
310Implemented in <a class="el" href="classOgre_1_1ILImageCodec.html#Ogre_1_1ILImageCodeca3">Ogre::ILImageCodec</a>, and <a class="el" href="classOgre_1_1EXRCodec.html#Ogre_1_1EXRCodeca3">Ogre::EXRCodec</a>.    </td>
311  </tr>
312</table>
313<a class="anchor" name="Ogre_1_1ImageCodeca4" doxytag="Ogre::ImageCodec::decode" ></a><p>
314<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
315  <tr>
316    <td class="mdRow">
317      <table cellpadding="0" cellspacing="0" border="0">
318        <tr>
319          <td class="md" nowrap valign="top"> virtual <a class="el" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodecw2">DecodeResult</a> Ogre::Codec::decode </td>
320          <td class="md" valign="top">(&nbsp;</td>
321          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1SharedPtr.html">DataStreamPtr</a> &amp;&nbsp;</td>
322          <td class="mdname1" valign="top" nowrap> <em>input</em>          </td>
323          <td class="md" valign="top">&nbsp;)&nbsp;</td>
324          <td class="md" nowrap> const<code> [pure virtual, inherited]</code></td>
325        </tr>
326
327      </table>
328    </td>
329  </tr>
330</table>
331<table cellspacing=5 cellpadding=0 border=0>
332  <tr>
333    <td>
334      &nbsp;
335    </td>
336    <td>
337
338<p>
339Codes the data from the input chunk into the output chunk.
340<p>
341<dl compact><dt><b>Parameters:</b></dt><dd>
342  <table border="0" cellspacing="2" cellpadding="0">
343    <tr><td valign=top><em>input</em>&nbsp;</td><td>Stream containing the encoded data </td></tr>
344  </table>
345</dl>
346<dl compact><dt><b>Note:</b></dt><dd>Has a variable number of arguments, which depend on the codec type. </dd></dl>
347
348<p>
349Implemented in <a class="el" href="classOgre_1_1ILImageCodec.html#Ogre_1_1ILImageCodeca4">Ogre::ILImageCodec</a>, and <a class="el" href="classOgre_1_1EXRCodec.html#Ogre_1_1EXRCodeca4">Ogre::EXRCodec</a>.    </td>
350  </tr>
351</table>
352<a class="anchor" name="Ogre_1_1ImageCodece4" doxytag="Ogre::ImageCodec::getCodec" ></a><p>
353<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
354  <tr>
355    <td class="mdRow">
356      <table cellpadding="0" cellspacing="0" border="0">
357        <tr>
358          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Codec.html">Codec</a>* Ogre::Codec::getCodec </td>
359          <td class="md" valign="top">(&nbsp;</td>
360          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td>
361          <td class="mdname1" valign="top" nowrap> <em>extension</em>          </td>
362          <td class="md" valign="top">&nbsp;)&nbsp;</td>
363          <td class="md" nowrap><code> [static, inherited]</code></td>
364        </tr>
365
366      </table>
367    </td>
368  </tr>
369</table>
370<table cellspacing=5 cellpadding=0 border=0>
371  <tr>
372    <td>
373      &nbsp;
374    </td>
375    <td>
376
377<p>
378Gets the codec registered for the passed in file extension.
379<p>
380    </td>
381  </tr>
382</table>
383<a class="anchor" name="Ogre_1_1ImageCodece2" doxytag="Ogre::ImageCodec::getCodecIterator" ></a><p>
384<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
385  <tr>
386    <td class="mdRow">
387      <table cellpadding="0" cellspacing="0" border="0">
388        <tr>
389          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodecw1">CodecIterator</a> Ogre::Codec::getCodecIterator </td>
390          <td class="md" valign="top">(&nbsp;</td>
391          <td class="md" nowrap valign="top">void&nbsp;</td>
392          <td class="mdname1" valign="top" nowrap>          </td>
393          <td class="md" valign="top">&nbsp;)&nbsp;</td>
394          <td class="md" nowrap><code> [static, inherited]</code></td>
395        </tr>
396
397      </table>
398    </td>
399  </tr>
400</table>
401<table cellspacing=5 cellpadding=0 border=0>
402  <tr>
403    <td>
404      &nbsp;
405    </td>
406    <td>
407
408<p>
409Gets the iterator for the registered codecs.
410<p>
411
412<p>
413Definition at line <a class="el" href="OgreCodec_8h-source.html#l00085">85</a> of file <a class="el" href="OgreCodec_8h-source.html">OgreCodec.h</a>.
414<p>
415References <a class="el" href="OgreCodec_8h-source.html#l00065">Ogre::Codec::CodecIterator</a>.    </td>
416  </tr>
417</table>
418<a class="anchor" name="Ogre_1_1ImageCodeca1" doxytag="Ogre::ImageCodec::getDataType" ></a><p>
419<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
420  <tr>
421    <td class="mdRow">
422      <table cellpadding="0" cellspacing="0" border="0">
423        <tr>
424          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a471">String</a> Ogre::ImageCodec::getDataType </td>
425          <td class="md" valign="top">(&nbsp;</td>
426          <td class="mdname1" valign="top" nowrap>          </td>
427          <td class="md" valign="top">&nbsp;)&nbsp;</td>
428          <td class="md" nowrap> const<code> [virtual]</code></td>
429        </tr>
430
431      </table>
432    </td>
433  </tr>
434</table>
435<table cellspacing=5 cellpadding=0 border=0>
436  <tr>
437    <td>
438      &nbsp;
439    </td>
440    <td>
441
442<p>
443Returns the type of the data that supported by this codec as a String.
444<p>
445
446<p>
447Implements <a class="el" href="classOgre_1_1Codec.html#Ogre_1_1Codeca5">Ogre::Codec</a>.
448<p>
449Definition at line <a class="el" href="OgreImageCodec_8h-source.html#l00070">70</a> of file <a class="el" href="OgreImageCodec_8h-source.html">OgreImageCodec.h</a>.
450<p>
451References <a class="el" href="OgrePrerequisites_8h-source.html#l00156">Ogre::String</a>.    </td>
452  </tr>
453</table>
454<a class="anchor" name="Ogre_1_1ImageCodece3" doxytag="Ogre::ImageCodec::getExtensions" ></a><p>
455<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
456  <tr>
457    <td class="mdRow">
458      <table cellpadding="0" cellspacing="0" border="0">
459        <tr>
460          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a580">StringVector</a> Ogre::Codec::getExtensions </td>
461          <td class="md" valign="top">(&nbsp;</td>
462          <td class="md" nowrap valign="top">void&nbsp;</td>
463          <td class="mdname1" valign="top" nowrap>          </td>
464          <td class="md" valign="top">&nbsp;)&nbsp;</td>
465          <td class="md" nowrap><code> [static, inherited]</code></td>
466        </tr>
467
468      </table>
469    </td>
470  </tr>
471</table>
472<table cellspacing=5 cellpadding=0 border=0>
473  <tr>
474    <td>
475      &nbsp;
476    </td>
477    <td>
478
479<p>
480Gets the file extension list for the registered codecs.
481<p>
482    </td>
483  </tr>
484</table>
485<a class="anchor" name="Ogre_1_1ImageCodeca5" doxytag="Ogre::ImageCodec::getType" ></a><p>
486<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
487  <tr>
488    <td class="mdRow">
489      <table cellpadding="0" cellspacing="0" border="0">
490        <tr>
491          <td class="md" nowrap valign="top"> virtual <a class="el" href="namespaceOgre.html#a471">String</a> Ogre::Codec::getType </td>
492          <td class="md" valign="top">(&nbsp;</td>
493          <td class="mdname1" valign="top" nowrap>          </td>
494          <td class="md" valign="top">&nbsp;)&nbsp;</td>
495          <td class="md" nowrap> const<code> [pure virtual, inherited]</code></td>
496        </tr>
497
498      </table>
499    </td>
500  </tr>
501</table>
502<table cellspacing=5 cellpadding=0 border=0>
503  <tr>
504    <td>
505      &nbsp;
506    </td>
507    <td>
508
509<p>
510Returns the type of the codec as a String.
511<p>
512
513<p>
514Implemented in <a class="el" href="classOgre_1_1ILImageCodec.html#Ogre_1_1ILImageCodeca6">Ogre::ILImageCodec</a>, and <a class="el" href="classOgre_1_1EXRCodec.html#Ogre_1_1EXRCodeca5">Ogre::EXRCodec</a>.
515<p>
516Referenced by <a class="el" href="OgreCodec_8h-source.html#l00072">Ogre::Codec::registerCodec()</a>, and <a class="el" href="OgreCodec_8h-source.html#l00079">Ogre::Codec::unRegisterCodec()</a>.    </td>
517  </tr>
518</table>
519<a class="anchor" name="Ogre_1_1ImageCodece0" doxytag="Ogre::ImageCodec::registerCodec" ></a><p>
520<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
521  <tr>
522    <td class="mdRow">
523      <table cellpadding="0" cellspacing="0" border="0">
524        <tr>
525          <td class="md" nowrap valign="top"> void Ogre::Codec::registerCodec </td>
526          <td class="md" valign="top">(&nbsp;</td>
527          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1Codec.html">Codec</a> *&nbsp;</td>
528          <td class="mdname1" valign="top" nowrap> <em>pCodec</em>          </td>
529          <td class="md" valign="top">&nbsp;)&nbsp;</td>
530          <td class="md" nowrap><code> [static, inherited]</code></td>
531        </tr>
532
533      </table>
534    </td>
535  </tr>
536</table>
537<table cellspacing=5 cellpadding=0 border=0>
538  <tr>
539    <td>
540      &nbsp;
541    </td>
542    <td>
543
544<p>
545Registers a new codec in the database.
546<p>
547
548<p>
549Definition at line <a class="el" href="OgreCodec_8h-source.html#l00072">72</a> of file <a class="el" href="OgreCodec_8h-source.html">OgreCodec.h</a>.
550<p>
551References <a class="el" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodeca5">Ogre::Codec::getType()</a>.    </td>
552  </tr>
553</table>
554<a class="anchor" name="Ogre_1_1ImageCodece1" doxytag="Ogre::ImageCodec::unRegisterCodec" ></a><p>
555<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
556  <tr>
557    <td class="mdRow">
558      <table cellpadding="0" cellspacing="0" border="0">
559        <tr>
560          <td class="md" nowrap valign="top"> void Ogre::Codec::unRegisterCodec </td>
561          <td class="md" valign="top">(&nbsp;</td>
562          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1Codec.html">Codec</a> *&nbsp;</td>
563          <td class="mdname1" valign="top" nowrap> <em>pCodec</em>          </td>
564          <td class="md" valign="top">&nbsp;)&nbsp;</td>
565          <td class="md" nowrap><code> [static, inherited]</code></td>
566        </tr>
567
568      </table>
569    </td>
570  </tr>
571</table>
572<table cellspacing=5 cellpadding=0 border=0>
573  <tr>
574    <td>
575      &nbsp;
576    </td>
577    <td>
578
579<p>
580Unregisters a codec from the database.
581<p>
582
583<p>
584Definition at line <a class="el" href="OgreCodec_8h-source.html#l00079">79</a> of file <a class="el" href="OgreCodec_8h-source.html">OgreCodec.h</a>.
585<p>
586References <a class="el" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodeca5">Ogre::Codec::getType()</a>.    </td>
587  </tr>
588</table>
589<hr><h2>Member Data Documentation</h2>
590<a class="anchor" name="Ogre_1_1ImageCodect0" doxytag="Ogre::ImageCodec::ms_mapCodecs" ></a><p>
591<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
592  <tr>
593    <td class="mdRow">
594      <table cellpadding="0" cellspacing="0" border="0">
595        <tr>
596          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodecx0">CodecList</a> <a class="el" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodect0">Ogre::Codec::ms_mapCodecs</a><code> [static, protected, inherited]</code>
597      </table>
598    </td>
599  </tr>
600</table>
601<table cellspacing=5 cellpadding=0 border=0>
602  <tr>
603    <td>
604      &nbsp;
605    </td>
606    <td>
607
608<p>
609A map that contains all the registered codecs.
610<p>
611
612<p>
613Definition at line <a class="el" href="OgreCodec_8h-source.html#l00051">51</a> of file <a class="el" href="OgreCodec_8h-source.html">OgreCodec.h</a>.    </td>
614  </tr>
615</table>
616<hr>The documentation for this class was generated from the following file:<ul>
617<li><a class="el" href="OgreImageCodec_8h-source.html">OgreImageCodec.h</a></ul>
618<hr>
619<p>
620Copyright &copy; 2000-2005 by The OGRE Team<br />
621<!--Creative Commons License--><a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/"><img alt="Creative Commons License" border="0" src="http://creativecommons.org/images/public/somerights20.png"/></a><br/>
622This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/">Creative Commons Attribution-ShareAlike 2.5 License</a>.<br/>
623                <!--/Creative Commons License--><!-- <rdf:RDF xmlns="http://web.resource.org/cc/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
624                <Work rdf:about="">
625                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
626        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
627                </Work>
628                <License rdf:about="http://creativecommons.org/licenses/by-sa/2.5/"><permits rdf:resource="http://web.resource.org/cc/Reproduction"/><permits rdf:resource="http://web.resource.org/cc/Distribution"/><requires rdf:resource="http://web.resource.org/cc/Notice"/><requires rdf:resource="http://web.resource.org/cc/Attribution"/><permits rdf:resource="http://web.resource.org/cc/DerivativeWorks"/><requires rdf:resource="http://web.resource.org/cc/ShareAlike"/></License></rdf:RDF> -->
629
630Last modified Sun Mar 12 14:39:24 2006
631</p>
632</body>
633</html>
Note: See TracBrowser for help on using the repository browser.