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 (C) 2020 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, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
 */

#ifndef OPENGL_COMPOSITOR_H_
#define OPENGL_COMPOSITOR_H_

#include <gal/opengl/kiglew.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;

 // Constant used by glBindFramebuffer to turn off rendering to framebuffers
 static const unsigned int DIRECT_RENDERING = 0;

 VECTOR2U GetScreenSize() const;
 GLenum GetBufferTexture( unsigned int aBufferHandle );
 void DrawBuffer( unsigned int aSourceHandle, unsigned int aDestHandle );
 unsigned int CreateBuffer( VECTOR2U aDimensions );

 void SetAntialiasingMode( OPENGL_ANTIALIASING_MODE aMode ); // clears all buffers
 OPENGL_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
 {
 VECTOR2U 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;

 OPENGL_ANTIALIASING_MODE m_currentAntialiasingMode;
 std::unique_ptr<OPENGL_PRESENTOR> m_antialiasing;
};
} // namespace KIGFX

#endif /* COMPOSITOR_H_ */