shadow.h

Go to the documentation of this file.

/*
    KWin - the KDE window manager
    This file is part of the KDE project.
 
    SPDX-FileCopyrightText: 2011 Martin Gräßlin <mgraesslin@kde.org>
    SPDX-FileCopyrightText: 2020 Vlad Zahorodnii <vlad.zahorodnii@kde.org>
 
    SPDX-License-Identifier: GPL-2.0-or-later
*/
#pragma once
 
#include "kwin_export.h"
 
#include <QImage>
#include <QObject>
#include <QRectF>
 
#include <xcb/xcb.h>
 
namespace KDecoration2
{
class Decoration;
class DecorationShadow;
}
 
namespace KWin
{
 
class ShadowInterface;
class Window;
 
class KWIN_EXPORT Shadow : public QObject
{
    Q_OBJECT
public:
    explicit Shadow(Window *window);
    ~Shadow() override;
 
    bool updateShadow();
 
    static std::unique_ptr<Shadow> createShadow(Window *window);
 
    Window *window() const;
 
    bool hasDecorationShadow() const
    {
        return m_decorationShadow != nullptr;
    }
    QImage decorationShadowImage() const;
 
    std::weak_ptr<KDecoration2::DecorationShadow> decorationShadow() const
    {
        return m_decorationShadow;
    }
 
    enum ShadowElements {
        ShadowElementTop,
        ShadowElementTopRight,
        ShadowElementRight,
        ShadowElementBottomRight,
        ShadowElementBottom,
        ShadowElementBottomLeft,
        ShadowElementLeft,
        ShadowElementTopLeft,
        ShadowElementsCount
    };
    QSize elementSize(ShadowElements element) const;
 
    QRectF rect() const
    {
        return QRectF(QPoint(0, 0), m_cachedSize);
    }
    QMargins offset() const
    {
        return m_offset;
    }
    inline const QImage &shadowElement(ShadowElements element) const
    {
        return m_shadowElements[element];
    }
 
Q_SIGNALS:
    void offsetChanged();
    void rectChanged();
    void textureChanged();
 
public Q_SLOTS:
    void geometryChanged();
 
private:
    static std::unique_ptr<Shadow> createShadowFromX11(Window *window);
    static std::unique_ptr<Shadow> createShadowFromDecoration(Window *window);
    static std::unique_ptr<Shadow> createShadowFromWayland(Window *window);
    static std::unique_ptr<Shadow> createShadowFromInternalWindow(Window *window);
    static QList<uint32_t> readX11ShadowProperty(xcb_window_t id);
    bool init(const QList<uint32_t> &data);
    bool init(KDecoration2::Decoration *decoration);
    bool init(const QPointer<ShadowInterface> &shadow);
    bool init(const QWindow *window);
    Window *m_window;
    // shadow elements
    QImage m_shadowElements[ShadowElementsCount];
    // shadow offsets
    QMargins m_offset;
    // caches
    QSizeF m_cachedSize;
    // Decoration based shadows
    std::shared_ptr<KDecoration2::DecorationShadow> m_decorationShadow;
};
 
}