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

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

adding ogre 1.2 and dependencies
Line 
1<html>
2<head>
3<title>OgreImage.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>OgreImage.h</h1><a href="OgreImage_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 _Image_H__</span>
3500026 <span class="preprocessor"></span><span class="preprocessor">#define _Image_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="OgreCommon_8h.html">OgreCommon.h</a>"</span>
3900030 <span class="preprocessor">#include "<a class="code" href="OgrePixelFormat_8h.html">OgrePixelFormat.h</a>"</span>
4000031 <span class="preprocessor">#include "<a class="code" href="OgreDataStream_8h.html">OgreDataStream.h</a>"</span>
4100032
4200033 <span class="keyword">namespace </span>Ogre {
4300034
44<a name="l00035"></a><a class="code" href="namespaceOgre.html#a661">00035</a>     <span class="keyword">enum</span> <a class="code" href="namespaceOgre.html#a661">ImageFlags</a>
4500036     {
4600037         <a class="code" href="namespaceOgre.html#a661a188">IF_COMPRESSED</a> = 0x00000001,
4700038         <a class="code" href="namespaceOgre.html#a661a189">IF_CUBEMAP</a>    = 0x00000002,
4800039         <a class="code" href="namespaceOgre.html#a661a190">IF_3D_TEXTURE</a> = 0x00000004
4900040     };
50<a name="l00052"></a><a class="code" href="classOgre_1_1Image.html">00052</a>     <span class="keyword">class </span><a class="code" href="OgrePlatform_8h.html#a16">_OgreExport</a> Image
5100053     {
5200054     <span class="keyword">public</span>:
53<a name="l00055"></a><a class="code" href="classOgre_1_1Image.html#Ogre_1_1Imagew0">00055</a>         <span class="keyword">typedef</span> <a class="code" href="structOgre_1_1Box.html">Ogre::Box</a> <a class="code" href="structOgre_1_1Box.html">Box</a>;
54<a name="l00056"></a><a class="code" href="classOgre_1_1Image.html#Ogre_1_1Imagew1">00056</a>         <span class="keyword">typedef</span> <a class="code" href="structOgre_1_1TRect.html">Ogre::Rect</a> <a class="code" href="structOgre_1_1TRect.html">Rect</a>;
5500057     <span class="keyword">public</span>:
5600060         Image();
5700063         Image( <span class="keyword">const</span> Image &amp;img );
5800064
5900067         <span class="keyword">virtual</span> ~Image();
6000068
6100071         Image &amp; operator = ( <span class="keyword">const</span> Image &amp; img );
6200072
6300092         Image &amp; flipAroundY();
6400093
6500108         Image &amp; flipAroundX();
6600109
6700139         Image&amp; loadDynamicImage( <a class="code" href="namespaceOgre.html#a466">uchar</a>* pData, size_t uWidth, size_t uHeight,
6800140                             size_t depth,
6900141                              PixelFormat eFormat, <span class="keywordtype">bool</span> autoDelete = <span class="keyword">false</span>,
7000142                              size_t numFaces = 1, size_t numMipMaps = 0);
7100143         
72<a name="l00165"></a><a class="code" href="classOgre_1_1Image.html#Ogre_1_1Imagea7">00165</a>         Image&amp; loadDynamicImage( <a class="code" href="namespaceOgre.html#a466">uchar</a>* pData, size_t uWidth,
7300166                                  size_t uHeight, PixelFormat eFormat)
7400167         {
7500168             <span class="keywordflow">return</span> loadDynamicImage(pData, uWidth, uHeight, 1, eFormat);
7600169         }
7700175         Image &amp; loadRawData(
7800176             <a class="code" href="classOgre_1_1SharedPtr.html">DataStreamPtr</a>&amp; stream,
7900177             size_t uWidth, size_t uHeight, size_t uDepth,
8000178             PixelFormat eFormat,
8100179             size_t numFaces = 1, size_t numMipMaps = 0);
82<a name="l00185"></a><a class="code" href="classOgre_1_1Image.html#Ogre_1_1Imagea9">00185</a>         Image &amp; loadRawData(
8300186             <a class="code" href="classOgre_1_1SharedPtr.html">DataStreamPtr</a>&amp; stream,
8400187             size_t uWidth, size_t uHeight,
8500188             PixelFormat eFormat )
8600189         {
8700190             <span class="keywordflow">return</span> loadRawData(stream, uWidth, uHeight, 1, eFormat);
8800191         }
8900192
9000207         Image &amp; load( <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; strFileName, <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; groupName );
9100208
9200223         Image &amp; load(<a class="code" href="classOgre_1_1SharedPtr.html">DataStreamPtr</a>&amp; stream, <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; type );
9300224         
9400226         <span class="keywordtype">void</span> save(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; filename);
9500227
9600230         <a class="code" href="namespaceOgre.html#a466">uchar</a>* getData(<span class="keywordtype">void</span>);
9700231
9800234         <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a466">uchar</a> * getData() <span class="keyword">const</span>;       
9900235
10000238         size_t getSize() <span class="keyword">const</span>;
10100239
10200242         size_t getNumMipmaps() <span class="keyword">const</span>;
10300243
10400246         <span class="keywordtype">bool</span> hasFlag(<span class="keyword">const</span> ImageFlags imgFlag) <span class="keyword">const</span>;
10500247
10600250         size_t getWidth(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
10700251
10800254         size_t getHeight(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
10900255
11000258         size_t getDepth(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
11100259         
11200263         size_t getNumFaces(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
11300264
11400267         size_t getRowSpan(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
11500268
11600271         <a class="code" href="namespaceOgre.html#a671">PixelFormat</a> getFormat() <span class="keyword">const</span>;
11700272
11800275         <a class="code" href="namespaceOgre.html#a466">uchar</a> getBPP() <span class="keyword">const</span>;
11900276
12000279         <span class="keywordtype">bool</span> getHasAlpha() <span class="keyword">const</span>;
12100280         
12200286         <span class="keyword">static</span> <span class="keywordtype">void</span> applyGamma( <a class="code" href="namespaceOgre.html#a466">uchar</a> *buffer, <a class="code" href="namespaceOgre.html#a465">Real</a> gamma, size_t size, <a class="code" href="namespaceOgre.html#a466">uchar</a> bpp );
12300287
12400293         <a class="code" href="classOgre_1_1ColourValue.html">ColourValue</a> getColourAt(<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y, <span class="keywordtype">int</span> z);
12500294         
12600298         <a class="code" href="classOgre_1_1PixelBox.html">PixelBox</a> getPixelBox(size_t face = 0, size_t mipmap = 0) <span class="keyword">const</span>;
12700299
128<a name="l00300"></a><a class="code" href="classOgre_1_1Image.html#Ogre_1_1Imagew8">00300</a>         <span class="keyword">enum</span> Filter
12900301         {
13000302             FILTER_NEAREST,
13100303             FILTER_LINEAR,
13200304             FILTER_BILINEAR,
13300305             FILTER_BOX,
13400306             FILTER_TRIANGLE,
13500307             FILTER_BICUBIC
13600308         };
13700316         <span class="keyword">static</span> <span class="keywordtype">void</span> scale(<span class="keyword">const</span> <a class="code" href="classOgre_1_1PixelBox.html">PixelBox</a> &amp;src, <span class="keyword">const</span> <a class="code" href="classOgre_1_1PixelBox.html">PixelBox</a> &amp;dst, Filter filter = FILTER_BILINEAR);
13800317         
13900319         <span class="keywordtype">void</span> resize(<a class="code" href="namespaceOgre.html#a467">ushort</a> width, <a class="code" href="namespaceOgre.html#a467">ushort</a> height, Filter filter = FILTER_BILINEAR);
14000320         
14100321         <span class="comment">// Static function to calculate size in bytes from the number of mipmaps, faces and the dimensions</span>
14200322         <span class="keyword">static</span> size_t calculateSize(size_t mipmaps, size_t faces, size_t width, size_t height, size_t depth, PixelFormat format);
14300323     <span class="keyword">private</span>:
14400324         <span class="comment">// The width of the image in pixels</span>
145<a name="l00325"></a><a class="code" href="classOgre_1_1Image.html#Ogre_1_1Imager0">00325</a>         size_t m_uWidth;
14600326         <span class="comment">// The height of the image in pixels</span>
147<a name="l00327"></a><a class="code" href="classOgre_1_1Image.html#Ogre_1_1Imager1">00327</a>         size_t m_uHeight;
14800328         <span class="comment">// The depth of the image</span>
149<a name="l00329"></a><a class="code" href="classOgre_1_1Image.html#Ogre_1_1Imager2">00329</a>         size_t m_uDepth;
15000330         <span class="comment">// The size of the image buffer</span>
151<a name="l00331"></a><a class="code" href="classOgre_1_1Image.html#Ogre_1_1Imager3">00331</a>         size_t m_uSize;
15200332         <span class="comment">// The number of mipmaps the image contains</span>
153<a name="l00333"></a><a class="code" href="classOgre_1_1Image.html#Ogre_1_1Imager4">00333</a>         size_t m_uNumMipmaps;
15400334         <span class="comment">// Image specific flags.</span>
155<a name="l00335"></a><a class="code" href="classOgre_1_1Image.html#Ogre_1_1Imager5">00335</a>         <span class="keywordtype">int</span> m_uFlags;
15600336
15700337         <span class="comment">// The pixel format of the image</span>
158<a name="l00338"></a><a class="code" href="classOgre_1_1Image.html#Ogre_1_1Imager6">00338</a>         <a class="code" href="namespaceOgre.html#a671">PixelFormat</a> m_eFormat;
15900339
16000340         <span class="comment">// The number of bytes per pixel</span>
161<a name="l00341"></a><a class="code" href="classOgre_1_1Image.html#Ogre_1_1Imager7">00341</a>         <a class="code" href="namespaceOgre.html#a466">uchar</a> m_ucPixelSize;
162<a name="l00342"></a><a class="code" href="classOgre_1_1Image.html#Ogre_1_1Imager8">00342</a>         <a class="code" href="namespaceOgre.html#a466">uchar</a>* m_pBuffer;
16300343
16400344         <span class="comment">// A bool to determine if we delete the buffer or the calling app does</span>
165<a name="l00345"></a><a class="code" href="classOgre_1_1Image.html#Ogre_1_1Imager9">00345</a>         <span class="keywordtype">bool</span> m_bAutoDelete;
16600346     };
16700347
16800348 } <span class="comment">// namespace</span>
16900349
17000350 <span class="preprocessor">#endif</span>
171</pre></div><hr>
172<p>
173Copyright &copy; 2000-2005 by The OGRE Team<br />
174<!--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/>
175This 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/>
176                <!--/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#">
177                <Work rdf:about="">
178                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
179        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
180                </Work>
181                <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> -->
182
183Last modified Sun Mar 12 14:37:42 2006
184</p>
185</body>
186</html>
Note: See TracBrowser for help on using the repository browser.