surface.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_SURFACE_H
#define WAYLAND_SURFACE_H

#include "buffer.h"

#include <QObject>
#include <QPoint>
#include <QSize>
#include <QWindow>

#include <KWayland/Client/kwaylandclient_export.h>

struct wl_buffer;
struct wl_surface;

class QWindow;

namespace KWayland
{
namespace Client
{

class Output;
class Region;

class KWAYLANDCLIENT_EXPORT Surface : public QObject
{
    Q_OBJECT
public:
    explicit Surface(QObject *parent = nullptr);
    virtual ~Surface();

    static Surface *fromWindow(QWindow *window);

    static Surface *fromQtWinId(WId wid);

    void setup(wl_surface *surface);
    void release();
    void destroy();
    bool isValid() const;
    void setupFrameCallback();
    enum class CommitFlag {
        None,
        FrameCallback
    };
    void commit(CommitFlag flag = CommitFlag::FrameCallback);
    void damage(const QRect &rect);
    void damage(const QRegion &region);
    void damageBuffer(const QRect &rect);
    void damageBuffer(const QRegion &region);
    void attachBuffer(wl_buffer *buffer, const QPoint &offset = QPoint());
    void attachBuffer(Buffer *buffer, const QPoint &offset = QPoint());
    void attachBuffer(Buffer::Ptr buffer, const QPoint &offset = QPoint());
    void setInputRegion(const Region *region = nullptr);
    void setOpaqueRegion(const Region *region = nullptr);
    void setSize(const QSize &size);
    QSize size() const;

    void setScale(qint32 scale);
    qint32 scale() const;

    operator wl_surface*();
    operator wl_surface*() const;

    quint32 id() const;

    QVector<Output *> outputs() const;

    static const QList<Surface*> &all(); // krazy:exclude=constref
    static Surface *get(wl_surface *native);

Q_SIGNALS:
    void frameRendered();
    void sizeChanged(const QSize&);

    void outputEntered(KWayland::Client::Output *o);

    void outputLeft(KWayland::Client::Output *o);

private:
    class Private;
    QScopedPointer<Private> d;
};

}
}

#endif