kis_opengl_canvas2.cpp

Go to the documentation of this file.

/* This file is part of the KDE project
 * SPDX-FileCopyrightText: 2006-2013 Boudewijn Rempt <boud@valdyas.org>
 * SPDX-FileCopyrightText: 2015 Michael Abrahams <miabraha@gmail.com>
 *
 *  SPDX-License-Identifier: GPL-2.0-or-later
 */
 
#define GL_GLEXT_PROTOTYPES
 
#include <QWindow>
 
#include "opengl/kis_opengl_canvas2.h"
#include "opengl/KisOpenGLCanvasRenderer.h"
#include "opengl/KisOpenGLSync.h"
#include "opengl/kis_opengl_canvas_debugger.h"
 
#include "canvas/kis_canvas2.h"
#include <kis_canvas_resource_provider.h>
#include "kis_config.h"
#include "kis_config_notifier.h"
#include "kis_debug.h"
#include <KisViewManager.h>
#include "KisRepaintDebugger.h"
 
#include "KisOpenGLModeProber.h"
#include "KisOpenGLContextSwitchLock.h"
#include <KisPlatformPluginInterfaceFactory.h>
 
#include "config-qt-patches-present.h"
 
static bool OPENGL_SUCCESS = false;
 
class KisOpenGLCanvas2::CanvasBridge
    : public KisOpenGLCanvasRenderer::CanvasBridge
{
    friend class KisOpenGLCanvas2;
    explicit CanvasBridge(KisOpenGLCanvas2 *canvas)
        : m_canvas(canvas)
    {}
    ~CanvasBridge() override = default;
    Q_DISABLE_COPY(CanvasBridge)
    KisOpenGLCanvas2 *m_canvas;
protected:
    KisCanvas2 *canvas() const override {
        return m_canvas->canvas();
    }
    QOpenGLContext *openglContext() const override {
        return m_canvas->context();
    }
    qreal devicePixelRatioF() const override {
        return m_canvas->devicePixelRatioF();
    }
    KisCoordinatesConverter *coordinatesConverter() const override {
        return m_canvas->coordinatesConverter();
    }
    QColor borderColor() const override {
        return m_canvas->borderColor();
    }
    GLenum internalTextureFormat() const override {
        return m_canvas->textureFormat();
    }
};
 
struct KisOpenGLCanvas2::Private
{
public:
    ~Private() {
        delete renderer;
    }
 
    boost::optional<QRect> updateRect;
#if KRITA_QT_HAS_UPDATE_COMPRESSION_PATCH
    bool shouldSkipRenderingPass = false;
#endif
    QRect canvasImageDirtyRect;
    KisOpenGLCanvasRenderer *renderer;
    QScopedPointer<KisOpenGLSync> glSyncObject;
    KisRepaintDebugger repaintDbg;
};
 
KisOpenGLCanvas2::KisOpenGLCanvas2(KisCanvas2 *canvas,
                                   KisCoordinatesConverter *coordinatesConverter,
                                   QWidget *parent,
                                   KisImageWSP image,
                                   const KisDisplayConfig &displayConfig,
                                   QSharedPointer<KisDisplayFilter> displayFilter,
                                   BitDepthMode bitDepthRequest)
    : QOpenGLWidget(parent)
    , KisCanvasWidgetBase(canvas, coordinatesConverter)
    , d(new Private())
{
    setProperty("krita_skip_srgb_surface_manager_assignment", true);
 
    KisConfig cfg(false);
    cfg.setCanvasState("OPENGL_STARTED");
 
    d->renderer = new KisOpenGLCanvasRenderer(new CanvasBridge(this), image, displayConfig, displayFilter);
 
    connect(d->renderer->openGLImageTextures().data(),
            SIGNAL(sigShowFloatingMessage(QString, int, bool)),
            SLOT(slotShowFloatingMessage(QString, int, bool)));
 
    setAcceptDrops(true);
    setAutoFillBackground(false);
 
    setFocusPolicy(Qt::StrongFocus);
    setAttribute(Qt::WA_NoSystemBackground, true);
#ifdef Q_OS_MACOS
    setAttribute(Qt::WA_AcceptTouchEvents, false);
#else
    setAttribute(Qt::WA_AcceptTouchEvents, true);
#endif
    setAttribute(Qt::WA_InputMethodEnabled, true);
    setAttribute(Qt::WA_DontCreateNativeAncestors, true);
 
    const bool osManagedSurfacePresent = KisPlatformPluginInterfaceFactory::instance()->surfaceColorManagedByOS();
    bool useNativeSurfaceForCanvas = osManagedSurfacePresent && cfg.enableCanvasSurfaceColorSpaceManagement();
    if (qEnvironmentVariableIsSet("KRITA_USE_NATIVE_CANVAS_SURFACE")) {
        useNativeSurfaceForCanvas = qEnvironmentVariableIntValue("KRITA_USE_NATIVE_CANVAS_SURFACE");
        qDebug() << "FPS-DEBUG: Krita canvas mode is overridden:" << (useNativeSurfaceForCanvas ? "native surface" : "legacy mode") << useNativeSurfaceForCanvas << qEnvironmentVariableIsSet("KRITA_USE_NATIVE_CANVAS_SURFACE");
    }
 
    if (useNativeSurfaceForCanvas) {
        setAttribute(Qt::WA_NativeWindow, true);
    }
 
    setUpdateBehavior(PartialUpdate);
 
    // we should make sure the texture doesn't have alpha channel,
    // otherwise blending will not work correctly.
    if (KisOpenGLModeProber::instance()->useHDRMode()) {
        setTextureFormat(GL_RGBA16F);
    } else {
        if (bitDepthRequest == BitDepthMode::Depth10Bit) {
            if (QSurfaceFormat::defaultFormat().redBufferSize() < 10) {
                warnOpenGL <<
                    "WARNING: KisOpenGLCanvas2 was created with a 10-bit surface, "
                    "while the global surface format is still set to 8-bit. Expect "
                    "color banding to appear";
            }
            setTextureFormat(GL_RGB10_A2);
        } else {
            if (!KisOpenGL::hasOpenGLES()) {
                setTextureFormat(GL_RGB8);
            }
        }
    }
 
    connect(KisConfigNotifier::instance(), SIGNAL(configChanged()), SLOT(slotConfigChanged()));
    connect(KisConfigNotifier::instance(), SIGNAL(pixelGridModeChanged()), SLOT(slotPixelGridModeChanged()));
 
    connect(canvas->viewManager()->canvasResourceProvider(), SIGNAL(sigEffectiveCompositeOpChanged()), SLOT(slotUpdateCursorColor()));
    connect(canvas->viewManager()->canvasResourceProvider(), SIGNAL(sigPaintOpPresetChanged(KisPaintOpPresetSP)), SLOT(slotUpdateCursorColor()));
 
    slotConfigChanged();
    slotPixelGridModeChanged();
    cfg.writeEntry("canvasState", "OPENGL_SUCCESS");
}
 
KisOpenGLCanvas2::~KisOpenGLCanvas2()
{
    makeCurrent();
 
    delete d;
 
    doneCurrent();
}
 
void KisOpenGLCanvas2::setDisplayFilter(QSharedPointer<KisDisplayFilter> displayFilter)
{
    KisOpenGLContextSwitchLockSkipOnQt5 contextLock(this);
    d->renderer->setDisplayFilter(displayFilter);
}
 
void KisOpenGLCanvas2::notifyImageColorSpaceChanged(const KoColorSpace *cs)
{
    KisOpenGLContextSwitchLockSkipOnQt5 contextLock(this);
    d->renderer->notifyImageColorSpaceChanged(cs);
}
 
void KisOpenGLCanvas2::setWrapAroundViewingMode(bool value)
{
    d->renderer->setWrapAroundViewingMode(value);
    update();
}
 
bool KisOpenGLCanvas2::wrapAroundViewingMode() const
{
    return d->renderer->wrapAroundViewingMode();
}
 
void KisOpenGLCanvas2::setWrapAroundViewingModeAxis(WrapAroundAxis value)
{
    d->renderer->setWrapAroundViewingModeAxis(value);
    update();
}
 
WrapAroundAxis KisOpenGLCanvas2::wrapAroundViewingModeAxis() const
{
    return d->renderer->wrapAroundViewingModeAxis();
}
 
void KisOpenGLCanvas2::initializeGL()
{
    d->renderer->initializeGL();
    KisOpenGLSync::init(context());
}
 
void KisOpenGLCanvas2::resizeGL(int width, int height)
{
    d->renderer->resizeGL(width, height);
    d->canvasImageDirtyRect = QRect(0, 0, width, height);
}
 
void KisOpenGLCanvas2::paintGL()
{
#if KRITA_QT_HAS_UPDATE_COMPRESSION_PATCH
    if (d->shouldSkipRenderingPass) {
        return;
    }
#endif
 
    const QRect updateRect = d->updateRect ? *d->updateRect : QRect();
 
    if (!OPENGL_SUCCESS) {
        KisConfig cfg(false);
        cfg.writeEntry("canvasState", "OPENGL_PAINT_STARTED");
    }
 
    KisOpenglCanvasDebugger::instance()->notifyPaintRequested();
    QRect canvasImageDirtyRect = d->canvasImageDirtyRect & rect();
    d->canvasImageDirtyRect = QRect();
    d->renderer->paintCanvasOnly(canvasImageDirtyRect, updateRect);
    {
        QPainter gc(this);
        if (!updateRect.isEmpty()) {
            gc.setClipRect(updateRect);
        }
 
        QRect decorationsBoundingRect = coordinatesConverter()->imageRectInWidgetPixels().toAlignedRect();
 
        if (!updateRect.isEmpty()) {
            decorationsBoundingRect &= updateRect;
        }
 
        drawDecorations(gc, decorationsBoundingRect);
    }
 
    d->repaintDbg.paint(this, updateRect.isEmpty() ? rect() : updateRect);
 
    // We create the glFenceSync object here instead of in KisOpenGLRenderer,
    // because the glFenceSync object should be created after all render
    // commands in a frame, not just the OpenGL canvas itself. Putting it
    // outside of KisOpenGLRenderer allows the canvas widget to do extra
    // rendering, which a QtQuick2-based canvas will need.
    d->glSyncObject.reset(new KisOpenGLSync());
 
    if (!OPENGL_SUCCESS) {
        KisConfig cfg(false);
        cfg.writeEntry("canvasState", "OPENGL_SUCCESS");
        OPENGL_SUCCESS = true;
    }
}
 
void KisOpenGLCanvas2::paintEvent(QPaintEvent *e)
{
    KIS_SAFE_ASSERT_RECOVER_RETURN(!d->updateRect);
 
    if (qFuzzyCompare(devicePixelRatioF(), qRound(devicePixelRatioF()))) {
        d->updateRect = e->rect();
    } else {
        d->updateRect = this->rect();
    }
 
#if KRITA_QT_HAS_UPDATE_COMPRESSION_PATCH
    if (isBusy()) {
        //qWarning() << "WARNING: paint event delivered with the canvas non-ready, rescheduling...";
        d->shouldSkipRenderingPass = true;
        QOpenGLWidget::paintEvent(e);
        d->shouldSkipRenderingPass = false;
        QTimer::singleShot(0, this,
            [this, updateRect = *d->updateRect] () {
                if (updateRect.isEmpty()) {
                    this->update();
                } else {
                    this->update(updateRect);
                }
            });
    } else
#endif
    {
        QOpenGLWidget::paintEvent(e);
    }
 
    d->updateRect = boost::none;
}
 
void KisOpenGLCanvas2::paintToolOutline(const KisOptimizedBrushOutline &path, int thickness)
{
    const QRect updateRect = d->updateRect ? *d->updateRect : QRect();
 
    d->renderer->paintToolOutline(path, updateRect, thickness);
}
 
bool KisOpenGLCanvas2::isBusy() const
{
    const bool isBusyStatus = d->glSyncObject && !d->glSyncObject->isSignaled();
    KisOpenglCanvasDebugger::instance()->notifySyncStatus(isBusyStatus);
    return isBusyStatus;
}
 
void KisOpenGLCanvas2::setLodResetInProgress(bool value)
{
    d->renderer->setLodResetInProgress(value);
}
 
void KisOpenGLCanvas2::slotConfigChanged()
{
    d->renderer->updateConfig();
 
    notifyConfigChanged();
}
 
void KisOpenGLCanvas2::slotPixelGridModeChanged()
{
    d->renderer->updatePixelGridMode();
 
    update();
}
 
void KisOpenGLCanvas2::slotUpdateCursorColor()
{
    d->renderer->updateCursorColor();
}
 
void KisOpenGLCanvas2::slotShowFloatingMessage(const QString &message, int timeout, bool priority)
{
    canvas()->imageView()->showFloatingMessage(message, QIcon(), timeout, priority ? KisFloatingMessage::High : KisFloatingMessage::Medium);
}
 
QVariant KisOpenGLCanvas2::inputMethodQuery(Qt::InputMethodQuery query) const
{
    return processInputMethodQuery(query);
}
 
void KisOpenGLCanvas2::inputMethodEvent(QInputMethodEvent *event)
{
    processInputMethodEvent(event);
}
 
void KisOpenGLCanvas2::focusInEvent(QFocusEvent *event)
{
    processFocusInEvent(event);
}
 
void KisOpenGLCanvas2::focusOutEvent(QFocusEvent *event)
{
    processFocusOutEvent(event);
}
 
void KisOpenGLCanvas2::hideEvent(QHideEvent *e)
{
    QOpenGLWidget::hideEvent(e);
    notifyDecorationsWindowMinimized(true);
}
 
void KisOpenGLCanvas2::showEvent(QShowEvent *e)
{
    QOpenGLWidget::showEvent(e);
    notifyDecorationsWindowMinimized(false);
}
 
void KisOpenGLCanvas2::setDisplayConfig(const KisDisplayConfig &config)
{
    KisOpenGLContextSwitchLockSkipOnQt5 contextLock(this);
    d->renderer->setDisplayConfig(config);
}
 
void KisOpenGLCanvas2::channelSelectionChanged(const QBitArray &channelFlags)
{
    d->renderer->channelSelectionChanged(channelFlags);
}
 
 
void KisOpenGLCanvas2::finishResizingImage(qint32 w, qint32 h)
{
    KisOpenGLContextSwitchLockSkipOnQt5 contextLock(this);
    d->renderer->finishResizingImage(w, h);
}
 
KisUpdateInfoSP KisOpenGLCanvas2::startUpdateCanvasProjection(const QRect & rc)
{
    return d->renderer->startUpdateCanvasProjection(rc);
}
 
 
QRect KisOpenGLCanvas2::updateCanvasProjection(KisUpdateInfoSP info)
{
    return d->renderer->updateCanvasProjection(info);
}
 
QVector<QRect> KisOpenGLCanvas2::updateCanvasProjection(const QVector<KisUpdateInfoSP> &infoObjects)
{
    KisOpenGLContextSwitchLockSkipOnQt5 contextLock(this);
    return KisCanvasWidgetBase::updateCanvasProjection(infoObjects);
}
 
void KisOpenGLCanvas2::updateCanvasImage(const QRect &imageUpdateRect)
{
    d->canvasImageDirtyRect |= imageUpdateRect;
    update(imageUpdateRect);
}
 
void KisOpenGLCanvas2::updateCanvasDecorations(const QRect &decoUpdateRect)
{
    update(decoUpdateRect);
}
bool KisOpenGLCanvas2::callFocusNextPrevChild(bool next)
{
    return focusNextPrevChild(next);
}
 
KisOpenGLImageTexturesSP KisOpenGLCanvas2::openGLImageTextures() const
{
    return d->renderer->openGLImageTextures();
}
 
KisOpenGLCanvas2::BitDepthMode KisOpenGLCanvas2::currentBitDepthMode() const 
{
    return
        textureFormat() == GL_RGB10_A2 &&
        format().redBufferSize() == 10 &&
        format().greenBufferSize() == 10 &&
        format().blueBufferSize() == 10 ?
            BitDepthMode::Depth10Bit :
            BitDepthMode::Depth8Bit;
}
 
QString KisOpenGLCanvas2::currentBitDepthUserReport() const {
    QString report;
    QDebug str(&report);
 
    str << "Texture Format: " << Qt::hex << Qt::showbase << textureFormat() << Qt::reset;
 
    switch (textureFormat()) {
        case GL_RGB10_A2:
            str << " (" << "GL_RGB10_A2" << ")";
            break;
// not available in openGLES
#ifdef GL_RGB10
            case GL_RGB10:
            str << " (" << "GL_RGB10" << ")";
            break;
#endif /* GL_RGB10 */
// not available in openGLES
#ifdef GL_RGB12
        case GL_RGB12:
            str << " (" << "GL_RGB12" << ")";
            break;
#endif /* GL_RGB12 */
// not available in openGLES
#ifdef GL_RGBA16
        case GL_RGBA16:
            str << " (" << "GL_RGBA16" << ")";
            break;
#endif /* GL_RGBA16 */
// not available in openGLES
#ifdef GL_RGB16
        case GL_RGB16:
            str << " (" << "GL_RGB16" << ")";
            break;
#endif /* GL_RGB16 */
        case GL_RGBA16F:
            str << " (" << "GL_RGBA16F" << ")";
            break;
        case GL_RGB8:
            str << " (" << "GL_RGB8" << ")";
            break;
        case GL_RGBA8:
            str << " (" << "GL_RGBA8" << ")";
            break;
        default:
            str << " (" << "<unknown>" << ")";
            break;
    }
    str << Qt::endl;
 
    str << "FBO Buffer Size: "
        << "R: " << format().redBufferSize() << " "
        << "G: " << format().greenBufferSize() << " "
        << "B: " << format().blueBufferSize() << " "
        << "A: " << format().alphaBufferSize() << Qt::endl;
 
    QWindow *win = windowHandle();
    if (win) {
        str << "Window Buffer Size: "
        << "R: " << win->format().redBufferSize() << " "
        << "G: " << win->format().greenBufferSize() << " "
        << "B: " << win->format().blueBufferSize() << " "
        << "A: " << win->format().alphaBufferSize() << Qt::endl;
    }
 
    if (win) {
        str << "Global Buffer Size: "
        << "R: " << QSurfaceFormat::defaultFormat().redBufferSize() << " "
        << "G: " << QSurfaceFormat::defaultFormat().greenBufferSize() << " "
        << "B: " << QSurfaceFormat::defaultFormat().blueBufferSize() << " "
        << "A: " << QSurfaceFormat::defaultFormat().alphaBufferSize() << Qt::endl;
    }
 
    return report;
}