<html>
<head>
<title>OgreHardwarePixelBuffer.h Source File - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link type="text/css" rel="stylesheet" href="style.css">
</head>
<body>
<!-- Generated by Doxygen 1.3.6 -->
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a> | <a class="qindex" href="pages.html">Related Pages</a></div>
<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>
00002 <span class="comment">-----------------------------------------------------------------------------</span>
00003 <span class="comment">This source file is part of OGRE</span>
00004 <span class="comment"> (Object-oriented Graphics Rendering Engine)</span>
00005 <span class="comment">For the latest info, see http://www.ogre3d.org/</span>
00006 <span class="comment"></span>
00007 <span class="comment">Copyright (c) 2000-2005 The OGRE Team</span>
00008 <span class="comment">Also see acknowledgements in Readme.html</span>
00009 <span class="comment"></span>
00010 <span class="comment">This program is free software; you can redistribute it and/or modify it under</span>
00011 <span class="comment">the terms of the GNU Lesser General Public License as published by the Free Software</span>
00012 <span class="comment">Foundation; either version 2 of the License, or (at your option) any later</span>
00013 <span class="comment">version.</span>
00014 <span class="comment"></span>
00015 <span class="comment">This program is distributed in the hope that it will be useful, but WITHOUT</span>
00016 <span class="comment">ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS</span>
00017 <span class="comment">FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.</span>
00018 <span class="comment"></span>
00019 <span class="comment">You should have received a copy of the GNU Lesser General Public License along with</span>
00020 <span class="comment">this program; if not, write to the Free Software Foundation, Inc., 59 Temple</span>
00021 <span class="comment">Place - Suite 330, Boston, MA 02111-1307, USA, or go to</span>
00022 <span class="comment">http://www.gnu.org/copyleft/lesser.txt.</span>
00023 <span class="comment">-----------------------------------------------------------------------------</span>
00024 <span class="comment">*/</span>
00025 <span class="preprocessor">#ifndef __HardwarePixelBuffer__</span>
00026 <span class="preprocessor"></span><span class="preprocessor">#define __HardwarePixelBuffer__</span>
00027 <span class="preprocessor"></span>
00028 <span class="comment">// Precompiler options</span>
00029 <span class="preprocessor">#include "<a class="code" href="OgrePrerequisites_8h.html">OgrePrerequisites.h</a>"</span>
00030 <span class="preprocessor">#include "<a class="code" href="OgreHardwareBuffer_8h.html">OgreHardwareBuffer.h</a>"</span>
00031 <span class="preprocessor">#include "<a class="code" href="OgreSharedPtr_8h.html">OgreSharedPtr.h</a>"</span>
00032 <span class="preprocessor">#include "<a class="code" href="OgrePixelFormat_8h.html">OgrePixelFormat.h</a>"</span>
00033 <span class="preprocessor">#include "<a class="code" href="OgreImage_8h.html">OgreImage.h</a>"</span>
00034
00035 <span class="keyword">namespace </span>Ogre {
<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#a13">_OgreExport</a> HardwarePixelBuffer : <span class="keyword">public</span> <a class="code" href="classOgre_1_1HardwareBuffer.html">HardwareBuffer</a>
00043 {
00044 <span class="keyword">protected</span>:
00045 <span class="comment">// Extents</span>
<a name="l00046"></a><a class="code" href="classOgre_1_1HardwarePixelBuffer.html#Ogre_1_1HardwarePixelBufferp0">00046</a> size_t mWidth, mHeight, mDepth;
00047 <span class="comment">// Pitches (offsets between rows and slices)</span>
<a name="l00048"></a><a class="code" href="classOgre_1_1HardwarePixelBuffer.html#Ogre_1_1HardwarePixelBufferp4">00048</a> size_t mRowPitch, mSlicePitch;
00049 <span class="comment">// Internal format</span>
<a name="l00050"></a><a class="code" href="classOgre_1_1HardwarePixelBuffer.html#Ogre_1_1HardwarePixelBufferp5">00050</a> <a class="code" href="namespaceOgre.html#a666">PixelFormat</a> mFormat;
00051 <span class="comment">// Currently locked region</span>
<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;
00053
00055 <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;
00056
00059 <span class="keyword">virtual</span> <span class="keywordtype">void</span>* lockImpl(size_t offset, size_t length, LockOptions options);
00060
00062 <span class="comment">// virtual void unlockImpl(void) = 0;</span>
00063 <span class="keyword">public</span>:
00065 HardwarePixelBuffer(size_t mWidth, size_t mHeight, size_t mDepth,
00066 PixelFormat mFormat,
00067 HardwareBuffer::Usage usage, <span class="keywordtype">bool</span> useSystemMemory, <span class="keywordtype">bool</span> useShadowBuffer);
00068 ~HardwarePixelBuffer();
00069
00073 <span class="keyword">using</span> HardwareBuffer::lock;
00074
00081 <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classOgre_1_1PixelBox.html">PixelBox</a>& lock(<span class="keyword">const</span> <a class="code" href="structOgre_1_1Box.html">Image::Box</a>& lockBox, LockOptions options);
00083 <span class="keyword">virtual</span> <span class="keywordtype">void</span>* lock(size_t offset, size_t length, LockOptions options);
00084
00089 <span class="keyword">const</span> <a class="code" href="classOgre_1_1PixelBox.html">PixelBox</a>& getCurrentLock();
00090
00092 <span class="keyword">virtual</span> <span class="keywordtype">void</span> readData(size_t offset, size_t length, <span class="keywordtype">void</span>* pDest);
00094 <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,
00095 <span class="keywordtype">bool</span> discardWholeBuffer = <span class="keyword">false</span>);
00096
00107 <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> &srcBox, <span class="keyword">const</span> <a class="code" href="structOgre_1_1Box.html">Image::Box</a> &dstBox);
00108
<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)
00115 {
00116 blit(src,
00117 <a class="code" href="structOgre_1_1Box.html">Box</a>(0,0,0,src-><a class="code" href="classOgre_1_1HardwarePixelBuffer.html#Ogre_1_1HardwarePixelBuffera13">getWidth</a>(),src-><a class="code" href="classOgre_1_1HardwarePixelBuffer.html#Ogre_1_1HardwarePixelBuffera14">getHeight</a>(),src-><a class="code" href="classOgre_1_1HardwarePixelBuffer.html#Ogre_1_1HardwarePixelBuffera15">getDepth</a>()),
00118 <a class="code" href="structOgre_1_1Box.html">Box</a>(0,0,0,mWidth,mHeight,mDepth)
00119 );
00120 }
00121
00131 <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> &src, <span class="keyword">const</span> <a class="code" href="structOgre_1_1Box.html">Image::Box</a> &dstBox) = 0;
00132
<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> &src)
00139 {
00140 blitFromMemory(src, <a class="code" href="structOgre_1_1Box.html">Box</a>(0,0,0,mWidth,mHeight,mDepth));
00141 }
00142
00150 <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> &srcBox, <span class="keyword">const</span> <a class="code" href="classOgre_1_1PixelBox.html">PixelBox</a> &dst) = 0;
00151
<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> &dst)
00158 {
00159 blitToMemory(<a class="code" href="structOgre_1_1Box.html">Box</a>(0,0,0,mWidth,mHeight,mDepth), dst);
00160 }
00161
<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; }
<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; }
<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; }
<a name="l00169"></a><a class="code" href="classOgre_1_1HardwarePixelBuffer.html#Ogre_1_1HardwarePixelBuffera16">00169</a> <a class="code" href="namespaceOgre.html#a666">PixelFormat</a> getFormat()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mFormat; }
00170 };
00171
<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><HardwarePixelBuffer>
00174 {
00175 <span class="keyword">public</span>:
<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><HardwarePixelBuffer>() {}
00177 <span class="keyword">explicit</span> HardwarePixelBufferSharedPtr(HardwarePixelBuffer* buf);
00178
00179
00180 };
00181
00182 }
00183 <span class="preprocessor">#endif</span>
00184 <span class="preprocessor"></span>
</pre></div><p>
Copyright © 2000-2005 by The OGRE Team<br />
Last modified Wed Feb 23 00:19:07 2005
</p>
</body>
</html>
distrib
>
Mandriva
>
10.2
>
i586
>
media
>
contrib
>
by-pkgid
>
04e5d8c10ae76748689b4e7f48e0fa33
>
files
>
544
