qsgrhiatlastexture_p.h

Go to the documentation of this file.

// Copyright (C) 2019 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
 
#ifndef QSGRHIATLASTEXTURE_P_H
#define QSGRHIATLASTEXTURE_P_H
 
//
//  W A R N I N G
//  -------------
//
// This file is not part of the Qt API.  It exists purely as an
// implementation detail.  This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
//
 
#include <QtCore/QSize>
#include <QtQuick/private/qsgplaintexture_p.h>
#include <QtQuick/private/qsgareaallocator_p.h>
#include <QtGui/QSurface>
#include <rhi/qrhi.h>
 
QT_BEGIN_NAMESPACE
 
class QSGDefaultRenderContext;
 
namespace QSGCompressedAtlasTexture {
    class Atlas;
}
class QSGCompressedTextureFactory;
 
namespace QSGRhiAtlasTexture
{
 
class Texture;
class TextureBase;
class Atlas;
 
class Manager : public QObject
{
    Q_OBJECT
 
public:
    Manager(QSGDefaultRenderContext *rc, const QSize &surfacePixelSize, QSurface *maybeSurface);
    ~Manager();
 
    QSGTexture *create(const QImage &image, bool hasAlphaChannel);
    QSGTexture *create(const QSGCompressedTextureFactory *factory);
    void invalidate();
 
private:
    QSGDefaultRenderContext *m_rc;
    QRhi *m_rhi;
    Atlas *m_atlas = nullptr;
    // set of atlases for different compressed formats
    QHash<unsigned int, QSGCompressedAtlasTexture::Atlas*> m_atlases;
 
    QSize m_atlas_size;
    int m_atlas_size_limit;
};
 
class AtlasBase : public QObject
{
    Q_OBJECT
public:
    AtlasBase(QSGDefaultRenderContext *rc, const QSize &size);
    ~AtlasBase();
 
    void invalidate();
    void commitTextureOperations(QRhiResourceUpdateBatch *resourceUpdates);
    void remove(TextureBase *t);
 
    QSGDefaultRenderContext *renderContext() const { return m_rc; }
    QRhi *rhi() const { return m_rhi; }
    QRhiTexture *texture() const { return m_texture; }
    QSize size() const { return m_size; }
 
protected:
    virtual bool generateTexture() = 0;
    virtual void enqueueTextureUpload(TextureBase *t, QRhiResourceUpdateBatch *resourceUpdates) = 0;
 
protected:
    QSGDefaultRenderContext *m_rc;
    QRhi *m_rhi;
    QSGAreaAllocator m_allocator;
    QRhiTexture *m_texture = nullptr;
    QSize m_size;
    QVector<TextureBase *> m_pending_uploads;
    friend class TextureBase;
    friend class TextureBasePrivate;
 
private:
    bool m_allocated = false;
};
 
class Atlas : public AtlasBase
{
public:
    Atlas(QSGDefaultRenderContext *rc, const QSize &size);
    ~Atlas();
 
    bool generateTexture() override;
    void enqueueTextureUpload(TextureBase *t, QRhiResourceUpdateBatch *resourceUpdates) override;
 
    Texture *create(const QImage &image);
 
    QRhiTexture::Format format() const { return m_format; }
 
private:
    QRhiTexture::Format m_format;
    int m_atlas_transient_image_threshold = 0;
 
    uint m_debug_overlay : 1;
};
 
class TextureBase : public QSGTexture
{
    Q_OBJECT
public:
    TextureBase(AtlasBase *atlas, const QRect &textureRect);
    ~TextureBase();
 
    qint64 comparisonKey() const override;
    QRhiTexture *rhiTexture() const override;
    void commitTextureOperations(QRhi *rhi, QRhiResourceUpdateBatch *resourceUpdates) override;
 
    bool isAtlasTexture() const override { return true; }
    QRect atlasSubRect() const { return m_allocated_rect; }
 
protected:
    QRect m_allocated_rect;
    AtlasBase *m_atlas;
};
 
class Texture : public TextureBase
{
    Q_OBJECT
public:
    Texture(Atlas *atlas, const QRect &textureRect, const QImage &image);
    ~Texture();
 
    QSize textureSize() const override { return atlasSubRectWithoutPadding().size(); }
    void setHasAlphaChannel(bool alpha) { m_has_alpha = alpha; }
    bool hasAlphaChannel() const override { return m_has_alpha; }
    bool hasMipmaps() const override { return false; }
 
    QRectF normalizedTextureSubRect() const override { return m_texture_coords_rect; }
 
    QRect atlasSubRect() const { return m_allocated_rect; }
    QRect atlasSubRectWithoutPadding() const { return m_allocated_rect.adjusted(1, 1, -1, -1); }
 
    QSGTexture *removedFromAtlas(QRhiResourceUpdateBatch *resourceUpdates) const override;
 
    void releaseImage() { m_image = QImage(); }
    const QImage &image() const { return m_image; }
 
private:
    QRectF m_texture_coords_rect;
    QImage m_image;
    mutable QSGPlainTexture *m_nonatlas_texture = nullptr;
    bool m_has_alpha;
};
 
}
 
QT_END_NAMESPACE
 
#endif