gltexture.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-License-Identifier: GPL-2.0-or-later
*/
 
#pragma once
 
#include "core/output.h"
 
#include <QExplicitlySharedDataPointer>
#include <QMatrix4x4>
#include <QRegion>
#include <QSize>
 
#include <epoxy/gl.h>
 
class QImage;
class QPixmap;
 
namespace KWin
{
 
class GLVertexBuffer;
class GLTexturePrivate;
 
enum TextureCoordinateType {
    NormalizedCoordinates = 0,
    UnnormalizedCoordinates,
};
 
class KWIN_EXPORT GLTexture
{
public:
    explicit GLTexture(GLenum target);
 
    bool create();
    virtual ~GLTexture();
 
    bool isNull() const;
    QSize size() const;
    void setSize(const QSize &size);
    int width() const;
    int height() const;
 
    void setContentTransform(OutputTransform transform);
 
    OutputTransform contentTransform() const;
 
    void setSwizzle(GLenum red, GLenum green, GLenum blue, GLenum alpha);
 
    QMatrix4x4 matrix(TextureCoordinateType type) const;
 
    void update(const QImage &image, const QPoint &offset = QPoint(0, 0), const QRect &src = QRect());
    void bind();
    void unbind();
    void render(const QSizeF &size);
    void render(const QRegion &region, const QSizeF &size, bool hardwareClipping = false);
    void render(const QRectF &source, const QRegion &region, const QSizeF &targetSize, bool hardwareClipping = false);
 
    GLuint texture() const;
    GLenum target() const;
    GLenum filter() const;
    GLenum internalFormat() const;
 
    QImage toImage();
 
    void clear();
    void setDirty();
    bool isDirty() const;
    void setFilter(GLenum filter);
    void setWrapMode(GLenum mode);
 
    void generateMipmaps();
 
    static bool framebufferObjectSupported();
 
    static bool supportsSwizzle();
 
    static bool supportsFormatRG();
 
    static std::unique_ptr<GLTexture> createNonOwningWrapper(GLuint textureId, GLenum internalFormat, const QSize &size);
    static std::unique_ptr<GLTexture> allocate(GLenum internalFormat, const QSize &size, int levels = 1);
    static std::unique_ptr<GLTexture> upload(const QImage &image);
    static std::unique_ptr<GLTexture> upload(const QPixmap &pixmap);
 
protected:
    explicit GLTexture(GLenum target, GLuint textureId, GLenum internalFormat, const QSize &size, int levels, bool owning, OutputTransform transform);
 
    const std::unique_ptr<GLTexturePrivate> d;
 
    virtual void onDamage();
};
 
} // namespace