Cinder

include/cinder/gl/Fbo.h

Go to the documentation of this file.

/*
 Copyright (c) 2010, The Barbarian Group
 All rights reserved.

 Redistribution and use in source and binary forms, with or without modification, are permitted provided that
 the following conditions are met:

    * Redistributions of source code must retain the above copyright notice, this list of conditions and
    the following disclaimer.
    * 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.

 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.
*/

#pragma once

#include "cinder/Cinder.h"
#include "cinder/Exception.h"
#include "cinder/gl/gl.h"
#include "cinder/gl/Texture.h"

namespace cinder { namespace gl {

class Fbo {
 public:
    struct Format;

    Fbo() {}
    Fbo( int width, int height, Format format = Format() );
    Fbo( int width, int height, bool alpha, bool color = true, bool depth = true );

    int             getWidth() const { return mObj->mWidth; }
    int             getHeight() const { return mObj->mHeight; }
    Vec2i           getSize() const { return Vec2i( mObj->mWidth, mObj->mHeight ); }
    Area            getBounds() const { return Area( 0, 0, mObj->mWidth, mObj->mHeight ); }
    float           getAspectRatio() const { return mObj->mWidth / (float)mObj->mHeight; }
    const Format&   getFormat() const { return mObj->mFormat; }
    GLenum          getTarget() const { return mObj->mFormat.mTarget; }

    Texture&        getTexture();
    Texture&        getDepthTexture();  
    
    void            bindTexture( int textureUnit = 0 );
    void            unbindTexture();
    void            bindDepthTexture( int textureUnit = 0 );
    void            bindFramebuffer();
    static void     unbindFramebuffer();

    static GLint    getMaxSamples();
    
    struct Format {
      public:
        Format();

        void    setTarget( GLenum target ) { mTarget = target; }
        void    setColorInternalFormat( GLenum colorInternalFormat ) { mColorInternalFormat = colorInternalFormat; }
        void    setDepthInternalFormat( GLenum depthInternalFormat ) { mDepthInternalFormat = depthInternalFormat; }
        void    setSamples( int samples ) { mSamples = samples; }
        void    setCoverageSamples( int coverageSamples ) { mCoverageSamples = coverageSamples; }
        void    enableColorBuffer( bool colorBuffer = true ) { mColorBuffer = colorBuffer; }
        void    enableDepthBuffer( bool depthBuffer = true ) { mDepthBuffer = depthBuffer; }
//      void    enableStencilBuffer( bool stencilBuffer = true ) { mStencilBuffer = stencilBuffer; }
        void    enableMipmapping( bool enableMipmapping = true ) { mMipmapping = enableMipmapping; }

        void    setWrap( GLenum wrapS, GLenum wrapT ) { setWrapS( wrapS ); setWrapT( wrapT ); }
        void    setWrapS( GLenum wrapS ) { mWrapS = wrapS; }
        void    setWrapT( GLenum wrapT ) { mWrapT = wrapT; }
        void    setMinFilter( GLenum minFilter ) { mMinFilter = minFilter; }
        void    setMagFilter( GLenum magFilter ) { mMagFilter = magFilter; }

        
        GLenum  getTarget() const { return mTarget; }
        GLenum  getColorInternalFormat() const { return mColorInternalFormat; }
        GLenum  getDepthInternalFormat() const { return mDepthInternalFormat; }
        int     getSamples() const { return mSamples; }
        int     getCoverageSamples() const { return mCoverageSamples; }
        bool    hasColorBuffer() const { return mColorBuffer; }
        bool    hasDepthBuffer() const { return mDepthBuffer; }
//      bool    hasStencilBuffer() const { return mStencilBuffer; }
        bool    hasMipMapping() const { return mMipmapping; }
        
      protected:
        GLenum      mTarget;
        GLenum      mColorInternalFormat, mDepthInternalFormat;
        int         mSamples;
        int         mCoverageSamples;
        bool        mMipmapping;
        bool        mColorBuffer, mDepthBuffer, mStencilBuffer;
        GLenum      mWrapS, mWrapT;
        GLenum      mMinFilter, mMagFilter;
        
        friend class Fbo;
    };

 protected:
    void        init();
    bool        initMultisample( bool csaa );
    void        resolveTexture() const;
    void        updateMipmaps( bool bindFirst ) const;
    bool        checkStatus( class FboExceptionInvalidSpecification *resultExc );

    struct Obj {
        Obj();
        Obj( int aWidth, int aHeight );
        ~Obj();

        int                 mWidth, mHeight;
        Format              mFormat;
        GLuint              mId, mColorTextureId, mDepthTextureId;
        GLuint              mColorRenderBufferId, mDepthRenderBufferId, mResolveFramebufferId;
        Texture             mColorTexture, mDepthTexture;
        mutable bool        mNeedsResolve, mNeedsMipmapUpdate;
    };
 
    shared_ptr<Obj>     mObj;
    
    static GLint        sMaxSamples;
    
  public:

    typedef shared_ptr<Obj> Fbo::*unspecified_bool_type;
    operator unspecified_bool_type() { return ( mObj.get() == 0 ) ? 0 : &Fbo::mObj; }
    void reset() { mObj.reset(); }
};

class FboException : public Exception {
};

class FboExceptionInvalidSpecification : public FboException {
  public:
    FboExceptionInvalidSpecification() : FboException() { mMessage[0] = 0; }
    FboExceptionInvalidSpecification( const std::string &message ) throw();
    
    virtual const char * what() const throw() { return mMessage; }
    
  private:  
    char    mMessage[256];
};

} // namespace gl
} // namespace cinder