surface_interface.h

/*
    SPDX-FileCopyrightText: 2014 Martin Gräßlin <[email protected]>

    SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
*/
#ifndef WAYLAND_SERVER_SURFACE_INTERFACE_H
#define WAYLAND_SERVER_SURFACE_INTERFACE_H

#include "resource.h"
#include "output_interface.h"

#include <QObject>
#include <QPointer>
#include <QRegion>

#include <KWayland/Server/kwaylandserver_export.h>

namespace KWayland
{
namespace Server
{
class BlurManagerInterface;
class BlurInterface;
class BufferInterface;
class ConfinedPointerInterface;
class ContrastInterface;
class ContrastManagerInterface;
class CompositorInterface;
class IdleInhibitManagerUnstableV1Interface;
class LockedPointerInterface;
class PointerConstraintsUnstableV1Interface;
class ShadowManagerInterface;
class ShadowInterface;
class SlideInterface;
class SubSurfaceInterface;

class KWAYLANDSERVER_EXPORT SurfaceInterface : public Resource
{
    Q_OBJECT
    Q_PROPERTY(QRegion damage READ damage NOTIFY damaged)
    Q_PROPERTY(QRegion opaque READ opaque NOTIFY opaqueChanged)
    Q_PROPERTY(QRegion input READ input NOTIFY inputChanged)
    Q_PROPERTY(qint32 scale READ scale NOTIFY scaleChanged)
    Q_PROPERTY(KWayland::Server::OutputInterface::Transform transform READ transform NOTIFY transformChanged)
    Q_PROPERTY(QSize size READ size NOTIFY sizeChanged)
public:
    virtual ~SurfaceInterface();

    void frameRendered(quint32 msec);

    QRegion damage() const;
    QRegion opaque() const;
    QRegion input() const;
#if KWAYLANDSERVER_ENABLE_DEPRECATED_SINCE(5, 5)

    KWAYLANDSERVER_DEPRECATED_VERSION(5, 5, "Use SurfaceInterface::inputIsInfinite()")
    bool inputIsInfitine() const;
#endif

    bool inputIsInfinite() const;
    qint32 scale() const;
    OutputInterface::Transform transform() const;
    BufferInterface *buffer();
    QPoint offset() const;
    QSize size() const;
    QRect boundingRect() const;

    QPointer<SubSurfaceInterface> subSurface() const;
    QList<QPointer<SubSurfaceInterface>> childSubSurfaces() const;

    QPointer<ShadowInterface> shadow() const;

    QPointer<BlurInterface> blur() const;

    QPointer<SlideInterface> slideOnShowHide() const;

    QPointer<ContrastInterface> contrast() const;

    bool isMapped() const;

    QRegion trackedDamage() const;

    void resetTrackedDamage();

    SurfaceInterface *surfaceAt(const QPointF &position);

    SurfaceInterface *inputSurfaceAt(const QPointF &position);

    void setOutputs(const QVector<OutputInterface *> &outputs);

    QVector<OutputInterface *> outputs() const;

    QPointer<ConfinedPointerInterface> confinedPointer() const;

    QPointer<LockedPointerInterface> lockedPointer() const;

    bool inhibitsIdle() const;

    static SurfaceInterface *get(wl_resource *native);
    static SurfaceInterface *get(quint32 id, const ClientConnection *client);

    void setDataProxy(SurfaceInterface *surface);
    SurfaceInterface* dataProxy() const;

Q_SIGNALS:
    void damaged(const QRegion&);
    void opaqueChanged(const QRegion&);
    void inputChanged(const QRegion&);
    void scaleChanged(qint32);
    void transformChanged(KWayland::Server::OutputInterface::Transform);
    void unmapped();
    void sizeChanged();
    void shadowChanged();
    void blurChanged();
    void slideOnShowHideChanged();
    void contrastChanged();
    void subSurfaceTreeChanged();
    void childSubSurfaceAdded(SubSurfaceInterface *subSurface);
    void childSubSurfaceRemoved(SubSurfaceInterface *subSurface);

    void pointerConstraintsChanged();

    void inhibitsIdleChanged();

    void committed();

private:
    friend class CompositorInterface;
    friend class SubSurfaceInterface;
    friend class ShadowManagerInterface;
    friend class BlurManagerInterface;
    friend class SlideManagerInterface;
    friend class ContrastManagerInterface;
    friend class IdleInhibitManagerUnstableV1Interface;
    friend class PointerConstraintsUnstableV1Interface;
    friend class SurfaceRole;
    explicit SurfaceInterface(CompositorInterface *parent, wl_resource *parentResource);

    class Private;
    Private *d_func() const;
};

}
}

Q_DECLARE_METATYPE(KWayland::Server::SurfaceInterface*)

#endif