OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
OgreCompositorPass.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 
29 #ifndef __CompositorPass_H__
30 #define __CompositorPass_H__
31 
32 #include "OgreHeaderPrefix.h"
33 
35 
36 namespace Ogre
37 {
38  class RenderTarget;
39  struct CompositorChannel;
40  class CompositorNode;
41 
60  {
62  protected:
65 
67 
69 
70  RenderTarget* calculateRenderTarget( size_t rtIndex, const CompositorChannel &source );
71 
72  public:
73  CompositorPass( const CompositorPassDef *definition, const CompositorChannel &target,
74  CompositorNode *parentNode );
75  virtual ~CompositorPass();
76 
77  virtual void execute( const Camera *lodCameraconst ) = 0;
78 
80  virtual void notifyRecreated( const CompositorChannel &oldChannel,
81  const CompositorChannel &newChannel );
82 
84  virtual void notifyDestroyed( const CompositorChannel &channel );
85 
87  virtual void notifyCleared(void);
88 
89  CompositorPassType getType() const { return mDefinition->getType(); }
90 
91  Viewport* getViewport() const { return mViewport; }
92 
93  const CompositorPassDef* getDefinition(void) const { return mDefinition; }
94  };
95 
98 }
99 
100 #include "OgreHeaderSuffix.h"
101 
102 #endif
A 'canvas' which can receive the results of a rendering operation.
A viewpoint from which the scene will be rendered.
Definition: OgreCamera.h:82
Abstract class for compositor passes.
unsigned int uint32
Definition: OgrePlatform.h:420
#define _OgreExport
Definition: OgrePlatform.h:255
CompositorPassDef const * mDefinition
CompositorPassType getType() const
Viewport * getViewport() const
Compositor nodes are the core subject of compositing.
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
CompositorNode * mParentNode
An abstraction of a viewport, i.e.
Definition: OgreViewport.h:56
Interface to abstract all types of pass definitions (.
A channel in the compositor transports textures between nodes.
const CompositorPassDef * getDefinition(void) const