OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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-2014 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  virtual void setFsaaResolveDirty(void);
111  virtual void swapBuffers(void);
112 
115 
118  const BoundSufaceList& getBoundSurfaceList() const { return mBoundSurfaces; }
119 
122  {
123  assert (index < mBoundSurfaces.size());
124  return mBoundSurfaces[index];
125  }
126 
127 
128  protected:
130 
132  virtual void bindSurfaceImpl(size_t attachment, RenderTexture *target) = 0;
134  virtual void unbindSurfaceImpl(size_t attachment) = 0;
135 
136 
137  };
140 }
141 
142 #include "OgreHeaderSuffix.h"
143 
144 #endif
A 'canvas' which can receive the results of a rendering operation.
unsigned int uint32
Definition: OgrePlatform.h:420
#define _OgreExport
Definition: OgrePlatform.h:255
This class represents a RenderTarget that renders to a Texture.
const BoundSufaceList & getBoundSurfaceList() const
Get a list of the surfaces which have been bound.
RenderTexture * getBoundSurface(size_t index)
Get a pointer to a bound surface.
Unknown pixel format.
BoundSufaceList mBoundSurfaces
This class represents a render target that renders to multiple RenderTextures at once.
virtual void bindSurface(size_t attachment, RenderTexture *target)
Bind a surface to a certain attachment point.
PixelFormat
The pixel format used for images, textures, and render surfaces.
HardwarePixelBuffer * mBuffer
virtual void unbindSurface(size_t attachment)
Unbind attachment.
Specialisation of HardwareBuffer for a pixel buffer.
vector< RenderTexture * >::type BoundSufaceList
_StringBase String
Definition: OgreCommon.h:53
PixelFormat suggestPixelFormat() const
Irrelevant implementation since cannot copy.