/home/hauberg/Dokumenter/Capture/humim-tracker-0.1/src/OpenTissue/OpenTissue/utility/gl/gl_frame_buffer_object.h

Go to the documentation of this file.

#ifndef OPENTISSUE_UTILITY_GL_GL_FRAME_BUFFER_OBJECT_H
#define OPENTISSUE_UTILITY_GL_GL_FRAME_BUFFER_OBJECT_H
//
// OpenTissue Template Library
// - A generic toolbox for physics-based modeling and simulation.
// Copyright (C) 2008 Department of Computer Science, University of Copenhagen.
//
// OTTL is licensed under zlib: http://opensource.org/licenses/zlib-license.php
//
#include <OpenTissue/configuration.h>

#include <OpenTissue/utility/gl/gl.h>
#include <OpenTissue/gpu/texture/texture_texture2D.h>
#include <OpenTissue/gpu/texture/texture_texture3D.h>
#include <OpenTissue/utility/gl/gl_render_buffer.h>

#include <iostream>

namespace OpenTissue
{

  namespace gl
  {

    class FramebufferObject
    {
    protected:

      GLuint m_fbo_id;         
      GLuint m_saved_fbo_id;   

    protected:

      static GLuint create_fbo_id()
      {
        GLuint id = 0;
        glGenFramebuffersEXT(1, &id);
        return id;
      }

    public:

      FramebufferObject()
        : m_fbo_id( create_fbo_id() )
        , m_saved_fbo_id(0)
      {
        //--- Bind this FBO so that it actually gets created now
        guarded_bind();
        guarded_unbind();
      }

      ~FramebufferObject(){ glDeleteFramebuffersEXT(1, &m_fbo_id);}


    protected:

      void guarded_bind()
      {
        //--- Only binds if m_fbo_id is different than the currently bound FBO
        GLint tmp = 0;
        glGetIntegerv( GL_FRAMEBUFFER_BINDING_EXT, &tmp );
        m_saved_fbo_id = static_cast<GLuint>(tmp);
        if (m_fbo_id != m_saved_fbo_id)
        {
          glBindFramebufferEXT(GL_FRAMEBUFFER_EXT, m_fbo_id);
        }
      }

      void guarded_unbind()
      {
        //--- Returns FBO binding to the previously enabled FBO
        if (m_saved_fbo_id != m_fbo_id)
        {
          glBindFramebufferEXT(GL_FRAMEBUFFER_EXT, (GLuint)m_saved_fbo_id);
        }
      }

    public:

      void bind(){  glBindFramebufferEXT(GL_FRAMEBUFFER_EXT, m_fbo_id); }

      void attach_texture( GLenum attachment, GLenum texture_target,  GLuint texture_id, int mip_level = 0, int z_slice = 0)
      {
        guarded_bind();
#ifndef NDEBUG
        if( get_attached_id(attachment) != texture_id )
        {
#endif
          //--- decode what type of texture that is being attached and call the
          //--- corresponding FrameBufferTexture?DEXT method.
          if (texture_target == GL_TEXTURE_1D)
          {
            glFramebufferTexture1DEXT(
              GL_FRAMEBUFFER_EXT
              , attachment
              , GL_TEXTURE_1D
              , texture_id
              , mip_level
              );
          }
          else if (texture_target == GL_TEXTURE_3D)
          {
            glFramebufferTexture3DEXT(
              GL_FRAMEBUFFER_EXT
              , attachment
              , GL_TEXTURE_3D
              , texture_id
              , mip_level
              , z_slice
              );
          }
          else
          {
            // Default is GL_TEXTURE_2D, GL_TEXTURE_RECTANGLE_ARB, or cube faces
            glFramebufferTexture2DEXT(
              GL_FRAMEBUFFER_EXT
              , attachment
              , texture_target
              , texture_id
              , mip_level
              );
          }
#ifndef NDEBUG
        }
#endif
        guarded_unbind();
      }

      void attach_texture(GLenum attachment, OpenTissue::texture::texture2D_pointer texture)
      {
        attach_texture(attachment, texture->get_texture_target(), texture->get_texture_ID());
      }

      void attach_texture(GLenum attachment, OpenTissue::texture::texture3D_pointer texture, int z_slice)
      {
        attach_texture(attachment, texture->get_texture_target(), texture->get_texture_ID(), 0, z_slice);
      }

      void attach_render_buffer( GLenum attachment, GLuint buffer_id )
      {
        guarded_bind();
#ifndef NDEBUG
        if( get_attached_id(attachment) != buffer_id )
        {
#endif
          glFramebufferRenderbufferEXT( GL_FRAMEBUFFER_EXT, attachment, GL_RENDERBUFFER_EXT, buffer_id);
#ifndef NDEBUG
        }
#endif
        guarded_unbind();
      }

      void attach_render_buffer( GLenum attachment, renderbuffer_pointer buffer )
      {
        attach_render_buffer(attachment, buffer->get_id() );
      }

      void unattach( GLenum attachment )
      {
        guarded_bind();
        GLenum type = get_attached_type(attachment);
        switch(type)
        {
        case GL_NONE:    break;
        case GL_RENDERBUFFER_EXT:    attach_render_buffer( attachment, 0 );    break;
        case GL_TEXTURE:             attach_texture( attachment, GL_TEXTURE_2D, 0 );    break;
        default:                     std::cerr << "FramebufferObject::unattach(): Unknown attached resource type" << std::endl;
        }
        guarded_unbind();
      }

#ifndef NDEBUG
      bool is_valid( std::ostream& output = std::cerr )
      {
        guarded_bind();
        GLenum status;
        status = glCheckFramebufferStatusEXT(GL_FRAMEBUFFER_EXT);
        switch(status)
        {
        case GL_FRAMEBUFFER_COMPLETE_EXT: // Everything's OK
          break;
        case GL_FRAMEBUFFER_INCOMPLETE_ATTACHMENT_EXT:
          output << "glFrameBufferObject.is_valid():\n\t" << "GL_FRAMEBUFFER_INCOMPLETE_ATTACHMENT_EXT\n";
          break;
        case GL_FRAMEBUFFER_INCOMPLETE_MISSING_ATTACHMENT_EXT:
          output << "glFrameBufferObject.is_valid():\n\t" << "GL_FRAMEBUFFER_INCOMPLETE_MISSING_ATTACHMENT_EXT\n";
          break;
          // NOTE: henrikd 20060326 - Removed from the spec. Glew 1.3.4 does not define it anymore.
          //       See: http://oss.sgi.com/projects/ogl-sample/registry/EXT/framebuffer_object.txt
          //       See: http://sourceforge.net/tracker/index.php?func=detail&aid=1445198&group_id=67586&atid=523274
          //      case GL_FRAMEBUFFER_INCOMPLETE_DUPLICATE_ATTACHMENT_EXT:
          //        output << "glFrameBufferObject.is_valid():\n\t" << "GL_FRAMEBUFFER_INCOMPLETE_DUPLICATE_ATTACHMENT_EXT\n";
          //        break;
        case GL_FRAMEBUFFER_INCOMPLETE_DIMENSIONS_EXT:
          output << "glFrameBufferObject.is_valid():\n\t" << "GL_FRAMEBUFFER_INCOMPLETE_DIMENSIONS_EXT\n";
          break;
        case GL_FRAMEBUFFER_INCOMPLETE_FORMATS_EXT:
          output << "glFrameBufferObject.is_valid():\n\t"  << "GL_FRAMEBUFFER_INCOMPLETE_FORMATS_EXT\n";
          break;
        case GL_FRAMEBUFFER_INCOMPLETE_DRAW_BUFFER_EXT:
          output << "glFrameBufferObject.is_valid():\n\t" << "GL_FRAMEBUFFER_INCOMPLETE_DRAW_BUFFER_EXT\n";
          break;
        case GL_FRAMEBUFFER_INCOMPLETE_READ_BUFFER_EXT:
          output << "glFrameBufferObject.is_valid():\n\t"  << "GL_FRAMEBUFFER_INCOMPLETE_READ_BUFFER_EXT\n";
          break;
        case GL_FRAMEBUFFER_UNSUPPORTED_EXT:
          output << "glFrameBufferObject.is_valid():\n\t"  << "GL_FRAMEBUFFER_UNSUPPORTED_EXT\n";
          break;
          // NOTE: henrikd 20060326 - Removed from the spec. Glew 1.3.4 does not define it anymore.
          //       See: http://oss.sgi.com/projects/ogl-sample/registry/EXT/framebuffer_object.txt
          //  case GL_FRAMEBUFFER_STATUS_ERROR_EXT:
          //    output << "glFrameBufferObject.is_valid():\n\t" << "GL_FRAMEBUFFER_STATUS_ERROR_EXT\n";
          //    break;
        default:
          output << "glFrameBufferObject.is_valid():\n\t"  << "Unknown ERROR\n";
        }
        guarded_unbind();
        return (status==GL_FRAMEBUFFER_COMPLETE_EXT);
      }
#else
      bool is_valid( std::ostream& /*output = std::cerr*/ )    {       return true;     }
      bool is_valid() {       return true;     }
#endif

      GLenum get_attached_type( GLenum attachment )
      {
        // Returns GL_RENDERBUFFER_EXT or GL_TEXTURE
        guarded_bind();
        GLint type = 0;
        glGetFramebufferAttachmentParameterivEXT(
          GL_FRAMEBUFFER_EXT
          , attachment
          , GL_FRAMEBUFFER_ATTACHMENT_OBJECT_TYPE_EXT
          , &type
          );
        guarded_unbind();
        return GLenum(type);
      }

      GLuint get_attached_id( GLenum attachment )
      {
        guarded_bind();
        GLint id = 0;
        glGetFramebufferAttachmentParameterivEXT(
          GL_FRAMEBUFFER_EXT
          , attachment
          , GL_FRAMEBUFFER_ATTACHMENT_OBJECT_NAME_EXT
          , &id
          );
        guarded_unbind();
        return GLuint(id);
      }

      GLint get_attached_mip_level( GLenum attachment )
      {
        guarded_bind();
        GLint level = 0;
        glGetFramebufferAttachmentParameterivEXT(
          GL_FRAMEBUFFER_EXT
          , attachment
          , GL_FRAMEBUFFER_ATTACHMENT_TEXTURE_LEVEL_EXT
          , &level
          );
        guarded_unbind();
        return level;
      }

      GLint get_attached_cube_face( GLenum attachment )
      {
        guarded_bind();
        GLint level = 0;
        glGetFramebufferAttachmentParameterivEXT(
          GL_FRAMEBUFFER_EXT
          , attachment
          , GL_FRAMEBUFFER_ATTACHMENT_TEXTURE_CUBE_MAP_FACE_EXT
          , &level
          );
        guarded_unbind();
        return level;
      }

      GLint get_attached_Z_slice( GLenum attachment )
      {
        guarded_bind();
        GLint slice = 0;
        glGetFramebufferAttachmentParameterivEXT(
          GL_FRAMEBUFFER_EXT
          , attachment
          , GL_FRAMEBUFFER_ATTACHMENT_TEXTURE_3D_ZOFFSET_EXT
          , &slice
          );
        guarded_unbind();
        return slice;
      }

    public:

      static GLint get_max_color_attachments()
      {
        GLint max_attach = 0;
        glGetIntegerv( GL_MAX_COLOR_ATTACHMENTS_EXT, &max_attach );
        return max_attach;
      }

      static void disable(){    glBindFramebufferEXT(GL_FRAMEBUFFER_EXT, 0); }

    };



    inline bool is_framebuffer_object_supported()
    {
      // Read more here: http://opengl.org/registry/specs/EXT/framebuffer_object.txt
      //if (glewIsSupported("GL_VERSION_1_1  GL_EXT_framebuffer_object"))
      if (glewIsSupported("GL_EXT_framebuffer_object"))
      {
        return true;
      }
      return false;
    }

  } // namespace gl

} // namespace OpenTissue

//OPENTISSUE_UTILITY_GL_GL_FRAME_BUFFER_OBJECT_H
#endif