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

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

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>Ogre::ILImageCodec 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::ILImageCodec Class Reference</h1><a class="el" href="classOgre_1_1Codec.html">Codec</a> specialized in images loaded using DevIL. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreILImageCodec_8h-source.html">OgreILImageCodec.h</a>&gt;</code>
14<p>
15<p>Inheritance diagram for Ogre::ILImageCodec:
16<p><center><img src="classOgre_1_1ILImageCodec.png" usemap="#Ogre::ILImageCodec_map" border="0" alt=""></center>
17<map name="Ogre::ILImageCodec_map">
18<area href="classOgre_1_1ImageCodec.html" alt="Ogre::ImageCodec" shape="rect" coords="0,56,127,80">
19<area href="classOgre_1_1Codec.html" alt="Ogre::Codec" shape="rect" coords="0,0,127,24">
20</map>
21<a href="classOgre_1_1ILImageCodec-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 std::pair&lt; <a class="el" href="classOgre_1_1SharedPtr.html">MemoryDataStreamPtr</a>,<br>
27 <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>
28
29<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>
30<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
31<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ILImageCodec.html#Ogre_1_1ILImageCodeca0">ILImageCodec</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;type, unsigned int ilType)</td></tr>
32
33<tr><td class="memItemLeft" nowrap align=right valign=top>virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ILImageCodec.html#Ogre_1_1ILImageCodeca1">~ILImageCodec</a> ()</td></tr>
34
35<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_1ILImageCodec.html#Ogre_1_1ILImageCodeca2">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>
36
37<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">  <a href="#Ogre_1_1ILImageCodeca2"></a><br><br></td></tr>
38<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ILImageCodec.html#Ogre_1_1ILImageCodeca3">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 </td></tr>
39
40<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>
41  <table border="0" cellspacing="2" cellpadding="0">
42    <tr><td valign=top><em>input</em>&nbsp;</td><td>The input data </td></tr>
43    <tr><td valign=top><em>outFileName</em>&nbsp;</td><td>The filename to write to </td></tr>
44    <tr><td valign=top><em>pData</em>&nbsp;</td><td>Extra information to be passed to the codec (codec type specific)</td></tr>
45  </table>
46</dl>
47  <a href="#Ogre_1_1ILImageCodeca3"></a><br><br></td></tr>
48<tr><td class="memItemLeft" nowrap align=right valign=top><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_1ILImageCodec.html#Ogre_1_1ILImageCodeca4">decode</a> (<a class="el" href="classOgre_1_1SharedPtr.html">DataStreamPtr</a> &amp;input) const </td></tr>
49
50<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><dl compact><dt><b>Parameters:</b></dt><dd>
51  <table border="0" cellspacing="2" cellpadding="0">
52    <tr><td valign=top><em>input</em>&nbsp;</td><td>Stream containing the encoded data </td></tr>
53  </table>
54</dl>
55<dl compact><dt><b>Note:</b></dt><dd>Has a variable number of arguments, which depend on the codec type.</dd></dl>
56  <a href="#Ogre_1_1ILImageCodeca4"></a><br><br></td></tr>
57<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ILImageCodec.html#Ogre_1_1ILImageCodeca5">initialiseIL</a> (void)</td></tr>
58
59<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialise DevIL.  <a href="#Ogre_1_1ILImageCodeca5"></a><br><br></td></tr>
60<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_1ILImageCodec.html#Ogre_1_1ILImageCodeca6">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_1ILImageCodeca6"></a><br><br></td></tr>
63<tr><td colspan=2><br><h2>Static Public Member Functions</h2></td></tr>
64<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>
65
66<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>
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_1ImageCodece1">unRegisterCodec</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">Unregisters a codec from the database.  <a href="#Ogre_1_1ImageCodece1"></a><br><br></td></tr>
70<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>
71
72<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>
73<tr><td colspan=2><br><h2>Protected Types</h2></td></tr>
74<tr><td class="memItemLeft" nowrap align=right valign=top>typedef std::map&lt; <a class="el" href="namespaceOgre.html#a426">String</a>,<br>
75 <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>
76
77<tr><td colspan=2><br><h2>Static Protected Attributes</h2></td></tr>
78<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>
79
80<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>
81<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr>
82<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a426">String</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ILImageCodec.html#Ogre_1_1ILImageCodecr0">mType</a></td></tr>
83
84<tr><td class="memItemLeft" nowrap align=right valign=top>unsigned int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ILImageCodec.html#Ogre_1_1ILImageCodecr1">mIlType</a></td></tr>
85
86<tr><td colspan=2><br><h2>Static Private Attributes</h2></td></tr>
87<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ILImageCodec.html#Ogre_1_1ILImageCodecv0">_is_initialised</a></td></tr>
88
89</table>
90<hr><a name="_details"></a><h2>Detailed Description</h2>
91<a class="el" href="classOgre_1_1Codec.html">Codec</a> specialized in images loaded using DevIL.
92<p>
93<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 ImageData class from the decode(...) function. </dd></dl>
94
95<p>
96
97<p>
98Definition at line <a class="el" href="OgreILImageCodec_8h-source.html#l00037">37</a> of file <a class="el" href="OgreILImageCodec_8h-source.html">OgreILImageCodec.h</a>.<hr><h2>Member Typedef Documentation</h2>
99<a class="anchor" name="Ogre_1_1ImageCodecw0" doxytag="Ogre::ILImageCodec::CodecDataPtr" ></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 <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>
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#l00061">61</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_1ImageCodecx0" doxytag="Ogre::ILImageCodec::CodecList" ></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::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>
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>
142
143<p>
144Definition 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>
145  </tr>
146</table>
147<a class="anchor" name="Ogre_1_1ImageCodecw1" doxytag="Ogre::ILImageCodec::DecodeResult" ></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::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>
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>
166Result of a decoding; both a decoded data stream and <a class="el" href="classOgre_1_1Codec_1_1CodecData.html">CodecData</a> metadata.
167<p>
168
169<p>
170Definition 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>
171  </tr>
172</table>
173<hr><h2>Constructor &amp; Destructor Documentation</h2>
174<a class="anchor" name="Ogre_1_1ILImageCodeca0" doxytag="Ogre::ILImageCodec::ILImageCodec" ></a><p>
175<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
176  <tr>
177    <td class="mdRow">
178      <table cellpadding="0" cellspacing="0" border="0">
179        <tr>
180          <td class="md" nowrap valign="top"> Ogre::ILImageCodec::ILImageCodec </td>
181          <td class="md" valign="top">(&nbsp;</td>
182          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
183          <td class="mdname" nowrap> <em>type</em>, </td>
184        </tr>
185        <tr>
186          <td class="md" nowrap align="right"></td>
187          <td></td>
188          <td class="md" nowrap>unsigned int&nbsp;</td>
189          <td class="mdname" nowrap> <em>ilType</em></td>
190        </tr>
191        <tr>
192          <td></td>
193          <td class="md">)&nbsp;</td>
194          <td class="md" colspan="2"></td>
195        </tr>
196
197      </table>
198    </td>
199  </tr>
200</table>
201<table cellspacing=5 cellpadding=0 border=0>
202  <tr>
203    <td>
204      &nbsp;
205    </td>
206    <td>
207
208<p>
209    </td>
210  </tr>
211</table>
212<a class="anchor" name="Ogre_1_1ILImageCodeca1" doxytag="Ogre::ILImageCodec::~ILImageCodec" ></a><p>
213<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
214  <tr>
215    <td class="mdRow">
216      <table cellpadding="0" cellspacing="0" border="0">
217        <tr>
218          <td class="md" nowrap valign="top"> virtual Ogre::ILImageCodec::~<a class="el" href="classOgre_1_1ILImageCodec.html">ILImageCodec</a> </td>
219          <td class="md" valign="top">(&nbsp;</td>
220          <td class="mdname1" valign="top" nowrap>          </td>
221          <td class="md" valign="top">&nbsp;)&nbsp;</td>
222          <td class="md" nowrap><code> [virtual]</code></td>
223        </tr>
224
225      </table>
226    </td>
227  </tr>
228</table>
229<table cellspacing=5 cellpadding=0 border=0>
230  <tr>
231    <td>
232      &nbsp;
233    </td>
234    <td>
235
236<p>
237
238<p>
239Definition at line <a class="el" href="OgreILImageCodec_8h-source.html#l00046">46</a> of file <a class="el" href="OgreILImageCodec_8h-source.html">OgreILImageCodec.h</a>.    </td>
240  </tr>
241</table>
242<hr><h2>Member Function Documentation</h2>
243<a class="anchor" name="Ogre_1_1ILImageCodeca2" doxytag="Ogre::ILImageCodec::code" ></a><p>
244<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
245  <tr>
246    <td class="mdRow">
247      <table cellpadding="0" cellspacing="0" border="0">
248        <tr>
249          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1SharedPtr.html">DataStreamPtr</a> Ogre::ILImageCodec::code </td>
250          <td class="md" valign="top">(&nbsp;</td>
251          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1SharedPtr.html">MemoryDataStreamPtr</a> &amp;&nbsp;</td>
252          <td class="mdname" nowrap> <em>input</em>, </td>
253        </tr>
254        <tr>
255          <td class="md" nowrap align="right"></td>
256          <td></td>
257          <td class="md" nowrap><a class="el" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodecw0">CodecDataPtr</a> &amp;&nbsp;</td>
258          <td class="mdname" nowrap> <em>pData</em></td>
259        </tr>
260        <tr>
261          <td></td>
262          <td class="md">)&nbsp;</td>
263          <td class="md" colspan="2"> const<code> [virtual]</code></td>
264        </tr>
265
266      </table>
267    </td>
268  </tr>
269</table>
270<table cellspacing=5 cellpadding=0 border=0>
271  <tr>
272    <td>
273      &nbsp;
274    </td>
275    <td>
276
277<p>
278 
279<p>
280
281<p>
282Implements <a class="el" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodeca1">Ogre::Codec</a>.    </td>
283  </tr>
284</table>
285<a class="anchor" name="Ogre_1_1ILImageCodeca3" doxytag="Ogre::ILImageCodec::codeToFile" ></a><p>
286<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
287  <tr>
288    <td class="mdRow">
289      <table cellpadding="0" cellspacing="0" border="0">
290        <tr>
291          <td class="md" nowrap valign="top"> void Ogre::ILImageCodec::codeToFile </td>
292          <td class="md" valign="top">(&nbsp;</td>
293          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1SharedPtr.html">MemoryDataStreamPtr</a> &amp;&nbsp;</td>
294          <td class="mdname" nowrap> <em>input</em>, </td>
295        </tr>
296        <tr>
297          <td class="md" nowrap align="right"></td>
298          <td></td>
299          <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
300          <td class="mdname" nowrap> <em>outFileName</em>, </td>
301        </tr>
302        <tr>
303          <td class="md" nowrap align="right"></td>
304          <td></td>
305          <td class="md" nowrap><a class="el" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodecw0">CodecDataPtr</a> &amp;&nbsp;</td>
306          <td class="mdname" nowrap> <em>pData</em></td>
307        </tr>
308        <tr>
309          <td></td>
310          <td class="md">)&nbsp;</td>
311          <td class="md" colspan="2"> const<code> [virtual]</code></td>
312        </tr>
313
314      </table>
315    </td>
316  </tr>
317</table>
318<table cellspacing=5 cellpadding=0 border=0>
319  <tr>
320    <td>
321      &nbsp;
322    </td>
323    <td>
324
325<p>
326Provided for efficiency since coding to memory is progressive therefore memory required is unknown leading to reallocations. <dl compact><dt><b>Parameters:</b></dt><dd>
327  <table border="0" cellspacing="2" cellpadding="0">
328    <tr><td valign=top><em>input</em>&nbsp;</td><td>The input data </td></tr>
329    <tr><td valign=top><em>outFileName</em>&nbsp;</td><td>The filename to write to </td></tr>
330    <tr><td valign=top><em>pData</em>&nbsp;</td><td>Extra information to be passed to the codec (codec type specific)</td></tr>
331  </table>
332</dl>
333 
334<p>
335
336<p>
337Implements <a class="el" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodeca2">Ogre::Codec</a>.    </td>
338  </tr>
339</table>
340<a class="anchor" name="Ogre_1_1ILImageCodeca4" doxytag="Ogre::ILImageCodec::decode" ></a><p>
341<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
342  <tr>
343    <td class="mdRow">
344      <table cellpadding="0" cellspacing="0" border="0">
345        <tr>
346          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodecw1">DecodeResult</a> Ogre::ILImageCodec::decode </td>
347          <td class="md" valign="top">(&nbsp;</td>
348          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1SharedPtr.html">DataStreamPtr</a> &amp;&nbsp;</td>
349          <td class="mdname1" valign="top" nowrap> <em>input</em>          </td>
350          <td class="md" valign="top">&nbsp;)&nbsp;</td>
351          <td class="md" nowrap> const<code> [virtual]</code></td>
352        </tr>
353
354      </table>
355    </td>
356  </tr>
357</table>
358<table cellspacing=5 cellpadding=0 border=0>
359  <tr>
360    <td>
361      &nbsp;
362    </td>
363    <td>
364
365<p>
366<dl compact><dt><b>Parameters:</b></dt><dd>
367  <table border="0" cellspacing="2" cellpadding="0">
368    <tr><td valign=top><em>input</em>&nbsp;</td><td>Stream containing the encoded data </td></tr>
369  </table>
370</dl>
371<dl compact><dt><b>Note:</b></dt><dd>Has a variable number of arguments, which depend on the codec type.</dd></dl>
372 
373<p>
374
375<p>
376Implements <a class="el" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodeca3">Ogre::Codec</a>.    </td>
377  </tr>
378</table>
379<a class="anchor" name="Ogre_1_1ImageCodece2" doxytag="Ogre::ILImageCodec::getCodec" ></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"> <a class="el" href="classOgre_1_1Codec.html">Codec</a>* Ogre::Codec::getCodec </td>
386          <td class="md" valign="top">(&nbsp;</td>
387          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
388          <td class="mdname1" valign="top" nowrap> <em>extension</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>
405Gets the codec registered for the passed in file extension.
406<p>
407    </td>
408  </tr>
409</table>
410<a class="anchor" name="Ogre_1_1ILImageCodeca6" doxytag="Ogre::ILImageCodec::getType" ></a><p>
411<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
412  <tr>
413    <td class="mdRow">
414      <table cellpadding="0" cellspacing="0" border="0">
415        <tr>
416          <td class="md" nowrap valign="top"> virtual <a class="el" href="namespaceOgre.html#a426">String</a> Ogre::ILImageCodec::getType </td>
417          <td class="md" valign="top">(&nbsp;</td>
418          <td class="mdname1" valign="top" nowrap>          </td>
419          <td class="md" valign="top">&nbsp;)&nbsp;</td>
420          <td class="md" nowrap> const<code> [virtual]</code></td>
421        </tr>
422
423      </table>
424    </td>
425  </tr>
426</table>
427<table cellspacing=5 cellpadding=0 border=0>
428  <tr>
429    <td>
430      &nbsp;
431    </td>
432    <td>
433
434<p>
435Returns the type of the codec as a String.
436<p>
437
438<p>
439Implements <a class="el" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodeca4">Ogre::Codec</a>.    </td>
440  </tr>
441</table>
442<a class="anchor" name="Ogre_1_1ILImageCodeca5" doxytag="Ogre::ILImageCodec::initialiseIL" ></a><p>
443<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
444  <tr>
445    <td class="mdRow">
446      <table cellpadding="0" cellspacing="0" border="0">
447        <tr>
448          <td class="md" nowrap valign="top"> void Ogre::ILImageCodec::initialiseIL </td>
449          <td class="md" valign="top">(&nbsp;</td>
450          <td class="md" nowrap valign="top">void&nbsp;</td>
451          <td class="mdname1" valign="top" nowrap>          </td>
452          <td class="md" valign="top">&nbsp;)&nbsp;</td>
453          <td class="md" nowrap></td>
454        </tr>
455
456      </table>
457    </td>
458  </tr>
459</table>
460<table cellspacing=5 cellpadding=0 border=0>
461  <tr>
462    <td>
463      &nbsp;
464    </td>
465    <td>
466
467<p>
468Initialise DevIL.
469<p>
470    </td>
471  </tr>
472</table>
473<a class="anchor" name="Ogre_1_1ImageCodece0" doxytag="Ogre::ILImageCodec::registerCodec" ></a><p>
474<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
475  <tr>
476    <td class="mdRow">
477      <table cellpadding="0" cellspacing="0" border="0">
478        <tr>
479          <td class="md" nowrap valign="top"> void Ogre::Codec::registerCodec </td>
480          <td class="md" valign="top">(&nbsp;</td>
481          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1Codec.html">Codec</a> *&nbsp;</td>
482          <td class="mdname1" valign="top" nowrap> <em>pCodec</em>          </td>
483          <td class="md" valign="top">&nbsp;)&nbsp;</td>
484          <td class="md" nowrap><code> [static, inherited]</code></td>
485        </tr>
486
487      </table>
488    </td>
489  </tr>
490</table>
491<table cellspacing=5 cellpadding=0 border=0>
492  <tr>
493    <td>
494      &nbsp;
495    </td>
496    <td>
497
498<p>
499Registers a new codec in the database.
500<p>
501
502<p>
503Definition 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>.
504<p>
505References <a class="el" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodeca4">Ogre::Codec::getType()</a>.    </td>
506  </tr>
507</table>
508<a class="anchor" name="Ogre_1_1ImageCodece1" doxytag="Ogre::ILImageCodec::unRegisterCodec" ></a><p>
509<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
510  <tr>
511    <td class="mdRow">
512      <table cellpadding="0" cellspacing="0" border="0">
513        <tr>
514          <td class="md" nowrap valign="top"> void Ogre::Codec::unRegisterCodec </td>
515          <td class="md" valign="top">(&nbsp;</td>
516          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1Codec.html">Codec</a> *&nbsp;</td>
517          <td class="mdname1" valign="top" nowrap> <em>pCodec</em>          </td>
518          <td class="md" valign="top">&nbsp;)&nbsp;</td>
519          <td class="md" nowrap><code> [static, inherited]</code></td>
520        </tr>
521
522      </table>
523    </td>
524  </tr>
525</table>
526<table cellspacing=5 cellpadding=0 border=0>
527  <tr>
528    <td>
529      &nbsp;
530    </td>
531    <td>
532
533<p>
534Unregisters a codec from the database.
535<p>
536
537<p>
538Definition 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>.
539<p>
540References <a class="el" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodeca4">Ogre::Codec::getType()</a>.    </td>
541  </tr>
542</table>
543<hr><h2>Member Data Documentation</h2>
544<a class="anchor" name="Ogre_1_1ILImageCodecv0" doxytag="Ogre::ILImageCodec::_is_initialised" ></a><p>
545<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
546  <tr>
547    <td class="mdRow">
548      <table cellpadding="0" cellspacing="0" border="0">
549        <tr>
550          <td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1ILImageCodec.html#Ogre_1_1ILImageCodecv0">Ogre::ILImageCodec::_is_initialised</a><code> [static, private]</code>
551      </table>
552    </td>
553  </tr>
554</table>
555<table cellspacing=5 cellpadding=0 border=0>
556  <tr>
557    <td>
558      &nbsp;
559    </td>
560    <td>
561
562<p>
563
564<p>
565Definition at line <a class="el" href="OgreILImageCodec_8h-source.html#l00040">40</a> of file <a class="el" href="OgreILImageCodec_8h-source.html">OgreILImageCodec.h</a>.    </td>
566  </tr>
567</table>
568<a class="anchor" name="Ogre_1_1ILImageCodecr1" doxytag="Ogre::ILImageCodec::mIlType" ></a><p>
569<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
570  <tr>
571    <td class="mdRow">
572      <table cellpadding="0" cellspacing="0" border="0">
573        <tr>
574          <td class="md" nowrap valign="top"> unsigned int <a class="el" href="classOgre_1_1ILImageCodec.html#Ogre_1_1ILImageCodecr1">Ogre::ILImageCodec::mIlType</a><code> [private]</code>
575      </table>
576    </td>
577  </tr>
578</table>
579<table cellspacing=5 cellpadding=0 border=0>
580  <tr>
581    <td>
582      &nbsp;
583    </td>
584    <td>
585
586<p>
587
588<p>
589Definition at line <a class="el" href="OgreILImageCodec_8h-source.html#l00042">42</a> of file <a class="el" href="OgreILImageCodec_8h-source.html">OgreILImageCodec.h</a>.    </td>
590  </tr>
591</table>
592<a class="anchor" name="Ogre_1_1ImageCodect0" doxytag="Ogre::ILImageCodec::ms_mapCodecs" ></a><p>
593<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
594  <tr>
595    <td class="mdRow">
596      <table cellpadding="0" cellspacing="0" border="0">
597        <tr>
598          <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>
599      </table>
600    </td>
601  </tr>
602</table>
603<table cellspacing=5 cellpadding=0 border=0>
604  <tr>
605    <td>
606      &nbsp;
607    </td>
608    <td>
609
610<p>
611A map that contains all the registered codecs.
612<p>
613
614<p>
615Definition 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>
616  </tr>
617</table>
618<a class="anchor" name="Ogre_1_1ILImageCodecr0" doxytag="Ogre::ILImageCodec::mType" ></a><p>
619<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
620  <tr>
621    <td class="mdRow">
622      <table cellpadding="0" cellspacing="0" border="0">
623        <tr>
624          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a426">String</a> <a class="el" href="classOgre_1_1ILImageCodec.html#Ogre_1_1ILImageCodecr0">Ogre::ILImageCodec::mType</a><code> [private]</code>
625      </table>
626    </td>
627  </tr>
628</table>
629<table cellspacing=5 cellpadding=0 border=0>
630  <tr>
631    <td>
632      &nbsp;
633    </td>
634    <td>
635
636<p>
637
638<p>
639Definition at line <a class="el" href="OgreILImageCodec_8h-source.html#l00041">41</a> of file <a class="el" href="OgreILImageCodec_8h-source.html">OgreILImageCodec.h</a>.    </td>
640  </tr>
641</table>
642<hr>The documentation for this class was generated from the following file:<ul>
643<li><a class="el" href="OgreILImageCodec_8h-source.html">OgreILImageCodec.h</a></ul>
644<hr>
645<p>
646Copyright &copy; 2000-2005 by The OGRE Team<br />
647<!--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/>
648This 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/>
649                <!--/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#">
650                <Work rdf:about="">
651                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
652        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
653                </Work>
654                <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> -->
655
656Last modified Sun Feb 12 13:00:48 2006
657</p>
658</body>
659</html>
Note: See TracBrowser for help on using the repository browser.