OgreCompositorManager.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 __CompositorManager_H__
29 #define __CompositorManager_H__
30 
31 #include "OgrePrerequisites.h"
32 #include "OgreResourceManager.h"
33 #include "OgreCompositor.h"
34 #include "OgreRectangle2D.h"
35 #include "OgreRenderSystem.h"
37 #include "OgreHeaderPrefix.h"
38 
39 namespace Ogre {
59  class _OgreExport CompositorManager : public ResourceManager, public Singleton<CompositorManager>
60  {
61  public:
63  virtual ~CompositorManager();
64 
66  Resource* createImpl(const String& name, ResourceHandle handle,
67  const String& group, bool isManual, ManualResourceLoader* loader,
68  const NameValuePairList* params);
69 
72  void initialise(void);
73 
78  CompositorPtr create (const String& name, const String& group,
79  bool isManual = false, ManualResourceLoader* loader = 0,
80  const NameValuePairList* createParams = 0);
81 
85 
86 
89  void parseScript(DataStreamPtr& stream, const String& groupName);
90 
97 
100  bool hasCompositorChain(Viewport *vp) const;
101 
105 
113  CompositorInstance *addCompositor(Viewport *vp, const String &compositor, int addPosition=-1);
114 
117  void removeCompositor(Viewport *vp, const String &compositor);
118 
124  void setCompositorEnabled(Viewport *vp, const String &compositor, bool value);
125 
129 
131  void removeAll(void);
132 
135 
137 
145  TexturePtr getPooledTexture(const String& name, const String& localName,
146  size_t w, size_t h,
147  PixelFormat f, uint aa, const String& aaHint, bool srgb, UniqueTextureSet& texturesAlreadyAssigned,
149 
153  void freePooledTextures(bool onlyIfUnreferenced = true);
154 
158  void registerCompositorLogic(const String& name, CompositorLogic* logic);
159 
163 
167 
171 
175 
208 
209 
210  private:
213 
216  void freeChains();
217 
219 
223 
227 
231 
234 
235  struct TextureDef
236  {
237  size_t width, height;
241  bool sRGBwrite;
242 
243  TextureDef(size_t w, size_t h, PixelFormat f, uint aa, const String& aaHint, bool srgb)
244  : width(w), height(h), format(f), fsaa(aa), fsaaHint(aaHint), sRGBwrite(srgb)
245  {
246 
247  }
248  };
250  {
251  bool _OgreExport operator()(const TextureDef& x, const TextureDef& y) const
252  {
253  if (x.format < y.format)
254  return true;
255  else if (x.format == y.format)
256  {
257  if (x.width < y.width)
258  return true;
259  else if (x.width == y.width)
260  {
261  if (x.height < y.height)
262  return true;
263  else if (x.height == y.height)
264  {
265  if (x.fsaa < y.fsaa)
266  return true;
267  else if (x.fsaa == y.fsaa)
268  {
269  if (x.fsaaHint < y.fsaaHint)
270  return true;
271  else if (x.fsaaHint == y.fsaaHint)
272  {
273  if (!x.sRGBwrite && y.sRGBwrite)
274  return true;
275  }
276 
277  }
278  }
279  }
280  }
281  return false;
282  }
283  virtual ~TextureDefLess() {}
284  };
287 
288  typedef std::pair<String, String> StringPair;
291 
293 
298 
299  };
303 }
304 
305 #include "OgreHeaderSuffix.h"
306 
307 #endif
OgreHeaderSuffix.h
Ogre::ResourceHandle
unsigned long long int ResourceHandle
Definition: OgreResource.h:41
Ogre::CompositorManager::CompositorLogicMap
map< String, CompositorLogic * >::type CompositorLogicMap
Map of registered compositor logics.
Definition: OgreCompositorManager.h:225
Ogre::CompositorManager::TextureDef::fsaa
uint fsaa
Definition: OgreCompositorManager.h:239
Ogre::CompositorManager::setCompositorEnabled
void setCompositorEnabled(Viewport *vp, const String &compositor, bool value)
Set the state of a compositor on a viewport to enabled or disabled.
Ogre::CompositorManager::TextureDefLess
Definition: OgreCompositorManager.h:250
Ogre::CompositorManager::hasCompositorChain
bool hasCompositorChain(Viewport *vp) const
Returns whether exists compositor chain for a viewport.
Ogre
Definition: OgreAndroidLogListener.h:35
Ogre::CompositorManager::freePooledTextures
void freePooledTextures(bool onlyIfUnreferenced=true)
Free pooled textures from the shared pool (compositor instances still using them will keep them in me...
Ogre::CompositorManager::getSingleton
static CompositorManager & getSingleton(void)
Override standard Singleton retrieval.
Ogre::map
Definition: OgrePrerequisites.h:534
Ogre::set::type
std::set< T, P, A > type
Definition: OgrePrerequisites.h:522
Ogre::CompositorChain
Chain of compositor effects applying to one viewport.
Definition: OgreCompositorChain.h:49
Ogre::CompositorManager::getPooledTexture
TexturePtr getPooledTexture(const String &name, const String &localName, size_t w, size_t h, PixelFormat f, uint aa, const String &aaHint, bool srgb, UniqueTextureSet &texturesAlreadyAssigned, CompositorInstance *inst, CompositionTechnique::TextureScope scope)
Utility function to get an existing pooled texture matching a given definition, or creating one if on...
Ogre::CompositorManager::getSingletonPtr
static CompositorManager * getSingletonPtr(void)
Override standard Singleton retrieval.
Ogre::CompositorManager::Instances
vector< CompositorInstance * >::type Instances
List of instances.
Definition: OgreCompositorManager.h:221
Ogre::CompositorManager::getCustomCompositionPass
CustomCompositionPass * getCustomCompositionPass(const String &name)
Get a custom composition pass by its name.
Ogre::CompositorManager::TextureDef::sRGBwrite
bool sRGBwrite
Definition: OgreCompositorManager.h:241
Ogre::CompositorManager::TextureDef
Definition: OgreCompositorManager.h:236
Ogre::CompositorManager::mChains
Chains mChains
Definition: OgreCompositorManager.h:212
Ogre::VectorIterator
Concrete IteratorWrapper for nonconst access to the underlying container.
Definition: OgreIteratorWrapper.h:186
Ogre::CompositorManager::mRectangle
Rectangle2D * mRectangle
Definition: OgreCompositorManager.h:218
Ogre::CompositorManager::TextureList
vector< TexturePtr >::type TextureList
Definition: OgreCompositorManager.h:232
Ogre::CompositorManager::addCompositor
CompositorInstance * addCompositor(Viewport *vp, const String &compositor, int addPosition=-1)
Add a compositor to a viewport.
Ogre::CompositorManager::mTexturesByDef
TexturesByDef mTexturesByDef
Definition: OgreCompositorManager.h:286
Ogre::ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME
static String AUTODETECT_RESOURCE_GROUP_NAME
Special resource group name which causes resource group to be automatically determined based on searc...
Definition: OgreResourceGroupManager.h:270
Ogre::CompositorManager::mInstances
Instances mInstances
Definition: OgreCompositorManager.h:222
Ogre::CompositorManager::isInputPreviousTarget
bool isInputPreviousTarget(CompositorInstance *inst, const Ogre::String &localName)
Ogre::CompositorManager::getCompositorLogic
CompositorLogic * getCompositorLogic(const String &name)
Get a compositor logic by its name.
Ogre::CompositorManager::CompositorManager
CompositorManager()
Ogre::CompositorManager
Class for managing Compositor settings for Ogre.
Definition: OgreCompositorManager.h:60
Ogre::String
_StringBase String
Definition: OgrePrerequisites.h:439
Ogre::CompositorManager::mCustomCompositionPasses
CustomCompositionPassMap mCustomCompositionPasses
Definition: OgreCompositorManager.h:230
Ogre::CompositorManager::TexturesByDef
map< TextureDef, TextureList *, TextureDefLess >::type TexturesByDef
Definition: OgreCompositorManager.h:285
Ogre::NameValuePairList
map< String, String >::type NameValuePairList
Name / value parameter pair (first = name, second = value)
Definition: OgreCommon.h:550
Ogre::CompositorManager::CustomCompositionPassMap
map< String, CustomCompositionPass * >::type CustomCompositionPassMap
Map of registered custom composition passes.
Definition: OgreCompositorManager.h:229
Ogre::CompositorManager::TextureIterator
VectorIterator< TextureList > TextureIterator
Definition: OgreCompositorManager.h:233
Ogre::CompositorManager::mCompositorLogics
CompositorLogicMap mCompositorLogics
Definition: OgreCompositorManager.h:226
Ogre::CompositorManager::TextureDef::height
size_t height
Definition: OgreCompositorManager.h:237
OgreCompositor.h
Ogre::CompositorManager::TextureDefLess::operator()
bool _OgreExport operator()(const TextureDef &x, const TextureDef &y) const
Definition: OgreCompositorManager.h:251
Ogre::CompositorManager::UniqueTextureSet
set< Texture * >::type UniqueTextureSet
Definition: OgreCompositorManager.h:136
Ogre::CompositorManager::removeCompositor
void removeCompositor(Viewport *vp, const String &compositor)
Remove a compositor from a viewport.
OgreHeaderPrefix.h
Ogre::PixelFormat
PixelFormat
The pixel format used for images, textures, and render surfaces.
Definition: OgrePixelFormat.h:44
Ogre::Viewport
An abstraction of a viewport, i.e.
Definition: OgreViewport.h:58
Ogre::CompositorLogic
Interface for compositor logics, which can be automatically binded to compositors,...
Definition: OgreCompositorLogic.h:47
Ogre::CompositorManager::TextureDefLess::~TextureDefLess
virtual ~TextureDefLess()
Definition: OgreCompositorManager.h:283
OgrePrerequisites.h
Ogre::CompositorManager::isInputToOutputTarget
bool isInputToOutputTarget(CompositorInstance *inst, const Ogre::String &localName)
Ogre::CompositorManager::removeAll
void removeAll(void)
Overridden from ResourceManager since we have to clean up chains too.
Ogre::CompositorManager::mChainTexturesByDef
ChainTexturesByDef mChainTexturesByDef
Definition: OgreCompositorManager.h:292
Ogre::CompositorManager::TextureDefMap
map< TextureDef, TexturePtr, TextureDefLess >::type TextureDefMap
Definition: OgreCompositorManager.h:289
Ogre::Singleton
Template class for creating single-instance global classes.
Definition: OgreSingleton.h:65
Ogre::CompositorManager::unregisterCompositorLogic
void unregisterCompositorLogic(const String &name)
Removes a listener for compositor logic registered with registerCompositorLogic.
Ogre::CompositorManager::ChainTexturesByDef
map< StringPair, TextureDefMap >::type ChainTexturesByDef
Definition: OgreCompositorManager.h:290
_OgreExport
#define _OgreExport
Definition: OgrePlatform.h:257
Ogre::CompositorManager::~CompositorManager
virtual ~CompositorManager()
Ogre::ResourceManager
Defines a generic resource handler.
Definition: OgreResourceManager.h:123
Ogre::CompositorManager::removeCompositorChain
void removeCompositorChain(Viewport *vp)
Remove the compositor chain from a viewport if exists.
Ogre::SharedPtr
Reference-counted shared pointer, used for objects where implicit destruction is required.
Definition: OgreSharedPtr.h:112
Ogre::Resource
Abstract class representing a loadable resource (e.g.
Definition: OgreResource.h:80
Ogre::CompositorManager::getByName
CompositorPtr getByName(const String &name, const String &groupName=ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME)
Get a resource by name.
Ogre::map::type
std::map< K, V, P, A > type
Definition: OgrePrerequisites.h:536
Ogre::CompositorManager::freeChains
void freeChains()
Clear composition chains for all viewports.
Ogre::uint
unsigned int uint
Definition: OgrePrerequisites.h:114
Ogre::CompositorManager::registerCustomCompositionPass
void registerCustomCompositionPass(const String &name, CustomCompositionPass *customPass)
Register a custom composition pass.
Ogre::CompositorManager::parseScript
void parseScript(DataStreamPtr &stream, const String &groupName)
Ogre::CompositionTechnique::TextureScope
TextureScope
Definition: OgreCompositionTechnique.h:52
Ogre::Renderable
Abstract class defining the interface all renderable objects must implement.
Definition: OgreRenderable.h:64
Ogre::Rectangle2D
Allows the rendering of a simple 2D rectangle This class renders a simple 2D rectangle; this rectangl...
Definition: OgreRectangle2D.h:50
Ogre::CompositorManager::_getTexturedRectangle2D
Renderable * _getTexturedRectangle2D()
Get a textured fullscreen 2D rectangle, for internal use.
Ogre::CompositorManager::StringPair
std::pair< String, String > StringPair
Definition: OgreCompositorManager.h:288
Ogre::CompositorManager::TextureDef::fsaaHint
String fsaaHint
Definition: OgreCompositorManager.h:240
Ogre::CompositorInstance
An instance of a Compositor object for one Viewport.
Definition: OgreCompositorInstance.h:51
Ogre::CompositorManager::isInputToOutputTarget
bool isInputToOutputTarget(CompositorInstance *inst, TexturePtr tex)
Ogre::CompositorManager::createImpl
Resource * createImpl(const String &name, ResourceHandle handle, const String &group, bool isManual, ManualResourceLoader *loader, const NameValuePairList *params)
Overridden from ResourceManager.
Ogre::CompositorManager::Chains
map< Viewport *, CompositorChain * >::type Chains
Definition: OgreCompositorManager.h:211
Ogre::CompositorManager::_reconstructAllCompositorResources
void _reconstructAllCompositorResources()
Internal method for forcing all active compositors to recreate their resources.
Ogre::vector
Definition: OgrePrerequisites.h:492
OgreRectangle2D.h
Ogre::CompositorManager::getCompositorChain
CompositorChain * getCompositorChain(Viewport *vp)
Get the compositor chain for a Viewport.
OgreCompositionTechnique.h
Ogre::ManualResourceLoader
Interface describing a manual resource loader.
Definition: OgreResource.h:515
Ogre::CompositorManager::isInputPreviousTarget
bool isInputPreviousTarget(CompositorInstance *inst, TexturePtr tex)
Ogre::CompositorManager::TextureDef::format
PixelFormat format
Definition: OgreCompositorManager.h:238
Ogre::CompositorManager::TextureDef::width
size_t width
Definition: OgreCompositorManager.h:237
OgreResourceManager.h
Ogre::CompositorManager::create
CompositorPtr create(const String &name, const String &group, bool isManual=false, ManualResourceLoader *loader=0, const NameValuePairList *createParams=0)
Create a new compositor.
Ogre::CompositorManager::registerCompositorLogic
void registerCompositorLogic(const String &name, CompositorLogic *logic)
Register a compositor logic for listening in to expecting composition techniques.
Ogre::CompositorManager::initialise
void initialise(void)
Initialises the Compositor manager, which also triggers it to parse all available ....
Ogre::CustomCompositionPass
Interface for custom composition passes, allowing custom operations (in addition to the quad,...
Definition: OgreCustomCompositionPass.h:46
Ogre::CompositorManager::TextureDef::TextureDef
TextureDef(size_t w, size_t h, PixelFormat f, uint aa, const String &aaHint, bool srgb)
Definition: OgreCompositorManager.h:243
OgreRenderSystem.h

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