Surface.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 fuddlesworth
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#pragma once
 
#include <PhosphorLayer/SurfaceConfig.h>
#include <PhosphorLayer/phosphorlayer_export.h>
 
#include <QObject>
#include <QString>
 
#include <memory>
 
QT_BEGIN_NAMESPACE
class QQuickWindow;
QT_END_NAMESPACE
 
namespace PhosphorLayer {
 
class ILayerShellTransport;
class IQmlEngineProvider;
class IScreenProvider;
class ISurfaceAnimator;
class ITransportHandle;
class SurfaceFactory;
 
struct SurfaceDeps
{
    ILayerShellTransport* transport = nullptr;
    IQmlEngineProvider* engineProvider = nullptr; // Optional — nullptr = per-surface engine
    IScreenProvider* screenProvider = nullptr;
    ISurfaceAnimator* animator = nullptr;
    QString loggingCategory;
};
 
class PHOSPHORLAYER_EXPORT Surface : public QObject
{
    Q_OBJECT
    Q_PROPERTY(State state READ state NOTIFY stateChanged FINAL)
 
public:
    enum class State {
        Constructed, 
        Warming, 
        Shown, 
        Hidden, 
        Failed, 
    };
    Q_ENUM(State)
 
    ~Surface() override;
 
    State state() const noexcept;
    const SurfaceConfig& config() const noexcept;
 
    [[nodiscard]] bool isLogicallyShown() const noexcept;
 
public Q_SLOTS:
    void show();
    void hide();
    void warmUp();
 
public:
    QQuickWindow* window() const noexcept;
    ITransportHandle* transport() const noexcept;
 
Q_SIGNALS:
    void stateChanged(State newState);
 
    void failed(const QString& reason);
 
    void screenLost();
 
public:
    class CtorToken
    {
        friend class SurfaceFactory;
        CtorToken() = default;
    };
 
protected:
    Surface(CtorToken, SurfaceConfig cfg, SurfaceDeps deps, QObject* parent);
 
private:
    Q_DISABLE_COPY_MOVE(Surface)
 
    friend class SurfaceFactory;
 
    class Impl;
    std::unique_ptr<Impl> m_impl;
};
 
} // namespace PhosphorLayer