compositor_x11.h

Go to the documentation of this file.

/*
    KWin - the KDE window manager
    This file is part of the KDE project.
 
    SPDX-FileCopyrightText: 2011 Arthur Arlt <a.arlt@stud.uni-heidelberg.de>
    SPDX-FileCopyrightText: 2012 Martin Gräßlin <mgraesslin@kde.org>
 
    SPDX-License-Identifier: GPL-2.0-or-later
*/
 
#pragma once
 
#include "compositor.h"
#include <QSet>
 
namespace KWin
{
 
class X11CompositorSelectionOwner;
class X11SyncManager;
class X11Window;
 
class KWIN_EXPORT X11Compositor final : public Compositor
{
    Q_OBJECT
public:
    enum SuspendReason {
        NoReasonSuspend = 0,
        UserSuspend = 1 << 0,
        BlockRuleSuspend = 1 << 1,
        AllReasonSuspend = 0xff
    };
    Q_DECLARE_FLAGS(SuspendReasons, SuspendReason)
    Q_ENUM(SuspendReason)
    Q_FLAG(SuspendReasons)
 
    static X11Compositor *create(QObject *parent = nullptr);
    ~X11Compositor() override;
 
    X11SyncManager *syncManager() const;
 
    void toggle();
 
    void suspend(SuspendReason reason);
 
    void resume(SuspendReason reason);
 
    enum class OpenGLSafePoint {
        PreInit,
        PostInit,
        PreFrame,
        PostFrame,
        PostLastGuardedFrame
    };
    void createOpenGLSafePoint(OpenGLSafePoint safePoint);
 
    void inhibit(Window *window) override;
    void uninhibit(Window *window) override;
 
    void reinitialize() override;
    bool compositingPossible() const override;
    QString compositingNotPossibleReason() const override;
    bool openGLCompositingIsBroken() const override;
 
    static X11Compositor *self();
 
protected:
    void start() override;
    void stop() override;
    void composite(RenderLoop *renderLoop) override;
 
private:
    explicit X11Compositor(QObject *parent);
 
    bool attemptOpenGLCompositing();
 
    void releaseCompositorSelection();
    void destroyCompositorSelection();
 
    std::unique_ptr<QThread> m_openGLFreezeProtectionThread;
    std::unique_ptr<QTimer> m_openGLFreezeProtection;
    std::unique_ptr<X11SyncManager> m_syncManager;
    std::unique_ptr<X11CompositorSelectionOwner> m_selectionOwner;
    QTimer m_releaseSelectionTimer;
    SuspendReasons m_suspended;
    QSet<Window *> m_inhibitors;
    int m_framesToTestForSafety = 3;
};
 
} // namespace KWin