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

Revision 692, 16.9 KB checked in by mattausch, 18 years ago (diff)

adding ogre 1.2 and dependencies
Line 
1<html>
2<head>
3<title>OgreGLHardwarePixelBuffer.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>OgreGLHardwarePixelBuffer.h</h1><a href="OgreGLHardwarePixelBuffer_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 __GLPIXELBUFFER_H__</span>
3500026 <span class="preprocessor"></span><span class="preprocessor">#define __GLPIXELBUFFER_H__</span>
3600027 <span class="preprocessor"></span>
3700028 <span class="preprocessor">#include "<a class="code" href="OgreGLPrerequisites_8h.html">OgreGLPrerequisites.h</a>"</span>
3800029 <span class="preprocessor">#include "<a class="code" href="OgreHardwarePixelBuffer_8h.html">OgreHardwarePixelBuffer.h</a>"</span>
3900030
4000031 <span class="keyword">namespace </span>Ogre {
41<a name="l00032"></a><a class="code" href="classOgre_1_1GLHardwarePixelBuffer.html">00032</a>     <span class="keyword">class </span><a class="code" href="classOgre_1_1GLHardwarePixelBuffer.html">GLHardwarePixelBuffer</a>: <span class="keyword">public</span> <a class="code" href="classOgre_1_1HardwarePixelBuffer.html">HardwarePixelBuffer</a>
4200033     {
4300034     <span class="keyword">protected</span>: 
4400036         <a class="code" href="classOgre_1_1PixelBox.html">PixelBox</a> <a class="code" href="classOgre_1_1GLHardwarePixelBuffer.html#Ogre_1_1GLTextureBufferb0">lockImpl</a>(<span class="keyword">const</span> <a class="code" href="structOgre_1_1Box.html">Image::Box</a> lockBox,  LockOptions options);
4500037
4600039         <span class="keywordtype">void</span> <a class="code" href="classOgre_1_1GLHardwarePixelBuffer.html#Ogre_1_1GLTextureBufferb2">unlockImpl</a>(<span class="keywordtype">void</span>);
4700040         
4800041         <span class="comment">// Internal buffer; either on-card or in system memory, freed/allocated on demand</span>
4900042         <span class="comment">// depending on buffer usage</span>
50<a name="l00043"></a><a class="code" href="classOgre_1_1GLHardwarePixelBuffer.html#Ogre_1_1GLTextureBufferp7">00043</a>         <a class="code" href="classOgre_1_1PixelBox.html">PixelBox</a> mBuffer;
51<a name="l00044"></a><a class="code" href="classOgre_1_1GLHardwarePixelBuffer.html#Ogre_1_1GLTextureBufferp8">00044</a>         GLenum <a class="code" href="classOgre_1_1GLHardwarePixelBuffer.html#Ogre_1_1GLTextureBufferp8">mGLInternalFormat</a>; <span class="comment">// GL internal format</span>
5200045         
5300046         <span class="comment">// Buffer allocation/freeage</span>
5400047         <span class="keywordtype">void</span> <a class="code" href="classOgre_1_1GLHardwarePixelBuffer.html#Ogre_1_1GLTextureBufferb3">allocateBuffer</a>();
5500048         <span class="keywordtype">void</span> <a class="code" href="classOgre_1_1GLHardwarePixelBuffer.html#Ogre_1_1GLTextureBufferb4">freeBuffer</a>();
5600049         <span class="comment">// Upload a box of pixels to this buffer on the card</span>
5700050         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classOgre_1_1GLHardwarePixelBuffer.html#Ogre_1_1GLRenderBufferb5">upload</a>(<span class="keyword">const</span> <a class="code" href="classOgre_1_1PixelBox.html">PixelBox</a> &amp;data);
5800051         <span class="comment">// Download a box of pixels from the card</span>
5900052         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classOgre_1_1GLHardwarePixelBuffer.html#Ogre_1_1GLRenderBufferb6">download</a>(<span class="keyword">const</span> <a class="code" href="classOgre_1_1PixelBox.html">PixelBox</a> &amp;data);
6000053     <span class="keyword">public</span>:
6100055         <a class="code" href="classOgre_1_1GLHardwarePixelBuffer.html#Ogre_1_1GLHardwarePixelBuffera0">GLHardwarePixelBuffer</a>(size_t mWidth, size_t mHeight, size_t mDepth,
6200056                 PixelFormat mFormat,
6300057                 HardwareBuffer::Usage usage);
6400058         
6500060         <span class="keywordtype">void</span> <a class="code" href="classOgre_1_1GLHardwarePixelBuffer.html#Ogre_1_1GLRenderBuffera3">blitFromMemory</a>(<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);
6600061         
6700063         <span class="keywordtype">void</span> <a class="code" href="classOgre_1_1GLHardwarePixelBuffer.html#Ogre_1_1GLTextureBuffera12">blitToMemory</a>(<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);
6800064         
6900065         <a class="code" href="classOgre_1_1GLHardwarePixelBuffer.html#Ogre_1_1GLHardwarePixelBuffera3">~GLHardwarePixelBuffer</a>();
7000066         
7100069         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classOgre_1_1GLHardwarePixelBuffer.html#Ogre_1_1GLHardwarePixelBuffera4">bindToFramebuffer</a>(GLenum attachment, size_t zoffset);
72<a name="l00070"></a><a class="code" href="classOgre_1_1GLHardwarePixelBuffer.html#Ogre_1_1GLTextureBuffera14">00070</a>         GLenum <a class="code" href="classOgre_1_1GLHardwarePixelBuffer.html#Ogre_1_1GLTextureBuffera14">getGLFormat</a>() { <span class="keywordflow">return</span> <a class="code" href="classOgre_1_1GLHardwarePixelBuffer.html#Ogre_1_1GLTextureBufferp8">mGLInternalFormat</a>; }
7300071     };
7400072
75<a name="l00075"></a><a class="code" href="classOgre_1_1GLTextureBuffer.html">00075</a>     <span class="keyword">class </span><a class="code" href="classOgre_1_1GLTextureBuffer.html">GLTextureBuffer</a>: <span class="keyword">public</span> <a class="code" href="classOgre_1_1GLHardwarePixelBuffer.html">GLHardwarePixelBuffer</a>
7600076     {
7700077     <span class="keyword">public</span>:
7800079         <a class="code" href="classOgre_1_1GLTextureBuffer.html#Ogre_1_1GLTextureBuffera0">GLTextureBuffer</a>(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a> &amp;baseName, GLenum target, GLuint <span class="keywordtype">id</span>, GLint face, GLint level, Usage usage,
7900080             <span class="keywordtype">bool</span> softwareMipmap);
8000081         <a class="code" href="classOgre_1_1GLTextureBuffer.html#Ogre_1_1GLTextureBuffera1">~GLTextureBuffer</a>();
8100082         
8200084         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classOgre_1_1GLTextureBuffer.html#Ogre_1_1GLTextureBuffera2">bindToFramebuffer</a>(GLenum attachment, size_t zoffset);
8300086         <a class="code" href="classOgre_1_1RenderTexture.html">RenderTexture</a>* <a class="code" href="classOgre_1_1GLTextureBuffer.html#Ogre_1_1GLTextureBuffera3">getRenderTarget</a>(size_t);
8400087         <span class="comment">// Upload a box of pixels to this buffer on the card</span>
8500088         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classOgre_1_1GLTextureBuffer.html#Ogre_1_1GLTextureBuffera4">upload</a>(<span class="keyword">const</span> <a class="code" href="classOgre_1_1PixelBox.html">PixelBox</a> &amp;data);
8600089         <span class="comment">// Download a box of pixels from the card</span>
8700090         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classOgre_1_1GLTextureBuffer.html#Ogre_1_1GLTextureBuffera5">download</a>(<span class="keyword">const</span> <a class="code" href="classOgre_1_1PixelBox.html">PixelBox</a> &amp;data);
8800091   
8900092         <span class="comment">// Hardware implementation of blitFromMemory</span>
9000093         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classOgre_1_1GLTextureBuffer.html#Ogre_1_1GLTextureBuffera6">blitFromMemory</a>(<span class="keyword">const</span> <a class="code" href="classOgre_1_1PixelBox.html">PixelBox</a> &amp;src_orig, <span class="keyword">const</span> <a class="code" href="structOgre_1_1Box.html">Image::Box</a> &amp;dstBox);
9100094         
9200095         <span class="comment">// Notify TextureBuffer of destruction of render target</span>
93<a name="l00096"></a><a class="code" href="classOgre_1_1GLTextureBuffer.html#Ogre_1_1GLTextureBuffera7">00096</a>         <span class="keywordtype">void</span> <a class="code" href="classOgre_1_1GLTextureBuffer.html#Ogre_1_1GLTextureBuffera7">_clearSliceRTT</a>(size_t zoffset)
9400097         {
9500098             mSliceTRT[zoffset] = 0;
9600099         }
9700100         <span class="comment">// Copy from framebuffer</span>
9800101         <span class="keywordtype">void</span> <a class="code" href="classOgre_1_1GLTextureBuffer.html#Ogre_1_1GLTextureBuffera8">copyFromFramebuffer</a>(size_t zoffset);
9900103         <span class="keywordtype">void</span> <a class="code" href="classOgre_1_1GLTextureBuffer.html#Ogre_1_1GLTextureBuffera9">blit</a>(<span class="keyword">const</span> <a class="code" href="classOgre_1_1HardwarePixelBufferSharedPtr.html">HardwarePixelBufferSharedPtr</a> &amp;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);
10000104         <span class="comment">// Blitting implementation</span>
10100105         <span class="keywordtype">void</span> <a class="code" href="classOgre_1_1GLTextureBuffer.html#Ogre_1_1GLTextureBuffera10">blitFromTexture</a>(<a class="code" href="classOgre_1_1GLTextureBuffer.html">GLTextureBuffer</a> *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);
10200106     <span class="keyword">protected</span>:
10300107         <span class="comment">// In case this is a texture level</span>
104<a name="l00108"></a><a class="code" href="classOgre_1_1GLTextureBuffer.html#Ogre_1_1GLTextureBufferp0">00108</a>         GLenum mTarget;
105<a name="l00109"></a><a class="code" href="classOgre_1_1GLTextureBuffer.html#Ogre_1_1GLTextureBufferp1">00109</a>         GLenum <a class="code" href="classOgre_1_1GLTextureBuffer.html#Ogre_1_1GLTextureBufferp1">mFaceTarget</a>; <span class="comment">// same as mTarget in case of GL_TEXTURE_xD, but cubemap face for cubemaps</span>
106<a name="l00110"></a><a class="code" href="classOgre_1_1GLTextureBuffer.html#Ogre_1_1GLTextureBufferp2">00110</a>         GLuint <a class="code" href="classOgre_1_1GLTextureBuffer.html#Ogre_1_1GLTextureBufferp2">mTextureID</a>;
107<a name="l00111"></a><a class="code" href="classOgre_1_1GLTextureBuffer.html#Ogre_1_1GLTextureBufferp3">00111</a>         GLint <a class="code" href="classOgre_1_1GLTextureBuffer.html#Ogre_1_1GLTextureBufferp3">mFace</a>;
108<a name="l00112"></a><a class="code" href="classOgre_1_1GLTextureBuffer.html#Ogre_1_1GLTextureBufferp4">00112</a>         GLint mLevel;
109<a name="l00113"></a><a class="code" href="classOgre_1_1GLTextureBuffer.html#Ogre_1_1GLTextureBufferp5">00113</a>         <span class="keywordtype">bool</span> <a class="code" href="classOgre_1_1GLTextureBuffer.html#Ogre_1_1GLTextureBufferp5">mSoftwareMipmap</a>;       <span class="comment">// Use GLU for mip mapping</span>
11000114         
111<a name="l00115"></a><a class="code" href="classOgre_1_1GLTextureBuffer.html#Ogre_1_1GLTextureBufferx0">00115</a>         <span class="keyword">typedef</span> std::vector&lt;RenderTexture*&gt; SliceTRT;
112<a name="l00116"></a><a class="code" href="classOgre_1_1GLTextureBuffer.html#Ogre_1_1GLTextureBufferp6">00116</a>         SliceTRT mSliceTRT;
11300117     };
114<a name="l00120"></a><a class="code" href="classOgre_1_1GLRenderBuffer.html">00120</a>     <span class="keyword">class </span><a class="code" href="classOgre_1_1GLRenderBuffer.html">GLRenderBuffer</a>: <span class="keyword">public</span> <a class="code" href="classOgre_1_1GLHardwarePixelBuffer.html">GLHardwarePixelBuffer</a>
11500121     {
11600122     <span class="keyword">public</span>:
11700123         <a class="code" href="classOgre_1_1GLRenderBuffer.html#Ogre_1_1GLRenderBuffera0">GLRenderBuffer</a>(GLenum format, size_t width, size_t height);
11800124         <a class="code" href="classOgre_1_1GLRenderBuffer.html#Ogre_1_1GLRenderBuffera1">~GLRenderBuffer</a>();
11900125         
12000127         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classOgre_1_1GLRenderBuffer.html#Ogre_1_1GLRenderBuffera2">bindToFramebuffer</a>(GLenum attachment, size_t zoffset);
12100128     <span class="keyword">protected</span>:
12200129         <span class="comment">// In case this is a  render buffer</span>
123<a name="l00130"></a><a class="code" href="classOgre_1_1GLRenderBuffer.html#Ogre_1_1GLRenderBufferp0">00130</a>         GLuint <a class="code" href="classOgre_1_1GLRenderBuffer.html#Ogre_1_1GLRenderBufferp0">mRenderbufferID</a>;
12400131     };
12500132 };
12600133
12700134 <span class="preprocessor">#endif</span>
128</pre></div><hr>
129<p>
130Copyright &copy; 2000-2005 by The OGRE Team<br />
131<!--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/>
132This 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/>
133                <!--/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#">
134                <Work rdf:about="">
135                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
136        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
137                </Work>
138                <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> -->
139
140Last modified Sun Mar 12 14:37:41 2006
141</p>
142</body>
143</html>
Note: See TracBrowser for help on using the repository browser.