Framebuffer.hpp

Go to the documentation of this file.

/*
 *  Copyright (C) 2010 - 2016 Leonid Kostrykin
 *
 *  Chair of Medical Engineering (mediTEC)
 *  RWTH Aachen University
 *  Pauwelsstr. 20
 *  52074 Aachen
 *  Germany
 * 
 * 
 *  Copyright (C) 2021 - 2025 Leonid Kostrykin
 * 
 */
 
#ifndef FRAMEBUFFER_H_6014714286
#define FRAMEBUFFER_H_6014714286
 
#include <LibCarna/LibCarna.hpp>
#include <LibCarna/base/noncopyable.hpp>
#include <LibCarna/base/math.hpp>
#include <stack>
#include <set>
 
namespace LibCarna
{
 
namespace base
{
 
 
 
// ----------------------------------------------------------------------------------
// Framebuffer
// ----------------------------------------------------------------------------------
 
class LIBCARNA Framebuffer
{
 
    NON_COPYABLE
    
    math::Vector2ui size;
 
public:
 
    const static unsigned int MAXIMUM_ALLOWED_COLOR_COMPONENTS = 8;
 
    Framebuffer( unsigned int width, unsigned int height, Texture< 2 >& renderTexture );
    
    static Texture< 2 >* createRenderTexture( bool floatingPoint = false );
 
    ~Framebuffer();
    
    bool hasRenderTexture( unsigned int location ) const;
    
    const Texture< 2 >& renderTexture( unsigned int location ) const;
 
    const unsigned int id;
 
    static void copyDepthAttachment( unsigned int srcId, unsigned int dstId, const Viewport& src, const Viewport& dst );
 
    static void copyColorAttachment
        ( unsigned int srcId, unsigned int dstId
        , const Viewport& src, const Viewport& dst
        , unsigned int srcColorAttachment, unsigned int dstColorAttachment );
 
    static unsigned int currentId();
 
    void resize( const math::Vector2ui& size );
 
    void resize( unsigned int width, unsigned int height );
 
    inline unsigned int width() const
    {
        return size.x();
    }
 
    inline unsigned int height() const
    {
        return size.y();
    }
 
    // ------------------------------------------------------------------------------
    // Framebuffer :: MinimalBinding
    // ------------------------------------------------------------------------------
 
    class LIBCARNA MinimalBinding
    {
 
        NON_COPYABLE
 
    public:
 
        explicit MinimalBinding( Framebuffer& fbo );
 
        virtual ~MinimalBinding();
 
        void setColorComponent( Texture< 2 >& renderTexture, unsigned int location = 0 );
        
        void removeColorComponent( unsigned int location );
 
        Color readPixel( unsigned int x, unsigned int y, unsigned int location = 0 ) const;
 
        const Framebuffer& framebuffer() const;
 
        virtual void refresh() const;
 
    private:
 
        void bindFBO() const;
 
    protected:
 
        Framebuffer& fbo;
 
    }; // Framebuffer :: MinimalBinding
 
    // ------------------------------------------------------------------------------
    // Framebuffer :: Binding
    // ------------------------------------------------------------------------------
 
    class LIBCARNA Binding : public MinimalBinding
    {
 
    public:
 
        explicit Binding( Framebuffer& );
 
    protected:
 
        virtual void refresh();
 
    }; // Framebuffer :: Binding
 
    // ------------------------------------------------------------------------------
 
private:
 
    Texture< 2 >* renderTextures[ MAXIMUM_ALLOWED_COLOR_COMPONENTS ];
    const unsigned int depthBuffer;
    std::set< unsigned int > boundColorBuffers;
    class BindingStack;
 
    static void copy
        ( unsigned int srcId, unsigned int dstId
        , const Viewport& src, const Viewport& dst
        , unsigned int flags
        , unsigned int srcColorAttachment, unsigned int dstColorAttachment );
 
    static void copy
        ( unsigned int srcId, unsigned int dstId
        , unsigned int srcX0, unsigned int srcY0
        , unsigned int dstX0, unsigned int dstY0
        , unsigned int srcWidth, unsigned int srcHeight
        , unsigned int dstWidth, unsigned int dstHeight
        , unsigned int flags
        , unsigned int srcColorAttachment, unsigned int dstColorAttachment );
 
}; // Framebuffer
 
 
 
// ----------------------------------------------------------------------------------
// LIBCARNA_RENDER_TO_FRAMEBUFFER_EX
// ----------------------------------------------------------------------------------
 
#define LIBCARNA_RENDER_TO_FRAMEBUFFER_EX( fbo, binding, instructions ) \
    { \
        LibCarna::base::Framebuffer::Binding binding( fbo ); \
        instructions; \
    }
 
 
 
// ----------------------------------------------------------------------------------
// LIBCARNA_RENDER_TO_FRAMEBUFFER
// ----------------------------------------------------------------------------------
 
#define LIBCARNA_RENDER_TO_FRAMEBUFFER( fbo, instructions ) \
    LIBCARNA_RENDER_TO_FRAMEBUFFER_EX( fbo, fboBinding##__COUNTER__, instructions )
 
 
 
}  // namespace LibCarna :: base
 
}  // namespace LibCarna
 
#endif // FRAMEBUFFER_H_6014714286