OgreRenderTexture.h
Go to the documentation of this file.
1 /*
2 -----------------------------------------------------------------------------
3 This source file is part of OGRE
4 (Object-oriented Graphics Rendering Engine)
5 For the latest info, see http://www.ogre3d.org/
6 
7 Copyright (c) 2000-2013 Torus Knot Software Ltd
8 
9 Permission is hereby granted, free of charge, to any person obtaining a copy
10 of this software and associated documentation files (the "Software"), to deal
11 in the Software without restriction, including without limitation the rights
12 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 copies of the Software, and to permit persons to whom the Software is
14 furnished to do so, subject to the following conditions:
15 
16 The above copyright notice and this permission notice shall be included in
17 all copies or substantial portions of the Software.
18 
19 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 THE SOFTWARE.
26 -----------------------------------------------------------------------------
27 */
28 #ifndef __RenderTexture_H__
29 #define __RenderTexture_H__
30 
31 #include "OgrePrerequisites.h"
32 #include "OgreRenderTarget.h"
33 #include "OgreHeaderPrefix.h"
34 
35 namespace Ogre
36 {
49  {
50  public:
51  RenderTexture(HardwarePixelBuffer *buffer, uint32 zoffset);
52  virtual ~RenderTexture();
53 
54  virtual void copyContentsToMemory(const PixelBox &dst, FrameBuffer buffer);
55  PixelFormat suggestPixelFormat() const;
56 
57  protected:
60  };
61 
70  {
71  public:
72  MultiRenderTarget(const String &name);
73 
83  virtual void bindSurface(size_t attachment, RenderTexture *target)
84  {
85  for (size_t i = mBoundSurfaces.size(); i <= attachment; ++i)
86  {
87  mBoundSurfaces.push_back(0);
88  }
89  mBoundSurfaces[attachment] = target;
90 
91  bindSurfaceImpl(attachment, target);
92  }
93 
94 
95 
99  virtual void unbindSurface(size_t attachment)
100  {
101  if (attachment < mBoundSurfaces.size())
102  mBoundSurfaces[attachment] = 0;
103  unbindSurfaceImpl(attachment);
104  }
105 
109  virtual void copyContentsToMemory(const PixelBox &dst, FrameBuffer buffer);
110 
113 
116  const BoundSufaceList& getBoundSurfaceList() const { return mBoundSurfaces; }
117 
120  {
121  assert (index < mBoundSurfaces.size());
122  return mBoundSurfaces[index];
123  }
124 
125 
126  protected:
128 
130  virtual void bindSurfaceImpl(size_t attachment, RenderTexture *target) = 0;
132  virtual void unbindSurfaceImpl(size_t attachment) = 0;
133 
134 
135  };
138 }
139 
140 #include "OgreHeaderSuffix.h"
141 
142 #endif
OgreHeaderSuffix.h
Ogre::MultiRenderTarget::unbindSurface
virtual void unbindSurface(size_t attachment)
Unbind attachment.
Definition: OgreRenderTexture.h:99
Ogre::PF_UNKNOWN
Unknown pixel format.
Definition: OgrePixelFormat.h:46
Ogre
Definition: OgreAndroidLogListener.h:34
Ogre::MultiRenderTarget::mBoundSurfaces
BoundSufaceList mBoundSurfaces
Definition: OgreRenderTexture.h:127
Ogre::MultiRenderTarget::getBoundSurface
RenderTexture * getBoundSurface(size_t index)
Get a pointer to a bound surface.
Definition: OgreRenderTexture.h:119
OgreRenderTarget.h
Ogre::HardwarePixelBuffer
Specialisation of HardwareBuffer for a pixel buffer.
Definition: OgreHardwarePixelBuffer.h:53
Ogre::uint32
unsigned int uint32
Definition: OgrePlatform.h:359
Ogre::String
_StringBase String
Definition: OgrePrerequisites.h:439
OgreHeaderPrefix.h
Ogre::RenderTarget
A 'canvas' which can receive the results of a rendering operation.
Definition: OgreRenderTarget.h:65
Ogre::RenderTexture::mBuffer
HardwarePixelBuffer * mBuffer
Definition: OgreRenderTexture.h:58
Ogre::PixelFormat
PixelFormat
The pixel format used for images, textures, and render surfaces.
Definition: OgrePixelFormat.h:43
OgrePrerequisites.h
Ogre::MultiRenderTarget::suggestPixelFormat
PixelFormat suggestPixelFormat() const
Irrelevant implementation since cannot copy.
Definition: OgreRenderTexture.h:112
_OgreExport
#define _OgreExport
Definition: OgrePlatform.h:257
Ogre::RenderTarget::FrameBuffer
FrameBuffer
Definition: OgreRenderTarget.h:91
Ogre::MultiRenderTarget
This class represents a render target that renders to multiple RenderTextures at once.
Definition: OgreRenderTexture.h:69
Ogre::MultiRenderTarget::bindSurface
virtual void bindSurface(size_t attachment, RenderTexture *target)
Bind a surface to a certain attachment point.
Definition: OgreRenderTexture.h:83
Ogre::PixelBox
A primitive describing a volume (3D), image (2D) or line (1D) of pixels in memory.
Definition: OgrePixelFormat.h:304
Ogre::RenderTexture
This class represents a RenderTarget that renders to a Texture.
Definition: OgreRenderTexture.h:48
Ogre::vector
Definition: OgrePrerequisites.h:491
Ogre::MultiRenderTarget::BoundSufaceList
vector< RenderTexture * >::type BoundSufaceList
Definition: OgreRenderTexture.h:114
Ogre::MultiRenderTarget::getBoundSurfaceList
const BoundSufaceList & getBoundSurfaceList() const
Get a list of the surfaces which have been bound.
Definition: OgreRenderTexture.h:116
Ogre::RenderTexture::mZOffset
uint32 mZOffset
Definition: OgreRenderTexture.h:59

Copyright © 2012 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.