offscreenquickview.h

Go to the documentation of this file.

/*
    KWin - the KDE window manager
    This file is part of the KDE project.
 
    SPDX-FileCopyrightText: 2019 David Edmundson <davidedmundson@kde.org>
 
    SPDX-License-Identifier: GPL-2.0-or-later
*/
 
#pragma once
 
#include "kwin_export.h"
 
#include <QObject>
#include <QRect>
#include <QUrl>
 
#include <memory>
 
class QKeyEvent;
class QMouseEvent;
 
class QMouseEvent;
class QKeyEvent;
 
class QQmlContext;
class QQuickItem;
class QQuickWindow;
 
namespace KWin
{
class GLTexture;
 
class OffscreenQuickView;
 
class KWIN_EXPORT OffscreenQuickView : public QObject
{
    Q_OBJECT
 
public:
    enum class ExportMode {
        Texture,
        Image
    };
 
    explicit OffscreenQuickView(ExportMode exportMode = ExportMode::Texture, bool alpha = true);
 
    ~OffscreenQuickView();
 
    QSize size() const;
 
    void setGeometry(const QRect &rect);
    QRect geometry() const;
 
    void setOpacity(qreal opacity);
    qreal opacity() const;
    bool hasAlphaChannel() const;
 
    void update();
 
    QQuickItem *contentItem() const;
    QQuickWindow *window() const;
 
    void setVisible(bool visible);
    bool isVisible() const;
 
    void show();
    void hide();
 
    bool automaticRepaint() const;
    void setAutomaticRepaint(bool set);
 
    GLTexture *bufferAsTexture();
 
    QImage bufferAsImage() const;
 
    void forwardMouseEvent(QEvent *mouseEvent);
    void forwardKeyEvent(QKeyEvent *keyEvent);
 
    bool forwardTouchDown(qint32 id, const QPointF &pos, std::chrono::microseconds time);
    bool forwardTouchMotion(qint32 id, const QPointF &pos, std::chrono::microseconds time);
    bool forwardTouchUp(qint32 id, std::chrono::microseconds time);
 
Q_SIGNALS:
    void repaintNeeded();
    void geometryChanged(const QRect &oldGeometry, const QRect &newGeometry);
    void renderRequested();
    void sceneChanged();
 
private:
    void handleRenderRequested();
    void handleSceneChanged();
 
    class Private;
    std::unique_ptr<Private> d;
};
 
class KWIN_EXPORT OffscreenQuickScene : public OffscreenQuickView
{
public:
    explicit OffscreenQuickScene(ExportMode exportMode = ExportMode::Texture, bool alpha = true);
    ~OffscreenQuickScene();
 
    QQuickItem *rootItem() const;
 
    void setSource(const QUrl &source);
    void setSource(const QUrl &source, const QVariantMap &initialProperties);
 
private:
    class Private;
    std::unique_ptr<Private> d;
};
 
}