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

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

adding ogre 1.2 and dependencies
Line 
1<html>
2<head>
3<title>OgreCodec.h Source File - 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>OgreCodec.h</h1><a href="OgreCodec_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <span class="comment">/*</span>
1100002 <span class="comment">-----------------------------------------------------------------------------</span>
1200003 <span class="comment">This source file is part of OGRE</span>
1300004 <span class="comment">(Object-oriented Graphics Rendering Engine)</span>
1400005 <span class="comment">For the latest info, see http://www.ogre3d.org/</span>
1500006 <span class="comment"></span>
1600007 <span class="comment">Copyright (c) 2000-2005 The OGRE Team</span>
1700008 <span class="comment">Also see acknowledgements in Readme.html</span>
1800009 <span class="comment"></span>
1900010 <span class="comment">This program is free software; you can redistribute it and/or modify it under</span>
2000011 <span class="comment">the terms of the GNU Lesser General Public License as published by the Free Software</span>
2100012 <span class="comment">Foundation; either version 2 of the License, or (at your option) any later</span>
2200013 <span class="comment">version.</span>
2300014 <span class="comment"></span>
2400015 <span class="comment">This program is distributed in the hope that it will be useful, but WITHOUT</span>
2500016 <span class="comment">ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS</span>
2600017 <span class="comment">FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.</span>
2700018 <span class="comment"></span>
2800019 <span class="comment">You should have received a copy of the GNU Lesser General Public License along with</span>
2900020 <span class="comment">this program; if not, write to the Free Software Foundation, Inc., 59 Temple</span>
3000021 <span class="comment">Place - Suite 330, Boston, MA 02111-1307, USA, or go to</span>
3100022 <span class="comment">http://www.gnu.org/copyleft/lesser.txt.</span>
3200023 <span class="comment">-----------------------------------------------------------------------------</span>
3300024 <span class="comment">*/</span>
3400025 <span class="preprocessor">#ifndef _Codec_H__</span>
3500026 <span class="preprocessor"></span><span class="preprocessor">#define _Codec_H__</span>
3600027 <span class="preprocessor"></span>
3700028 <span class="preprocessor">#include "<a class="code" href="OgrePrerequisites_8h.html">OgrePrerequisites.h</a>"</span>
3800029 <span class="preprocessor">#include "<a class="code" href="OgreSharedPtr_8h.html">OgreSharedPtr.h</a>"</span>
3900030 <span class="preprocessor">#include "<a class="code" href="OgreDataStream_8h.html">OgreDataStream.h</a>"</span>
4000031 <span class="preprocessor">#include "<a class="code" href="OgreIteratorWrappers_8h.html">OgreIteratorWrappers.h</a>"</span>
4100032 <span class="preprocessor">#include "<a class="code" href="OgreStringVector_8h.html">OgreStringVector.h</a>"</span>
4200033
4300034 <span class="keyword">namespace </span>Ogre {
4400035
45<a name="l00045"></a><a class="code" href="classOgre_1_1Codec.html">00045</a>     <span class="keyword">class </span><a class="code" href="OgrePlatform_8h.html#a16">_OgreExport</a> Codec
4600046     {
4700047     <span class="keyword">protected</span>:
48<a name="l00048"></a><a class="code" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodecx0">00048</a>         <span class="keyword">typedef</span> std::map&lt; String, Codec* &gt; <a class="code" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodecx0">CodecList</a>;
49<a name="l00051"></a><a class="code" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodect0">00051</a>         <span class="keyword">static</span> <a class="code" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodecx0">CodecList</a> ms_mapCodecs;
5000052
5100053     <span class="keyword">public</span>:
52<a name="l00054"></a><a class="code" href="classOgre_1_1Codec_1_1CodecData.html">00054</a>         <span class="keyword">class </span><a class="code" href="OgrePlatform_8h.html#a17">_OgrePrivate</a> CodecData
5300055         {
5400056         <span class="keyword">public</span>:
55<a name="l00057"></a><a class="code" href="classOgre_1_1Codec_1_1CodecData.html#Ogre_1_1Codec_1_1CodecDataa0">00057</a>             <span class="keyword">virtual</span> ~CodecData() {};
5600058
57<a name="l00061"></a><a class="code" href="classOgre_1_1Codec_1_1CodecData.html#Ogre_1_1Codec_1_1CodecDataa1">00061</a>             <span class="keyword">virtual</span> <a class="code" href="namespaceOgre.html#a471">String</a> dataType()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="stringliteral">"CodecData"</span>; };
5800062         };
59<a name="l00063"></a><a class="code" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodecw0">00063</a>         <span class="keyword">typedef</span> <a class="code" href="classOgre_1_1SharedPtr.html">SharedPtr&lt;CodecData&gt;</a> <a class="code" href="classOgre_1_1SharedPtr.html">CodecDataPtr</a>;
6000064
61<a name="l00065"></a><a class="code" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodecw1">00065</a>         <span class="keyword">typedef</span> <a class="code" href="classOgre_1_1ConstMapIterator.html">ConstMapIterator&lt;CodecList&gt;</a> <a class="code" href="classOgre_1_1ConstMapIterator.html">CodecIterator</a>;
6200066
6300067     <span class="keyword">public</span>:
6400068         <span class="keyword">virtual</span> ~Codec();
6500069         
66<a name="l00072"></a><a class="code" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodece0">00072</a>         <span class="keyword">static</span> <span class="keywordtype">void</span> registerCodec( Codec *pCodec )
6700073         {
6800074             ms_mapCodecs[pCodec-&gt;<a class="code" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodeca5">getType</a>()] = pCodec;
6900075         }
7000076
71<a name="l00079"></a><a class="code" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodece1">00079</a>         <span class="keyword">static</span> <span class="keywordtype">void</span> unRegisterCodec( Codec *pCodec )
7200080         {
7300081             ms_mapCodecs.erase(pCodec-&gt;<a class="code" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodeca5">getType</a>());
7400082         }
7500083
76<a name="l00085"></a><a class="code" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodece2">00085</a>         <span class="keyword">static</span> <a class="code" href="classOgre_1_1ConstMapIterator.html">CodecIterator</a> getCodecIterator(<span class="keywordtype">void</span>)
7700086         {
7800087             <span class="keywordflow">return</span> <a class="code" href="classOgre_1_1ConstMapIterator.html">CodecIterator</a>(ms_mapCodecs.begin(), ms_mapCodecs.end());
7900088         }
8000089
8100091         <span class="keyword">static</span> <a class="code" href="namespaceOgre.html#a580">StringVector</a> getExtensions(<span class="keywordtype">void</span>);
8200092
8300094         <span class="keyword">static</span> Codec* getCodec(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; extension);
8400095
8500099         <span class="keyword">virtual</span> <a class="code" href="classOgre_1_1SharedPtr.html">DataStreamPtr</a> code(<a class="code" href="classOgre_1_1SharedPtr.html">MemoryDataStreamPtr</a>&amp; input, CodecDataPtr&amp; pData) <span class="keyword">const</span> = 0;
8600107         <span class="keyword">virtual</span> <span class="keywordtype">void</span> codeToFile(<a class="code" href="classOgre_1_1SharedPtr.html">MemoryDataStreamPtr</a>&amp; input, <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; outFileName, CodecDataPtr&amp; pData) <span class="keyword">const</span> = 0;
8700108
88<a name="l00110"></a><a class="code" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodecw2">00110</a>         <span class="keyword">typedef</span> std::pair&lt;MemoryDataStreamPtr, CodecDataPtr&gt; <a class="code" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodecw2">DecodeResult</a>;
8900116         <span class="keyword">virtual</span> <a class="code" href="classOgre_1_1Codec.html#Ogre_1_1ImageCodecw2">DecodeResult</a> decode(<a class="code" href="classOgre_1_1SharedPtr.html">DataStreamPtr</a>&amp; input) <span class="keyword">const</span> = 0;
9000117
9100120         <span class="keyword">virtual</span> <a class="code" href="namespaceOgre.html#a471">String</a> getType() <span class="keyword">const</span> = 0;
9200121
9300124         <span class="keyword">virtual</span> <a class="code" href="namespaceOgre.html#a471">String</a> getDataType() <span class="keyword">const</span> = 0;
9400125     };
9500126
9600127 } <span class="comment">// namespace</span>
9700128
9800129 <span class="preprocessor">#endif</span>
99</pre></div><hr>
100<p>
101Copyright &copy; 2000-2005 by The OGRE Team<br />
102<!--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/>
103This 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/>
104                <!--/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#">
105                <Work rdf:about="">
106                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
107        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
108                </Work>
109                <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> -->
110
111Last modified Sun Mar 12 14:37:38 2006
112</p>
113</body>
114</html>
Note: See TracBrowser for help on using the repository browser.