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

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

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