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

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

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