[148] | 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 | { |
---|
| 37 | /** \addtogroup Core |
---|
| 38 | * @{ |
---|
| 39 | */ |
---|
| 40 | /** \addtogroup RenderSystem |
---|
| 41 | * @{ |
---|
| 42 | */ |
---|
| 43 | /** This class represents a RenderTarget that renders to a Texture. There is no 1 on 1 |
---|
| 44 | relation between Textures and RenderTextures, as there can be multiple |
---|
| 45 | RenderTargets rendering to different mipmaps, faces (for cubemaps) or slices (for 3D textures) |
---|
| 46 | of the same Texture. |
---|
| 47 | */ |
---|
| 48 | class _OgreExport RenderTexture: public RenderTarget |
---|
| 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: |
---|
| 58 | HardwarePixelBuffer *mBuffer; |
---|
| 59 | uint32 mZOffset; |
---|
| 60 | }; |
---|
| 61 | |
---|
| 62 | /** This class represents a render target that renders to multiple RenderTextures |
---|
| 63 | at once. Surfaces can be bound and unbound at will, as long as the following constraints |
---|
| 64 | are met: |
---|
| 65 | - All bound surfaces have the same size |
---|
| 66 | - All bound surfaces have the same bit depth |
---|
| 67 | - Target 0 is bound |
---|
| 68 | */ |
---|
| 69 | class _OgreExport MultiRenderTarget: public RenderTarget |
---|
| 70 | { |
---|
| 71 | public: |
---|
| 72 | MultiRenderTarget(const String &name); |
---|
| 73 | |
---|
| 74 | /** Bind a surface to a certain attachment point. |
---|
| 75 | @param attachment 0 .. mCapabilities->getNumMultiRenderTargets()-1 |
---|
| 76 | @param target RenderTexture to bind. |
---|
| 77 | |
---|
| 78 | It does not bind the surface and fails with an exception (ERR_INVALIDPARAMS) if: |
---|
| 79 | - Not all bound surfaces have the same size |
---|
| 80 | - Not all bound surfaces have the same internal format |
---|
| 81 | */ |
---|
| 82 | |
---|
| 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 | |
---|
| 96 | /** Unbind attachment. |
---|
| 97 | */ |
---|
| 98 | |
---|
| 99 | virtual void unbindSurface(size_t attachment) |
---|
| 100 | { |
---|
| 101 | if (attachment < mBoundSurfaces.size()) |
---|
| 102 | mBoundSurfaces[attachment] = 0; |
---|
| 103 | unbindSurfaceImpl(attachment); |
---|
| 104 | } |
---|
| 105 | |
---|
| 106 | /** Error throwing implementation, it's not possible to write a MultiRenderTarget |
---|
| 107 | to disk. |
---|
| 108 | */ |
---|
| 109 | virtual void copyContentsToMemory(const PixelBox &dst, FrameBuffer buffer); |
---|
| 110 | |
---|
| 111 | /// Irrelevant implementation since cannot copy |
---|
| 112 | PixelFormat suggestPixelFormat() const { return PF_UNKNOWN; } |
---|
| 113 | |
---|
| 114 | typedef vector<RenderTexture*>::type BoundSufaceList; |
---|
| 115 | /// Get a list of the surfaces which have been bound |
---|
| 116 | const BoundSufaceList& getBoundSurfaceList() const { return mBoundSurfaces; } |
---|
| 117 | |
---|
| 118 | /** Get a pointer to a bound surface */ |
---|
| 119 | RenderTexture* getBoundSurface(size_t index) |
---|
| 120 | { |
---|
| 121 | assert (index < mBoundSurfaces.size()); |
---|
| 122 | return mBoundSurfaces[index]; |
---|
| 123 | } |
---|
| 124 | |
---|
| 125 | |
---|
| 126 | protected: |
---|
| 127 | BoundSufaceList mBoundSurfaces; |
---|
| 128 | |
---|
| 129 | /// Implementation of bindSurface, must be provided |
---|
| 130 | virtual void bindSurfaceImpl(size_t attachment, RenderTexture *target) = 0; |
---|
| 131 | /// Implementation of unbindSurface, must be provided |
---|
| 132 | virtual void unbindSurfaceImpl(size_t attachment) = 0; |
---|
| 133 | |
---|
| 134 | |
---|
| 135 | }; |
---|
| 136 | /** @} */ |
---|
| 137 | /** @} */ |
---|
| 138 | } |
---|
| 139 | |
---|
| 140 | #include "OgreHeaderSuffix.h" |
---|
| 141 | |
---|
| 142 | #endif |
---|