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

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

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>OgreHardwarePixelBuffer.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>OgreHardwarePixelBuffer.h</h1><a href="OgreHardwarePixelBuffer_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 __HardwarePixelBuffer__</span>
3500026 <span class="preprocessor"></span><span class="preprocessor">#define __HardwarePixelBuffer__</span>
3600027 <span class="preprocessor"></span>
3700028 <span class="comment">// Precompiler options</span>
3800029 <span class="preprocessor">#include "<a class="code" href="OgrePrerequisites_8h.html">OgrePrerequisites.h</a>"</span>
3900030 <span class="preprocessor">#include "<a class="code" href="OgreHardwareBuffer_8h.html">OgreHardwareBuffer.h</a>"</span>
4000031 <span class="preprocessor">#include "<a class="code" href="OgreSharedPtr_8h.html">OgreSharedPtr.h</a>"</span>
4100032 <span class="preprocessor">#include "<a class="code" href="OgrePixelFormat_8h.html">OgrePixelFormat.h</a>"</span>
4200033 <span class="preprocessor">#include "<a class="code" href="OgreImage_8h.html">OgreImage.h</a>"</span>
4300034
4400035 <span class="keyword">namespace </span>Ogre {
45<a name="l00042"></a><a class="code" href="classOgre_1_1HardwarePixelBuffer.html">00042</a>     <span class="keyword">class </span><a class="code" href="OgrePlatform_8h.html#a16">_OgreExport</a> HardwarePixelBuffer : <span class="keyword">public</span> <a class="code" href="classOgre_1_1HardwareBuffer.html">HardwareBuffer</a>
4600043     {
4700044     <span class="keyword">protected</span>:
4800045         <span class="comment">// Extents</span>
49<a name="l00046"></a><a class="code" href="classOgre_1_1HardwarePixelBuffer.html#Ogre_1_1HardwarePixelBufferp0">00046</a>         size_t mWidth, mHeight, mDepth;
5000047         <span class="comment">// Pitches (offsets between rows and slices)</span>
51<a name="l00048"></a><a class="code" href="classOgre_1_1HardwarePixelBuffer.html#Ogre_1_1HardwarePixelBufferp4">00048</a>         size_t mRowPitch, mSlicePitch;
5200049         <span class="comment">// Internal format</span>
53<a name="l00050"></a><a class="code" href="classOgre_1_1HardwarePixelBuffer.html#Ogre_1_1HardwarePixelBufferp5">00050</a>         <a class="code" href="namespaceOgre.html#a667">PixelFormat</a> mFormat;
5400051         <span class="comment">// Currently locked region</span>
55<a name="l00052"></a><a class="code" href="classOgre_1_1HardwarePixelBuffer.html#Ogre_1_1HardwarePixelBufferp6">00052</a>         <a class="code" href="classOgre_1_1PixelBox.html">PixelBox</a> mCurrentLock;
5600053         
5700055         <span class="keyword">virtual</span> <a class="code" href="classOgre_1_1PixelBox.html">PixelBox</a> lockImpl(<span class="keyword">const</span> <a class="code" href="structOgre_1_1Box.html">Image::Box</a> lockBox,  LockOptions options) = 0;
5800056
5900059         <span class="keyword">virtual</span> <span class="keywordtype">void</span>* lockImpl(size_t offset, size_t length, LockOptions options);
6000060
6100062         <span class="comment">// virtual void unlockImpl(void) = 0;</span>
6200063     <span class="keyword">public</span>:
6300065         HardwarePixelBuffer(size_t mWidth, size_t mHeight, size_t mDepth,
6400066                 PixelFormat mFormat,
6500067                 HardwareBuffer::Usage usage, <span class="keywordtype">bool</span> useSystemMemory, <span class="keywordtype">bool</span> useShadowBuffer);
6600068         ~HardwarePixelBuffer();
6700069
6800073         <span class="keyword">using</span> HardwareBuffer::lock;
6900074
7000081         <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classOgre_1_1PixelBox.html">PixelBox</a>&amp; lock(<span class="keyword">const</span> <a class="code" href="structOgre_1_1Box.html">Image::Box</a>&amp; lockBox, LockOptions options);
7100083         <span class="keyword">virtual</span> <span class="keywordtype">void</span>* lock(size_t offset, size_t length, LockOptions options);
7200084
7300089         <span class="keyword">const</span> <a class="code" href="classOgre_1_1PixelBox.html">PixelBox</a>&amp; getCurrentLock();
7400090         
7500092         <span class="keyword">virtual</span> <span class="keywordtype">void</span> readData(size_t offset, size_t length, <span class="keywordtype">void</span>* pDest);
7600094         <span class="keyword">virtual</span> <span class="keywordtype">void</span> writeData(size_t offset, size_t length, <span class="keyword">const</span> <span class="keywordtype">void</span>* pSource,
7700095                 <span class="keywordtype">bool</span> discardWholeBuffer = <span class="keyword">false</span>);
7800096         
7900107         <span class="keyword">virtual</span> <span class="keywordtype">void</span> blit(HardwarePixelBuffer *src, <span class="keyword">const</span> <a class="code" href="structOgre_1_1Box.html">Image::Box</a> &amp;srcBox, <span class="keyword">const</span> <a class="code" href="structOgre_1_1Box.html">Image::Box</a> &amp;dstBox);
8000108
81<a name="l00114"></a><a class="code" href="classOgre_1_1HardwarePixelBuffer.html#Ogre_1_1HardwarePixelBuffera8">00114</a>         <span class="keywordtype">void</span> blit(HardwarePixelBuffer *src)
8200115         {
8300116             blit(src,
8400117                 <a class="code" href="structOgre_1_1Box.html">Box</a>(0,0,0,src-&gt;<a class="code" href="classOgre_1_1HardwarePixelBuffer.html#Ogre_1_1HardwarePixelBuffera13">getWidth</a>(),src-&gt;<a class="code" href="classOgre_1_1HardwarePixelBuffer.html#Ogre_1_1HardwarePixelBuffera14">getHeight</a>(),src-&gt;<a class="code" href="classOgre_1_1HardwarePixelBuffer.html#Ogre_1_1HardwarePixelBuffera15">getDepth</a>()),
8500118                 <a class="code" href="structOgre_1_1Box.html">Box</a>(0,0,0,mWidth,mHeight,mDepth)
8600119             );
8700120         }
8800121         
8900131         <span class="keyword">virtual</span> <span class="keywordtype">void</span> blitFromMemory(<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="structOgre_1_1Box.html">Image::Box</a> &amp;dstBox) = 0;
9000132         
91<a name="l00138"></a><a class="code" href="classOgre_1_1HardwarePixelBuffer.html#Ogre_1_1HardwarePixelBuffera10">00138</a>         <span class="keywordtype">void</span> blitFromMemory(<span class="keyword">const</span> <a class="code" href="classOgre_1_1PixelBox.html">PixelBox</a> &amp;src)
9200139         {
9300140             blitFromMemory(src, <a class="code" href="structOgre_1_1Box.html">Box</a>(0,0,0,mWidth,mHeight,mDepth));
9400141         }
9500142         
9600150         <span class="keyword">virtual</span> <span class="keywordtype">void</span> blitToMemory(<span class="keyword">const</span> <a class="code" href="structOgre_1_1Box.html">Image::Box</a> &amp;srcBox, <span class="keyword">const</span> <a class="code" href="classOgre_1_1PixelBox.html">PixelBox</a> &amp;dst) = 0;
9700151
98<a name="l00157"></a><a class="code" href="classOgre_1_1HardwarePixelBuffer.html#Ogre_1_1HardwarePixelBuffera12">00157</a>         <span class="keywordtype">void</span> blitToMemory(<span class="keyword">const</span> <a class="code" href="classOgre_1_1PixelBox.html">PixelBox</a> &amp;dst)
9900158         {
10000159             blitToMemory(<a class="code" href="structOgre_1_1Box.html">Box</a>(0,0,0,mWidth,mHeight,mDepth), dst);
10100160         }
10200161         
103<a name="l00163"></a><a class="code" href="classOgre_1_1HardwarePixelBuffer.html#Ogre_1_1HardwarePixelBuffera13">00163</a>         size_t getWidth()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mWidth; }
104<a name="l00165"></a><a class="code" href="classOgre_1_1HardwarePixelBuffer.html#Ogre_1_1HardwarePixelBuffera14">00165</a>         size_t getHeight()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mHeight; }
105<a name="l00167"></a><a class="code" href="classOgre_1_1HardwarePixelBuffer.html#Ogre_1_1HardwarePixelBuffera15">00167</a>         size_t getDepth()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mDepth; }
106<a name="l00169"></a><a class="code" href="classOgre_1_1HardwarePixelBuffer.html#Ogre_1_1HardwarePixelBuffera16">00169</a>         <a class="code" href="namespaceOgre.html#a667">PixelFormat</a> getFormat()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mFormat; }
10700170     };
10800171
109<a name="l00173"></a><a class="code" href="classOgre_1_1HardwarePixelBufferSharedPtr.html">00173</a>     <span class="keyword">class </span><a class="code" href="class__OgreExport.html">_OgreExport</a> HardwarePixelBufferSharedPtr : <span class="keyword">public</span> <a class="code" href="classOgre_1_1SharedPtr.html">SharedPtr</a>&lt;HardwarePixelBuffer&gt;
11000174     {
11100175     <span class="keyword">public</span>:
112<a name="l00176"></a><a class="code" href="classOgre_1_1HardwarePixelBufferSharedPtr.html#Ogre_1_1HardwarePixelBufferSharedPtra0">00176</a>         HardwarePixelBufferSharedPtr() : <a class="code" href="classOgre_1_1SharedPtr.html">SharedPtr</a>&lt;HardwarePixelBuffer&gt;() {}
11300177         <span class="keyword">explicit</span> HardwarePixelBufferSharedPtr(HardwarePixelBuffer* buf);
11400178
11500179
11600180     };
11700181
11800182 }
11900183 <span class="preprocessor">#endif</span>
12000184 <span class="preprocessor"></span>
121</pre></div><hr>
122<p>
123Copyright &copy; 2000-2005 by The OGRE Team<br />
124<!--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/>
125This 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/>
126                <!--/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#">
127                <Work rdf:about="">
128                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
129        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
130                </Work>
131                <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> -->
132
133Last modified Sun Feb 12 12:59:46 2006
134</p>
135</body>
136</html>
Note: See TracBrowser for help on using the repository browser.