outputlayer.h

Go to the documentation of this file.

/*
    SPDX-FileCopyrightText: 2022 Vlad Zahorodnii <vlad.zahorodnii@kde.org>
 
    SPDX-License-Identifier: GPL-2.0-or-later
*/
 
#pragma once
 
#include "core/rendertarget.h"
#include "kwin_export.h"
 
#include <QObject>
#include <QRegion>
#include <chrono>
#include <optional>
 
namespace KWin
{
 
class SurfaceItem;
 
struct OutputLayerBeginFrameInfo
{
    RenderTarget renderTarget;
    QRegion repaint;
};
 
class KWIN_EXPORT OutputLayer : public QObject
{
    Q_OBJECT
public:
    explicit OutputLayer(QObject *parent = nullptr);
 
    qreal scale() const;
    void setScale(qreal scale);
 
    QPointF hotspot() const;
    void setHotspot(const QPointF &hotspot);
 
    QSizeF size() const;
    void setSize(const QSizeF &size);
    virtual std::optional<QSize> fixedSize() const;
 
    QRegion repaints() const;
    void resetRepaints();
    void addRepaint(const QRegion &region);
    bool needsRepaint() const;
 
    void setPosition(const QPointF &position);
    QPointF position() const;
 
    void setEnabled(bool enable);
    bool isEnabled() const;
 
    virtual std::optional<OutputLayerBeginFrameInfo> beginFrame() = 0;
    virtual bool endFrame(const QRegion &renderedRegion, const QRegion &damagedRegion) = 0;
 
    virtual bool scanout(SurfaceItem *surfaceItem);
 
    virtual std::chrono::nanoseconds queryRenderTime() const = 0;
 
private:
    QRegion m_repaints;
    QPointF m_hotspot;
    QPointF m_position;
    QSizeF m_size;
    qreal m_scale = 1.0;
    bool m_enabled = false;
};
 
} // namespace KWin