renderPass.h

Go to the documentation of this file.

//////////////////////////////////////////////////////////////////////
// 6/6/02       Aaron Lefohn    Scientific Computing and Imaging Institute
// School of Computing          University of Utah
//
//  This library is free software; you can redistribute it and/or
//  modify it under the terms of the GNU Lesser General Public
//  License as published by the Free Software Foundation; either
//  version 2.1 of the License, or (at your option) any later version.
//
//  This library is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
//  Lesser General Public License for more details.
//
//  You should have received a copy of the GNU Lesser General Public
//  License along with this library; if not, write to the Free Software
//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

#if !defined(AFX_RENDERPASS_H__2E3F741E_4225_473E_8516_81E4C39BCA31__INCLUDED_)
#define AFX_RENDERPASS_H__2E3F741E_4225_473E_8516_81E4C39BCA31__INCLUDED_

#if _MSC_VER > 1000
#pragma once
#endif // _MSC_VER > 1000

#include "renderableGLI.h"
#include <GL/glew.h>
#include "../texture/singleTex.h"
#include "../state/pbuffGlift.h"
#include "../drawable/drawableGLI.h"
#include <mathGutz.h>
#include <vector>

namespace glift {

typedef std::vector<DrawableGLI*> VecDrawP;

/////////////////////////////////////////////////////////////////////////
///
/// RenderPass.h: interface for the RenderPass class.
///
/// - This class encapsulates an entire render pass.
/// - The destination of the render pass is either the color buffer or a pbuffer.
/// - A texture may optionally be specified as a copy-to-texture destination
/// - An alternate viewport may optionally be set for this RenderPass. The \n
///   viewport is NOT restored after the pass unless 'restoreViewport' is true.
/// - If a pbuffer destination is used, the previous rendering target is NOT \n
///   restored unless "restoreContext" is set to 'true.'
///////////////////////////////////////////////////////////////////////
/// TODO: Add the ability to add a GenState vector to these constructors
class _export_ RenderPass : public RenderableGLI
{
public:
   /// Standard, Render-To-ColorBuffer constructors
   RenderPass( DrawableGLI* prim, const gutz::vec4i& viewport=gutz::vec4i(), bool restoreView=false);
   RenderPass( const VecDrawP& prims, const gutz::vec4i& viewport=gutz::vec4i(), bool restoreView=false);

   /// Copy colorBuffer to 'texDest'
   RenderPass( DrawableGLI* prim, SingleTex* texDest, 
      const gutz::vec4i& viewport=gutz::vec4i(), bool restoreView=false );
   RenderPass( const VecDrawP& prims, SingleTex* texDest, 
      const gutz::vec4i& viewport=gutz::vec4i(), bool restoreView=false );

   /// Render to Texture using PBuffer
   RenderPass( DrawableGLI* prim, PBuffGlift* pbuffDest, bool restoreContext=false,
      const gutz::vec4i& viewport=gutz::vec4i(), bool restoreView=false );
   RenderPass( const VecDrawP& prims, PBuffGlift* pbuffDest, bool restoreContext=false,
      const gutz::vec4i& viewport=gutz::vec4i(), bool restoreView=false );

   /// Render to Pbuffer and Copy to Texture (when Render-to-Texture is not available)
   RenderPass( DrawableGLI* prim, SingleTex* texDest, PBuffGlift* pbuffDest, bool restoreContext=false, 
      const gutz::vec4i& viewport=gutz::vec4i(), bool restoreView=false );
   RenderPass( const VecDrawP& prims, SingleTex* texDest, PBuffGlift* pbuffDest, bool restoreContext=false, 
      const gutz::vec4i& viewport=gutz::vec4i(), bool restoreView=false );

   RenderPass( const RenderPass& rhs );
   RenderPass& operator=(const RenderPass& rhs);
   virtual ~RenderPass();

   /// Set Functions
   void setViewport( const gutz::vec4i& viewport, bool restoreView=false );
   void setDest( PBuffGlift* pbuff )    {m_pbuffDest = pbuff;}
   void setDest( SingleTex* tex )               {m_texDest = tex;}

protected:
   virtual void renderDef();

   inline void  setViewport();
   inline void drawPrims();
   inline void  restoreViewport();

private:
   VecDrawP             m_prim;                   /// The primitives to draw
   PBuffGlift*          m_pbuffDest;      /// PBuffer destination (optional)
   SingleTex*           m_texDest;                /// Texture destination (optional) 
   bool             m_restoreCTX;         /// Restore context after a pbuffer renderPass?
   bool                 m_changeView;     /// Should the viewport change?
   bool                 m_restoreView;    /// Restore previous viewport?
   gutz::vec4i          m_saveVP;                 /// The saved viewport
   gutz::vec4i          m_viewport;               /// Viewport for this render pass (optional)

   RenderPass(); //Disallow default construction

   /// **** These Functions are used by constructors ****
   void initMembers( const RenderPass& rhs );
   void initMembers( const VecDrawP& prim, SingleTex* texDest, PBuffGlift* pbuffDest, 
      bool m_restoreCTX, bool changeView, const gutz::vec4i& viewport,  bool restoreView );
};

inline void RenderPass::setViewport()
{
   if( m_changeView ) {
      if( m_restoreView ) {
         glGetIntegerv(GL_VIEWPORT, &m_saveVP[0]);
      }
      glViewport(m_viewport[0], m_viewport[1], m_viewport[2], m_viewport[3]);
   }
}

inline void RenderPass::restoreViewport()
{
   if( m_changeView && m_restoreView) {
      glViewport(m_saveVP[0], m_saveVP[1], m_saveVP[2], m_saveVP[3]);
   }
}

inline void RenderPass::drawPrims()
{
   for( uint i=0; i < m_prim.size(); i++) {
      m_prim[i]->draw();
   }
}

} /// End of namespace glift

#endif /// !defined(AFX_RENDERPASS_H__2E3F741E_4225_473E_8516_81E4C39BCA31__INCLUDED_)

---

Send questions, comments, and bug reports to: