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

Revision 657, 24.3 KB checked in by mattausch, 18 years ago (diff)

added ogre dependencies and patched ogre sources
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 std::pair&lt; <a class="el" href="classOgre_1_1SharedPtr.html">MemoryDataStreamPtr</a>,<br>
28 <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_1ImageCodecw1">DecodeResult</a></td></tr>
29
30<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_1ImageCodecw1"></a><br><br></td></tr>
31<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
32<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>
33
34<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_1ImageCodeca1">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>
35
36<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_1ImageCodeca1"></a><br><br></td></tr>
37<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_1ImageCodeca2">codeToFile</a> (<a class="el" href="classOgre_1_1SharedPtr.html">MemoryDataStreamPtr</a> &amp;input, const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;outFileName, <a class="el" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodecw0">CodecDataPtr</a> &amp;pData) const=0</td></tr>
38
39<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_1ImageCodeca2"></a><br><br></td></tr>
40<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodecw1">DecodeResult</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodeca3">decode</a> (<a class="el" href="classOgre_1_1SharedPtr.html">DataStreamPtr</a> &amp;input) const=0</td></tr>
41
42<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Codes the data from the input chunk into the output chunk.  <a href="#Ogre_1_1ImageCodeca3"></a><br><br></td></tr>
43<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="namespaceOgre.html#a426">String</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodeca4">getType</a> () const=0</td></tr>
44
45<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the type of the codec as a String.  <a href="#Ogre_1_1ImageCodeca4"></a><br><br></td></tr>
46<tr><td colspan=2><br><h2>Static Public Member Functions</h2></td></tr>
47<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>
48
49<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>
50<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>
51
52<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>
53<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_1ImageCodece2">getCodec</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;extension)</td></tr>
54
55<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the codec registered for the passed in file extension.  <a href="#Ogre_1_1ImageCodece2"></a><br><br></td></tr>
56<tr><td colspan=2><br><h2>Protected Types</h2></td></tr>
57<tr><td class="memItemLeft" nowrap align=right valign=top>typedef std::map&lt; <a class="el" href="namespaceOgre.html#a426">String</a>,<br>
58 <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>
59
60<tr><td colspan=2><br><h2>Static Protected Attributes</h2></td></tr>
61<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>
62
63<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>
64</table>
65<hr><a name="_details"></a><h2>Detailed Description</h2>
66<a class="el" href="classOgre_1_1Codec.html">Codec</a> specialized in images.
67<p>
68<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>
69
70<p>
71
72<p>
73Definition 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>
74<a class="anchor" name="Ogre_1_1ImageCodecw0" doxytag="Ogre::ImageCodec::CodecDataPtr" ></a><p>
75<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
76  <tr>
77    <td class="mdRow">
78      <table cellpadding="0" cellspacing="0" border="0">
79        <tr>
80          <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>
81      </table>
82    </td>
83  </tr>
84</table>
85<table cellspacing=5 cellpadding=0 border=0>
86  <tr>
87    <td>
88      &nbsp;
89    </td>
90    <td>
91
92<p>
93
94<p>
95Definition at line <a class="el" href="OgreCodec_8h-source.html#l00061">61</a> of file <a class="el" href="OgreCodec_8h-source.html">OgreCodec.h</a>.    </td>
96  </tr>
97</table>
98<a class="anchor" name="Ogre_1_1ImageCodecx0" doxytag="Ogre::ImageCodec::CodecList" ></a><p>
99<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
100  <tr>
101    <td class="mdRow">
102      <table cellpadding="0" cellspacing="0" border="0">
103        <tr>
104          <td class="md" nowrap valign="top"> typedef std::map&lt; <a class="el" href="namespaceOgre.html#a426">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>
105      </table>
106    </td>
107  </tr>
108</table>
109<table cellspacing=5 cellpadding=0 border=0>
110  <tr>
111    <td>
112      &nbsp;
113    </td>
114    <td>
115
116<p>
117
118<p>
119Definition at line <a class="el" href="OgreCodec_8h-source.html#l00046">46</a> of file <a class="el" href="OgreCodec_8h-source.html">OgreCodec.h</a>.    </td>
120  </tr>
121</table>
122<a class="anchor" name="Ogre_1_1ImageCodecw1" doxytag="Ogre::ImageCodec::DecodeResult" ></a><p>
123<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
124  <tr>
125    <td class="mdRow">
126      <table cellpadding="0" cellspacing="0" border="0">
127        <tr>
128          <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_1ImageCodecw1">Ogre::Codec::DecodeResult</a><code> [inherited]</code>
129      </table>
130    </td>
131  </tr>
132</table>
133<table cellspacing=5 cellpadding=0 border=0>
134  <tr>
135    <td>
136      &nbsp;
137    </td>
138    <td>
139
140<p>
141Result of a decoding; both a decoded data stream and <a class="el" href="classOgre_1_1Codec_1_1CodecData.html">CodecData</a> metadata.
142<p>
143
144<p>
145Definition at line <a class="el" href="OgreCodec_8h-source.html#l00097">97</a> of file <a class="el" href="OgreCodec_8h-source.html">OgreCodec.h</a>.    </td>
146  </tr>
147</table>
148<hr><h2>Constructor &amp; Destructor Documentation</h2>
149<a class="anchor" name="Ogre_1_1ImageCodeca0" doxytag="Ogre::ImageCodec::~ImageCodec" ></a><p>
150<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
151  <tr>
152    <td class="mdRow">
153      <table cellpadding="0" cellspacing="0" border="0">
154        <tr>
155          <td class="md" nowrap valign="top"> virtual Ogre::ImageCodec::~<a class="el" href="classOgre_1_1ImageCodec.html">ImageCodec</a> </td>
156          <td class="md" valign="top">(&nbsp;</td>
157          <td class="mdname1" valign="top" nowrap>          </td>
158          <td class="md" valign="top">&nbsp;)&nbsp;</td>
159          <td class="md" nowrap><code> [virtual]</code></td>
160        </tr>
161
162      </table>
163    </td>
164  </tr>
165</table>
166<table cellspacing=5 cellpadding=0 border=0>
167  <tr>
168    <td>
169      &nbsp;
170    </td>
171    <td>
172
173<p>
174    </td>
175  </tr>
176</table>
177<hr><h2>Member Function Documentation</h2>
178<a class="anchor" name="Ogre_1_1ImageCodeca1" doxytag="Ogre::ImageCodec::code" ></a><p>
179<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
180  <tr>
181    <td class="mdRow">
182      <table cellpadding="0" cellspacing="0" border="0">
183        <tr>
184          <td class="md" nowrap valign="top"> virtual <a class="el" href="classOgre_1_1SharedPtr.html">DataStreamPtr</a> Ogre::Codec::code </td>
185          <td class="md" valign="top">(&nbsp;</td>
186          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1SharedPtr.html">MemoryDataStreamPtr</a> &amp;&nbsp;</td>
187          <td class="mdname" nowrap> <em>input</em>, </td>
188        </tr>
189        <tr>
190          <td class="md" nowrap align="right"></td>
191          <td></td>
192          <td class="md" nowrap><a class="el" href="classOgre_1_1SharedPtr.html">CodecDataPtr</a> &amp;&nbsp;</td>
193          <td class="mdname" nowrap> <em>pData</em></td>
194        </tr>
195        <tr>
196          <td></td>
197          <td class="md">)&nbsp;</td>
198          <td class="md" colspan="2"> const<code> [pure virtual, inherited]</code></td>
199        </tr>
200
201      </table>
202    </td>
203  </tr>
204</table>
205<table cellspacing=5 cellpadding=0 border=0>
206  <tr>
207    <td>
208      &nbsp;
209    </td>
210    <td>
211
212<p>
213Codes the data in the input stream and saves the result in the output stream.
214<p>
215
216<p>
217Implemented 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>
218  </tr>
219</table>
220<a class="anchor" name="Ogre_1_1ImageCodeca2" doxytag="Ogre::ImageCodec::codeToFile" ></a><p>
221<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
222  <tr>
223    <td class="mdRow">
224      <table cellpadding="0" cellspacing="0" border="0">
225        <tr>
226          <td class="md" nowrap valign="top"> virtual void Ogre::Codec::codeToFile </td>
227          <td class="md" valign="top">(&nbsp;</td>
228          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1SharedPtr.html">MemoryDataStreamPtr</a> &amp;&nbsp;</td>
229          <td class="mdname" nowrap> <em>input</em>, </td>
230        </tr>
231        <tr>
232          <td class="md" nowrap align="right"></td>
233          <td></td>
234          <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
235          <td class="mdname" nowrap> <em>outFileName</em>, </td>
236        </tr>
237        <tr>
238          <td class="md" nowrap align="right"></td>
239          <td></td>
240          <td class="md" nowrap><a class="el" href="classOgre_1_1SharedPtr.html">CodecDataPtr</a> &amp;&nbsp;</td>
241          <td class="mdname" nowrap> <em>pData</em></td>
242        </tr>
243        <tr>
244          <td></td>
245          <td class="md">)&nbsp;</td>
246          <td class="md" colspan="2"> const<code> [pure virtual, inherited]</code></td>
247        </tr>
248
249      </table>
250    </td>
251  </tr>
252</table>
253<table cellspacing=5 cellpadding=0 border=0>
254  <tr>
255    <td>
256      &nbsp;
257    </td>
258    <td>
259
260<p>
261Codes the data in the input chunk and saves the result in the output filename provided.
262<p>
263Provided for efficiency since coding to memory is progressive therefore memory required is unknown leading to reallocations. <dl compact><dt><b>Parameters:</b></dt><dd>
264  <table border="0" cellspacing="2" cellpadding="0">
265    <tr><td valign=top><em>input</em>&nbsp;</td><td>The input data </td></tr>
266    <tr><td valign=top><em>outFileName</em>&nbsp;</td><td>The filename to write to </td></tr>
267    <tr><td valign=top><em>pData</em>&nbsp;</td><td>Extra information to be passed to the codec (codec type specific) </td></tr>
268  </table>
269</dl>
270
271<p>
272Implemented 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>
273  </tr>
274</table>
275<a class="anchor" name="Ogre_1_1ImageCodeca3" doxytag="Ogre::ImageCodec::decode" ></a><p>
276<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
277  <tr>
278    <td class="mdRow">
279      <table cellpadding="0" cellspacing="0" border="0">
280        <tr>
281          <td class="md" nowrap valign="top"> virtual <a class="el" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodecw1">DecodeResult</a> Ogre::Codec::decode </td>
282          <td class="md" valign="top">(&nbsp;</td>
283          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1SharedPtr.html">DataStreamPtr</a> &amp;&nbsp;</td>
284          <td class="mdname1" valign="top" nowrap> <em>input</em>          </td>
285          <td class="md" valign="top">&nbsp;)&nbsp;</td>
286          <td class="md" nowrap> const<code> [pure virtual, inherited]</code></td>
287        </tr>
288
289      </table>
290    </td>
291  </tr>
292</table>
293<table cellspacing=5 cellpadding=0 border=0>
294  <tr>
295    <td>
296      &nbsp;
297    </td>
298    <td>
299
300<p>
301Codes the data from the input chunk into the output chunk.
302<p>
303<dl compact><dt><b>Parameters:</b></dt><dd>
304  <table border="0" cellspacing="2" cellpadding="0">
305    <tr><td valign=top><em>input</em>&nbsp;</td><td>Stream containing the encoded data </td></tr>
306  </table>
307</dl>
308<dl compact><dt><b>Note:</b></dt><dd>Has a variable number of arguments, which depend on the codec type. </dd></dl>
309
310<p>
311Implemented 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>
312  </tr>
313</table>
314<a class="anchor" name="Ogre_1_1ImageCodece2" doxytag="Ogre::ImageCodec::getCodec" ></a><p>
315<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
316  <tr>
317    <td class="mdRow">
318      <table cellpadding="0" cellspacing="0" border="0">
319        <tr>
320          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Codec.html">Codec</a>* Ogre::Codec::getCodec </td>
321          <td class="md" valign="top">(&nbsp;</td>
322          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
323          <td class="mdname1" valign="top" nowrap> <em>extension</em>          </td>
324          <td class="md" valign="top">&nbsp;)&nbsp;</td>
325          <td class="md" nowrap><code> [static, inherited]</code></td>
326        </tr>
327
328      </table>
329    </td>
330  </tr>
331</table>
332<table cellspacing=5 cellpadding=0 border=0>
333  <tr>
334    <td>
335      &nbsp;
336    </td>
337    <td>
338
339<p>
340Gets the codec registered for the passed in file extension.
341<p>
342    </td>
343  </tr>
344</table>
345<a class="anchor" name="Ogre_1_1ImageCodeca4" doxytag="Ogre::ImageCodec::getType" ></a><p>
346<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
347  <tr>
348    <td class="mdRow">
349      <table cellpadding="0" cellspacing="0" border="0">
350        <tr>
351          <td class="md" nowrap valign="top"> virtual <a class="el" href="namespaceOgre.html#a426">String</a> Ogre::Codec::getType </td>
352          <td class="md" valign="top">(&nbsp;</td>
353          <td class="mdname1" valign="top" nowrap>          </td>
354          <td class="md" valign="top">&nbsp;)&nbsp;</td>
355          <td class="md" nowrap> const<code> [pure virtual, inherited]</code></td>
356        </tr>
357
358      </table>
359    </td>
360  </tr>
361</table>
362<table cellspacing=5 cellpadding=0 border=0>
363  <tr>
364    <td>
365      &nbsp;
366    </td>
367    <td>
368
369<p>
370Returns the type of the codec as a String.
371<p>
372
373<p>
374Implemented 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>.
375<p>
376Referenced by <a class="el" href="OgreCodec_8h-source.html#l00068">Ogre::Codec::registerCodec()</a>, and <a class="el" href="OgreCodec_8h-source.html#l00075">Ogre::Codec::unRegisterCodec()</a>.    </td>
377  </tr>
378</table>
379<a class="anchor" name="Ogre_1_1ImageCodece0" doxytag="Ogre::ImageCodec::registerCodec" ></a><p>
380<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
381  <tr>
382    <td class="mdRow">
383      <table cellpadding="0" cellspacing="0" border="0">
384        <tr>
385          <td class="md" nowrap valign="top"> void Ogre::Codec::registerCodec </td>
386          <td class="md" valign="top">(&nbsp;</td>
387          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1Codec.html">Codec</a> *&nbsp;</td>
388          <td class="mdname1" valign="top" nowrap> <em>pCodec</em>          </td>
389          <td class="md" valign="top">&nbsp;)&nbsp;</td>
390          <td class="md" nowrap><code> [static, inherited]</code></td>
391        </tr>
392
393      </table>
394    </td>
395  </tr>
396</table>
397<table cellspacing=5 cellpadding=0 border=0>
398  <tr>
399    <td>
400      &nbsp;
401    </td>
402    <td>
403
404<p>
405Registers a new codec in the database.
406<p>
407
408<p>
409Definition at line <a class="el" href="OgreCodec_8h-source.html#l00068">68</a> of file <a class="el" href="OgreCodec_8h-source.html">OgreCodec.h</a>.
410<p>
411References <a class="el" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodeca4">Ogre::Codec::getType()</a>.    </td>
412  </tr>
413</table>
414<a class="anchor" name="Ogre_1_1ImageCodece1" doxytag="Ogre::ImageCodec::unRegisterCodec" ></a><p>
415<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
416  <tr>
417    <td class="mdRow">
418      <table cellpadding="0" cellspacing="0" border="0">
419        <tr>
420          <td class="md" nowrap valign="top"> void Ogre::Codec::unRegisterCodec </td>
421          <td class="md" valign="top">(&nbsp;</td>
422          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1Codec.html">Codec</a> *&nbsp;</td>
423          <td class="mdname1" valign="top" nowrap> <em>pCodec</em>          </td>
424          <td class="md" valign="top">&nbsp;)&nbsp;</td>
425          <td class="md" nowrap><code> [static, inherited]</code></td>
426        </tr>
427
428      </table>
429    </td>
430  </tr>
431</table>
432<table cellspacing=5 cellpadding=0 border=0>
433  <tr>
434    <td>
435      &nbsp;
436    </td>
437    <td>
438
439<p>
440Unregisters a codec from the database.
441<p>
442
443<p>
444Definition at line <a class="el" href="OgreCodec_8h-source.html#l00075">75</a> of file <a class="el" href="OgreCodec_8h-source.html">OgreCodec.h</a>.
445<p>
446References <a class="el" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodeca4">Ogre::Codec::getType()</a>.    </td>
447  </tr>
448</table>
449<hr><h2>Member Data Documentation</h2>
450<a class="anchor" name="Ogre_1_1ImageCodect0" doxytag="Ogre::ImageCodec::ms_mapCodecs" ></a><p>
451<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
452  <tr>
453    <td class="mdRow">
454      <table cellpadding="0" cellspacing="0" border="0">
455        <tr>
456          <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>
457      </table>
458    </td>
459  </tr>
460</table>
461<table cellspacing=5 cellpadding=0 border=0>
462  <tr>
463    <td>
464      &nbsp;
465    </td>
466    <td>
467
468<p>
469A map that contains all the registered codecs.
470<p>
471
472<p>
473Definition at line <a class="el" href="OgreCodec_8h-source.html#l00049">49</a> of file <a class="el" href="OgreCodec_8h-source.html">OgreCodec.h</a>.    </td>
474  </tr>
475</table>
476<hr>The documentation for this class was generated from the following file:<ul>
477<li><a class="el" href="OgreImageCodec_8h-source.html">OgreImageCodec.h</a></ul>
478<hr>
479<p>
480Copyright &copy; 2000-2005 by The OGRE Team<br />
481<!--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/>
482This 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/>
483                <!--/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#">
484                <Work rdf:about="">
485                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
486        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
487                </Work>
488                <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> -->
489
490Last modified Sun Feb 12 13:00:49 2006
491</p>
492</body>
493</html>
Note: See TracBrowser for help on using the repository browser.