OpenWalnut  1.5.0dev
Public Types | Public Member Functions | List of all members
WGEOffscreenFinalPass Class Reference

This class is basically a WGEOffscreenTexturePass with the difference that it finally renders to the on-screen frame buffer. More...

#include <WGEOffscreenFinalPass.h>

+ Inheritance diagram for WGEOffscreenFinalPass:
+ Collaboration diagram for WGEOffscreenFinalPass:

Public Types

typedef osg::ref_ptr< WGEOffscreenFinalPassRefPtr
 Convenience typedef for an osg::ref_ptr. More...
 
typedef osg::ref_ptr< const WGEOffscreenFinalPassConstRefPtr
 Convenience typedef for an osg::ref_ptr; const. More...
 
- Public Types inherited from WGEOffscreenRenderPass
typedef osg::ref_ptr< WGEOffscreenRenderPassRefPtr
 Convenience typedef for an osg::ref_ptr. More...
 
typedef osg::ref_ptr< const WGEOffscreenRenderPassConstRefPtr
 Convenience typedef for an osg::ref_ptr; const. More...
 
- Public Types inherited from WGECamera
enum  ProjectionMode { ORTHOGRAPHIC , PERSPECTIVE , TWO_D , TWO_D_UNIT }
 List of possible camera modes. More...
 

Public Member Functions

 WGEOffscreenFinalPass (size_t textureWidth, size_t textureHeight, int num=0)
 Creates a new rendering pass instance which actually renders on a full-screen quad. More...
 
 WGEOffscreenFinalPass (size_t textureWidth, size_t textureHeight, osg::ref_ptr< WGETextureHud > hud, std::string name, int num=0)
 Creates a new rendering pass instance which actually renders on a full-screen quad. More...
 
virtual ~WGEOffscreenFinalPass ()
 Destructor. More...
 
- Public Member Functions inherited from WGEOffscreenTexturePass
 WGEOffscreenTexturePass (size_t textureWidth, size_t textureHeight, int num=0)
 Creates a new offscreen rendering instance. More...
 
 WGEOffscreenTexturePass (size_t textureWidth, size_t textureHeight, osg::ref_ptr< WGETextureHud > hud, std::string name, int num=0)
 Creates a new offscreen rendering instance. More...
 
virtual ~WGEOffscreenTexturePass ()
 Destructor. More...
 
- Public Member Functions inherited from WGEOffscreenRenderPass
 WGEOffscreenRenderPass (size_t textureWidth, size_t textureHeight, int num=0)
 Creates a new offscreen rendering instance. More...
 
 WGEOffscreenRenderPass (size_t textureWidth, size_t textureHeight, osg::ref_ptr< WGETextureHud > hud, std::string name, int num=0)
 Creates a new offscreen rendering instance. More...
 
virtual ~WGEOffscreenRenderPass ()
 Destructor. More...
 
void attach (BufferComponent buffer, osg::ref_ptr< osg::Texture2D > texture)
 Attach a given texture to a buffer. More...
 
void attach (BufferComponent buffer, osg::ref_ptr< osg::Image > image)
 Attach a given image to a buffer. More...
 
osg::ref_ptr< osg::Texture2D > attach (BufferComponent buffer, GLint internalFormat=GL_RGBA)
 This method attaches a texture to the given buffer. More...
 
void detach (BufferComponent buffer)
 Detaches the texture currently bound to the specified buffer. More...
 
template<typename T >
void bind (osg::ref_ptr< T > texture, size_t unit=0)
 This is a shortcut for wge::bindTexture. More...
 
osg::ref_ptr< osg::Texture2D > createTexture (GLint internalFormat=GL_RGBA)
 Creates a new texture suitable for this offscreen rendering instance. More...
 
std::string getName () const
 Returns the name of this render pass. More...
 
size_t getTextureWidth () const
 Get the size of the underlying texture. More...
 
size_t getTextureHeight () const
 Get the size of the underlying texture. More...
 
virtual void addUniform (osg::ref_ptr< osg::Uniform > uniform)
 The uniform to add. More...
 
- Public Member Functions inherited from WGECamera
 WGECamera (int width, int height, ProjectionMode projectionMode)
 Constructor which sets defaults. More...
 
 WGECamera ()
 Constructor which sets defaults. More...
 
void setDefaultProjectionMode (ProjectionMode mode)
 Sets the default projection mode used for cameras getting reset. More...
 
ProjectionMode getDefaultProjectionMode ()
 Returns the current default projection mode. More...
 
void reset ()
 Resets the camera and activates the prior set defaults. More...
 
void resize ()
 Change camera parameters which should be changed on a resize. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from WGEOffscreenRenderPass
static std::string getBufferName (BufferComponent buffer)
 Returns the buffer name. More...
 
- Protected Member Functions inherited from WGECamera
virtual ~WGECamera ()
 Destructor. More...
 
- Protected Attributes inherited from WGEOffscreenRenderPass
size_t m_width
 The width of the textures used for this pass. More...
 
size_t m_height
 The height of the textures used for this pass. More...
 
osg::ref_ptr< osg::FrameBufferObject > m_fbo
 The framebuffer object to use for this camera. More...
 
osg::ref_ptr< WGETextureHudm_hud
 Gets notified about any added and removed attachment. More...
 
std::string m_name
 The name if the rendering pass. More...
 
- Protected Attributes inherited from WGECamera
ProjectionMode m_DefProjMode
 The projection mode used as default. More...
 

Detailed Description

This class is basically a WGEOffscreenTexturePass with the difference that it finally renders to the on-screen frame buffer.

Definition at line 40 of file WGEOffscreenFinalPass.h.

Member Typedef Documentation

◆ ConstRefPtr

Convenience typedef for an osg::ref_ptr; const.

Definition at line 51 of file WGEOffscreenFinalPass.h.

◆ RefPtr

Convenience typedef for an osg::ref_ptr.

Definition at line 46 of file WGEOffscreenFinalPass.h.

Constructor & Destructor Documentation

◆ WGEOffscreenFinalPass() [1/2]

WGEOffscreenFinalPass::WGEOffscreenFinalPass ( size_t  textureWidth,
size_t  textureHeight,
int  num = 0 
)

Creates a new rendering pass instance which actually renders on a full-screen quad.

Parameters
textureWidththe width of all the textures created and used by this render pass. This should be large enough for every reasonable viewport size.
textureHeightthe height of all the textures created and used by this render pass. This should be large enough for every reasonable viewport size.*
numthe order number. This camera gets rendered at the num'th place in the pre render queue of the subgraph it is attached to.

Definition at line 31 of file WGEOffscreenFinalPass.cpp.

References WGEOffscreenRenderPass::m_hud.

◆ WGEOffscreenFinalPass() [2/2]

WGEOffscreenFinalPass::WGEOffscreenFinalPass ( size_t  textureWidth,
size_t  textureHeight,
osg::ref_ptr< WGETextureHud hud,
std::string  name,
int  num = 0 
)

Creates a new rendering pass instance which actually renders on a full-screen quad.

Parameters
textureWidththe width of all the textures created and used by this render pass. This should be large enough for every reasonable viewport size.
textureHeightthe height of all the textures created and used by this render pass. This should be large enough for every reasonable viewport size.*
numthe order number. This camera gets rendered at the num'th place in the pre render queue of the subgraph it is attached to.
hudthe hud that gets notified about attached and detached textures. Useful for debugging.
namethe name of this render pass. This is a nice debugging feature in conjunction with WGETextureHud as it gets displayed there.

Definition at line 55 of file WGEOffscreenFinalPass.cpp.

References WGEOffscreenRenderPass::m_hud.

◆ ~WGEOffscreenFinalPass()

WGEOffscreenFinalPass::~WGEOffscreenFinalPass ( )
virtual

Destructor.

Definition at line 80 of file WGEOffscreenFinalPass.cpp.


The documentation for this class was generated from the following files: