glframebuffer.h

Go to the documentation of this file.

/*
    KWin - the KDE window manager
    This file is part of the KDE project.
 
    SPDX-FileCopyrightText: 2006-2007 Rivo Laks <rivolaks@hot.ee>
    SPDX-FileCopyrightText: 2010, 2011 Martin Gräßlin <mgraesslin@kde.org>
    SPDX-FileCopyrightText: 2023 Xaver Hugl <xaver.hugl@kde.org>
 
    SPDX-License-Identifier: GPL-2.0-or-later
*/
#pragma once
#include "kwin_export.h"
 
#include <QRect>
#include <QStack>
#include <epoxy/gl.h>
 
namespace KWin
{
 
class GLTexture;
class RenderTarget;
class RenderViewport;
 
// Cleans up all resources hold by the GL Context
void KWIN_EXPORT cleanupGL();
 
class KWIN_EXPORT GLFramebuffer
{
public:
    enum Attachment {
        NoAttachment,
        CombinedDepthStencil,
    };
 
    explicit GLFramebuffer();
 
    explicit GLFramebuffer(GLTexture *colorAttachment, Attachment attachment = NoAttachment);
 
    GLFramebuffer(GLuint handle, const QSize &size);
    ~GLFramebuffer();
 
    GLuint handle() const
    {
        return m_handle;
    }
    QSize size() const
    {
        return m_size;
    }
    bool valid() const
    {
        return m_valid;
    }
 
    static void initStatic();
    static bool supported()
    {
        return s_supported;
    }
 
    static GLFramebuffer *currentFramebuffer();
 
    static void pushFramebuffer(GLFramebuffer *fbo);
    static GLFramebuffer *popFramebuffer();
    static bool blitSupported();
 
    void blitFromFramebuffer(const QRect &source = QRect(), const QRect &destination = QRect(), GLenum filter = GL_LINEAR, bool flipX = false, bool flipY = false);
 
    bool blitFromRenderTarget(const RenderTarget &sourceRenderTarget, const RenderViewport &sourceViewport, const QRect &source, const QRect &destination);
 
    GLTexture *colorAttachment() const;
 
protected:
    void initColorAttachment(GLTexture *colorAttachment);
    void initDepthStencilAttachment();
 
private:
    bool bind();
 
    friend void KWin::cleanupGL();
    static void cleanup();
    inline static bool s_supported = false;
    inline static bool s_supportsPackedDepthStencil = false;
    inline static bool s_supportsDepth24 = false;
    inline static bool s_blitSupported = false;
    inline static QStack<GLFramebuffer *> s_fbos;
 
    GLuint m_handle = 0;
    GLuint m_depthBuffer = 0;
    GLuint m_stencilBuffer = 0;
    QSize m_size;
    bool m_valid = false;
    bool m_foreign = false;
    GLTexture *const m_colorAttachment;
};
 
}