opengl_compositor.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2013-2016 CERN
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * @author Maciej Suminski <[email protected]>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

 
#ifndef OPENGL_COMPOSITOR_H_
#define OPENGL_COMPOSITOR_H_
 
#include <kicad_gl/kiglad.h>    // Must be included first
 
#include <gal/compositor.h>
#include <gal/opengl/antialiasing.h>
#include <gal/gal_display_options.h>
#include <deque>
 
namespace KIGFX
{
 
class OPENGL_COMPOSITOR : public COMPOSITOR
{
public:
    OPENGL_COMPOSITOR();
    virtual ~OPENGL_COMPOSITOR();

    virtual void Initialize() override;

    virtual void Resize( unsigned int aWidth, unsigned int aHeight ) override;

    virtual unsigned int CreateBuffer() override;

    virtual void SetBuffer( unsigned int aBufferHandle ) override;

    inline virtual unsigned int GetBuffer() const override
    {
        if( m_curFbo == DIRECT_RENDERING )
            return DIRECT_RENDERING;
 
        return m_curBuffer + 1;
    }

    virtual void ClearBuffer( const COLOR4D& aColor ) override;

    virtual void DrawBuffer( unsigned int aBufferHandle ) override;

    virtual void Begin() override;
 
    // @copydoc COMPOSITOR::Present()
    virtual void Present() override;

    void Abandon();
 
    // Constant used by glBindFramebuffer to turn off rendering to framebuffers
    static const unsigned int DIRECT_RENDERING = 0;
 
    VECTOR2I GetScreenSize() const;
    GLenum   GetBufferTexture( unsigned int aBufferHandle );
    void     DrawBuffer( unsigned int aSourceHandle, unsigned int aDestHandle );

    void     DrawBufferDifference( unsigned int aSourceHandle, unsigned int aDestHandle );
 
    unsigned int CreateBuffer( VECTOR2I aDimensions );
 
    void SetAntialiasingMode( GAL_ANTIALIASING_MODE aMode ); // clears all buffers
    GAL_ANTIALIASING_MODE GetAntialiasingMode() const;
 
    int GetAntialiasSupersamplingFactor() const;
    VECTOR2D GetAntialiasRenderingOffset() const;
 
protected:
    void bindFb( unsigned int aFb );

    void clean();

    inline unsigned int usedBuffers()
    {
        return m_buffers.size();
    }
 
    // Buffers are simply textures storing a result of certain target rendering.
    struct OPENGL_BUFFER
    {
        VECTOR2I dimensions;
        GLuint textureTarget;                
        GLuint attachmentPoint;              
    };
 
    bool            m_initialized;            
    unsigned int    m_curBuffer;              
    GLuint          m_mainFbo;                
    GLuint          m_depthBuffer;            
    typedef std::deque<OPENGL_BUFFER> OPENGL_BUFFERS;

    OPENGL_BUFFERS  m_buffers;

    GLuint          m_curFbo;
 
    GAL_ANTIALIASING_MODE m_currentAntialiasingMode;
    std::unique_ptr<OPENGL_PRESENTOR> m_antialiasing;
 
    // Difference shader for XOR-style compositing
    GLuint          m_differenceShader;        
    GLint           m_diffSrcTexUniform;       
    GLint           m_diffDstTexUniform;       
    bool            m_differenceShaderInitialized;

    bool initDifferenceShader();

    void drawFullScreenQuad();
};
} // namespace KIGFX
 
#endif /* COMPOSITOR_H_ */