screenshot.h

Go to the documentation of this file.

/*
    KWin - the KDE window manager
    This file is part of the KDE project.
 
    SPDX-FileCopyrightText: 2010 Martin Gräßlin <mgraesslin@kde.org>
    SPDX-FileCopyrightText: 2021 Vlad Zahorodnii <vlad.zahorodnii@kde.org>
 
    SPDX-License-Identifier: GPL-2.0-or-later
*/
 
#pragma once
 
#include "effect/effect.h"
 
#include <QFuture>
#include <QImage>
#include <QObject>
 
namespace KWin
{
 
enum ScreenShotFlag {
    ScreenShotIncludeDecoration = 0x1, 
    ScreenShotIncludeCursor = 0x2, 
    ScreenShotNativeResolution = 0x4, 
    ScreenShotIncludeShadow = 0x8, 
};
Q_DECLARE_FLAGS(ScreenShotFlags, ScreenShotFlag)
 
class ScreenShotDBusInterface2;
struct ScreenShotWindowData;
struct ScreenShotAreaData;
struct ScreenShotScreenData;
 
class ScreenShotEffect : public Effect
{
    Q_OBJECT
 
public:
    ScreenShotEffect();
    ~ScreenShotEffect() override;
 
    QFuture<QImage> scheduleScreenShot(Output *screen, ScreenShotFlags flags = {});
 
    QFuture<QImage> scheduleScreenShot(const QRect &area, ScreenShotFlags flags = {});
 
    QFuture<QImage> scheduleScreenShot(EffectWindow *window, ScreenShotFlags flags = {});
 
    void paintScreen(const RenderTarget &renderTarget, const RenderViewport &viewport, int mask, const QRegion &region, Output *screen) override;
    bool isActive() const override;
    int requestedEffectChainPosition() const override;
 
    static bool supported();
 
private Q_SLOTS:
    void handleWindowClosed(EffectWindow *window);
    void handleScreenAdded();
    void handleScreenRemoved(Output *screen);
 
private:
    void takeScreenShot(ScreenShotWindowData *screenshot);
    bool takeScreenShot(const RenderTarget &renderTarget, const RenderViewport &viewport, ScreenShotAreaData *screenshot);
    bool takeScreenShot(const RenderTarget &renderTarget, const RenderViewport &viewport, ScreenShotScreenData *screenshot);
 
    void cancelWindowScreenShots();
    void cancelAreaScreenShots();
    void cancelScreenScreenShots();
 
    void grabPointerImage(QImage &snapshot, int xOffset, int yOffset) const;
    QImage blitScreenshot(const RenderTarget &renderTarget, const RenderViewport &viewport, const QRect &geometry, qreal devicePixelRatio = 1.0) const;
 
    std::vector<ScreenShotWindowData> m_windowScreenShots;
    std::vector<ScreenShotAreaData> m_areaScreenShots;
    std::vector<ScreenShotScreenData> m_screenScreenShots;
 
    std::unique_ptr<ScreenShotDBusInterface2> m_dbusInterface2;
    Output *m_paintedScreen = nullptr;
};
 
} // namespace KWin
 
Q_DECLARE_OPERATORS_FOR_FLAGS(KWin::ScreenShotFlags)