FBO.hh

/*===========================================================================*\
 *                                                                           *
 *                              OpenFlipper                                  *
 *           Copyright (c) 2001-2015, RWTH-Aachen University                 *
 *           Department of Computer Graphics and Multimedia                  *
 *                          All rights reserved.                             *
 *                            www.openflipper.org                            *
 *                                                                           *
 *---------------------------------------------------------------------------*
 * This file is part of OpenFlipper.                                         *
 *---------------------------------------------------------------------------*
 *                                                                           *
 * Redistribution and use in source and binary forms, with or without        *
 * modification, are permitted provided that the following conditions        *
 * are met:                                                                  *
 *                                                                           *
 * 1. Redistributions of source code must retain the above copyright notice, *
 *    this list of conditions and the following disclaimer.                  *
 *                                                                           *
 * 2. Redistributions in binary form must reproduce the above copyright      *
 *    notice, this list of conditions and the following disclaimer in the    *
 *    documentation and/or other materials provided with the distribution.   *
 *                                                                           *
 * 3. Neither the name of the copyright holder nor the names of its          *
 *    contributors may be used to endorse or promote products derived from   *
 *    this software without specific prior written permission.               *
 *                                                                           *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS       *
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A           *
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,  *
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,       *
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR        *
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF    *
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING      *
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS        *
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.              *
 *                                                                           *
\*===========================================================================*/

//=============================================================================
//
//  CLASS FBO
//
// Author:  Dominik Sibbing <sibbing@cs.rwth-aachen.de>
//
// Version: $Revision: 1$
// Date:    $Date: 2008$
//
//=============================================================================


#ifndef ACG_FBO_HH
#define ACG_FBO_HH


//== INCLUDES =================================================================

#include <iostream>
#include <cstdlib>
#include <map>
#include <vector>

#include <ACG/Config/ACGDefines.hh>
#include <ACG/GL/gl.hh>

//== FORWARDDECLARATIONS ======================================================

//== NAMESPACES ===============================================================

namespace ACG {

//== CLASS DEFINITION =========================================================


class ACGDLLEXPORT FBO
{
public:
  
  // fbo_ braucht initialen Wert.
  FBO();
  
  ~FBO();
  
  void init();

  void del();

  GLsizei setMultisampling(GLsizei _samples, GLboolean _fixedsamplelocations = GL_TRUE);

  GLsizei getMultisamplingCount() const {return samples_;}

  void attachTexture( GLenum _attachment,
    GLuint _texture,
    GLuint _level = 0);

  void attachTexture2D( GLenum _attachment,
    GLsizei _width, GLsizei _height, 
    GLuint _internalFmt, GLenum _format, 
    GLint _wrapMode = GL_CLAMP,
    GLint _minFilter = GL_NEAREST,
    GLint _magFilter = GL_NEAREST);


  void attachTexture2D( GLenum _attachment, GLuint _texture, GLenum _target = GL_TEXTURE_2D );

  void attachTexture2DDepth( GLsizei _width, GLsizei _height, GLuint _internalFmt = GL_DEPTH_COMPONENT32, GLenum _format = GL_DEPTH_COMPONENT );

  void attachTexture2DStencil(GLsizei _width, GLsizei _height);

  void attachTexture3D( GLenum _attachment,
    GLsizei _width, GLsizei _height, GLsizei _depth,
    GLuint _internalFmt, GLenum _format,
    GLint _wrapMode = GL_CLAMP,
    GLint _minFilter = GL_NEAREST,
    GLint _magFilter = GL_NEAREST);

  void addDepthBuffer( GLuint _width, GLuint _height );
  
  void addStencilBuffer( GLuint _width, GLuint _height );

  void addDepthStencilBuffer( GLuint _width, GLuint _height );

  GLuint getAttachment( GLenum _attachment );

  GLuint getInternalFormat( GLenum _attachment );

  GLuint getFboID();

  void resize(GLsizei _width, GLsizei _height, bool _forceResize = false);

  GLsizei width() const {return width_;}

  GLsizei height() const {return height_;}

  ACG::Vec2i size() const {return ACG::Vec2i(width_, height_);}
  
  bool bind();
  
  void unbind();
  
  bool checkFramebufferStatus();

private:

  GLuint fbo_;

  GLuint depthbuffer_;
  
  GLuint stencilbuffer_;

  struct RenderTexture
  {
    RenderTexture();

    // opengl buf id
    GLuint id;

    // GL_TEXTURE_2D, GL_TEXTURE_2D_MULTISAMPLE..
    GLenum target;

    GLenum internalFormat, format, gltype;

    // tex dimension
    ACG::Vec3i dim;

    // common sampler params
    GLint wrapMode,
      minFilter,
      magFilter;

    // created by FBO class
    bool owner;
  };

  typedef std::map<GLenum, RenderTexture> AttachmentList;
  AttachmentList attachments_; // key: attachment index,  value: RenderTexture


  GLsizei width_, height_;

  GLsizei samples_;

  GLboolean fixedsamplelocation_;


  GLuint prevFbo_;
  GLuint prevDrawBuffer_;
};


//=============================================================================
} // namespace ACG
//=============================================================================
#endif // ACG_FBO_HH defined
//=============================================================================