kwin/autotests/mock_effectshandler.h
David Edmundson 40b0296d5c [libkwineffects] Introduce API to easily show a QtQuick scene in an effect
Summary:
EffectQuickView/Scene is a convenient class to render a QtQuick
scenegraph into an effect.

Current methods (such as present windows) involve creating an underlying
platform window which is expensive, causes a headache to filter out
again in the rest of the code, and only works as an overlay.

The new class exposes things more natively to an effect where we don't
mess with real windows, we can perform the painting anywhere in the view
and we don't have issues with hiding/closing.

QtQuick has both software and hardware accelerated modes, and kwin also
has 3 render backends. Every combination is supported.

* When used in OpenGL mode for both, we render into an FBO export the
texture ID then it's up to the effect to render that into a scene.

* When using software QtQuick rendering we blit into an image, upload
that into a KWinGLTexture which serves as an abstraction layer and
render that into the scene.

* When using GL for QtQuick and XRender/QPainter in kwin everything is
rendered into the internal FBO, blit and exported as an image.

* When using software rendering for both an image gets passed directly.

Mouse and keyboard events can be forwarded, only if the effect
intercepts them.

The class is meant to be generic enough that we can remove all the
QtQuick code from Aurorae.

The intention is also to replace EffectFrameImpl using this backend and
we can kill all of the EffectFrame code throughout the scenes.

The close button in present windows will also be ported to this,
simplifiying that code base.

Classes that handle the rendering and handling QML are intentionally
split so that in the future we can have a declarative effects API create
overlays from within the same context. Similar to how one can
instantiate windows from a typical QML scene.

Notes:
I don't like how I pass the kwin GL context from the backends into the
effect, but I need something that works with the library separation. It
also currently has wayland problem if I create a QOpenGLContext before
the QPA is set up with a scene - but I don't have anything better?

I know for the EffectFrame we need an API to push things through the
effects stack to handle blur/invert etc. Will deal with that when we
port the EffectFrame.

Test Plan: Used in an effect

Reviewers: #kwin, zzag

Reviewed By: #kwin, zzag

Subscribers: zzag, kwin

Tags: #kwin

Differential Revision: https://phabricator.kde.org/D24215
2019-09-27 16:11:05 +01:00

288 lines
9.8 KiB
C++

/********************************************************************
KWin - the KDE window manager
This file is part of the KDE project.
Copyright (C) 2014 Martin Gräßlin <mgraesslin@kde.org>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*********************************************************************/
#ifndef MOCK_EFFECTS_HANDLER_H
#define MOCK_EFFECTS_HANDLER_H
#include <kwineffects.h>
#include <QX11Info>
class MockEffectsHandler : public KWin::EffectsHandler
{
Q_OBJECT
public:
explicit MockEffectsHandler(KWin::CompositingType type);
void activateWindow(KWin::EffectWindow *) override {}
KWin::Effect *activeFullScreenEffect() const override {
return nullptr;
}
bool hasActiveFullScreenEffect() const override {
return false;
}
int activeScreen() const override {
return 0;
}
KWin::EffectWindow *activeWindow() const override {
return nullptr;
}
void addRepaint(const QRect &) override {}
void addRepaint(const QRegion &) override {}
void addRepaint(int, int, int, int) override {}
void addRepaintFull() override {}
double animationTimeFactor() const override {
return 0;
}
xcb_atom_t announceSupportProperty(const QByteArray &, KWin::Effect *) override {
return XCB_ATOM_NONE;
}
void buildQuads(KWin::EffectWindow *, KWin::WindowQuadList &) override {}
QRect clientArea(KWin::clientAreaOption, const QPoint &, int) const override {
return QRect();
}
QRect clientArea(KWin::clientAreaOption, const KWin::EffectWindow *) const override {
return QRect();
}
QRect clientArea(KWin::clientAreaOption, int, int) const override {
return QRect();
}
void closeTabBox() override {}
QString currentActivity() const override {
return QString();
}
int currentDesktop() const override {
return 0;
}
int currentTabBoxDesktop() const override {
return 0;
}
QList< int > currentTabBoxDesktopList() const override {
return QList<int>();
}
KWin::EffectWindow *currentTabBoxWindow() const override {
return nullptr;
}
KWin::EffectWindowList currentTabBoxWindowList() const override {
return KWin::EffectWindowList();
}
QPoint cursorPos() const override {
return QPoint();
}
bool decorationsHaveAlpha() const override {
return false;
}
bool decorationSupportsBlurBehind() const override {
return false;
}
void defineCursor(Qt::CursorShape) override {}
int desktopAbove(int, bool) const override {
return 0;
}
int desktopAtCoords(QPoint) const override {
return 0;
}
int desktopBelow(int, bool) const override {
return 0;
}
QPoint desktopCoords(int) const override {
return QPoint();
}
QPoint desktopGridCoords(int) const override {
return QPoint();
}
int desktopGridHeight() const override {
return 0;
}
QSize desktopGridSize() const override {
return QSize();
}
int desktopGridWidth() const override {
return 0;
}
QString desktopName(int) const override {
return QString();
}
int desktopToLeft(int, bool) const override {
return 0;
}
int desktopToRight(int, bool) const override {
return 0;
}
void doneOpenGLContextCurrent() override {}
void drawWindow(KWin::EffectWindow *, int, QRegion, KWin::WindowPaintData &) override {}
KWin::EffectFrame *effectFrame(KWin::EffectFrameStyle, bool, const QPoint &, Qt::Alignment) const override {
return nullptr;
}
KWin::EffectWindow *findWindow(WId) const override {
return nullptr;
}
KWin::EffectWindow *findWindow(KWayland::Server::SurfaceInterface *) const override {
return nullptr;
}
KWin::EffectWindow *findWindow(QWindow *w) const override {
Q_UNUSED(w)
return nullptr;
}
KWin::EffectWindow *findWindow(const QUuid &id) const override {
Q_UNUSED(id)
return nullptr;
}
void *getProxy(QString) override {
return nullptr;
}
bool grabKeyboard(KWin::Effect *) override {
return false;
}
bool hasDecorationShadows() const override {
return false;
}
bool isScreenLocked() const override {
return false;
}
QVariant kwinOption(KWin::KWinOption) override {
return QVariant();
}
bool makeOpenGLContextCurrent() override {
return false;
}
void moveWindow(KWin::EffectWindow *, const QPoint &, bool, double) override {}
KWin::WindowQuadType newWindowQuadType() override {
return KWin::WindowQuadError;
}
int numberOfDesktops() const override {
return 0;
}
int numScreens() const override {
return 0;
}
bool optionRollOverDesktops() const override {
return false;
}
void paintEffectFrame(KWin::EffectFrame *, QRegion, double, double) override {}
void paintScreen(int, QRegion, KWin::ScreenPaintData &) override {}
void paintWindow(KWin::EffectWindow *, int, QRegion, KWin::WindowPaintData &) override {}
void postPaintScreen() override {}
void postPaintWindow(KWin::EffectWindow *) override {}
void prePaintScreen(KWin::ScreenPrePaintData &, int) override {}
void prePaintWindow(KWin::EffectWindow *, KWin::WindowPrePaintData &, int) override {}
QByteArray readRootProperty(long int, long int, int) const override {
return QByteArray();
}
void reconfigure() override {}
void refTabBox() override {}
void registerAxisShortcut(Qt::KeyboardModifiers, KWin::PointerAxisDirection, QAction *) override {}
void registerGlobalShortcut(const QKeySequence &, QAction *) override {}
void registerPointerShortcut(Qt::KeyboardModifiers, Qt::MouseButton, QAction *) override {}
void registerTouchpadSwipeShortcut(KWin::SwipeDirection, QAction *) override {}
void reloadEffect(KWin::Effect *) override {}
void removeSupportProperty(const QByteArray &, KWin::Effect *) override {}
void reserveElectricBorder(KWin::ElectricBorder, KWin::Effect *) override {}
void registerTouchBorder(KWin::ElectricBorder, QAction *) override {}
void unregisterTouchBorder(KWin::ElectricBorder, QAction *) override {}
QPainter *scenePainter() override {
return nullptr;
}
int screenNumber(const QPoint &) const override {
return 0;
}
void setActiveFullScreenEffect(KWin::Effect *) override {}
void setCurrentDesktop(int) override {}
void setElevatedWindow(KWin::EffectWindow *, bool) override {}
void setNumberOfDesktops(int) override {}
void setShowingDesktop(bool) override {}
void setTabBoxDesktop(int) override {}
void setTabBoxWindow(KWin::EffectWindow*) override {}
KWin::EffectWindowList stackingOrder() const override {
return KWin::EffectWindowList();
}
void startMouseInterception(KWin::Effect *, Qt::CursorShape) override {}
void startMousePolling() override {}
void stopMouseInterception(KWin::Effect *) override {}
void stopMousePolling() override {}
void ungrabKeyboard() override {}
void unrefTabBox() override {}
void unreserveElectricBorder(KWin::ElectricBorder, KWin::Effect *) override {}
QRect virtualScreenGeometry() const override {
return QRect();
}
QSize virtualScreenSize() const override {
return QSize();
}
void windowToDesktop(KWin::EffectWindow *, int) override {}
void windowToScreen(KWin::EffectWindow *, int) override {}
int workspaceHeight() const override {
return 0;
}
int workspaceWidth() const override {
return 0;
}
long unsigned int xrenderBufferPicture() override {
return 0;
}
xcb_connection_t *xcbConnection() const override {
return QX11Info::connection();
}
xcb_window_t x11RootWindow() const override {
return QX11Info::appRootWindow();
}
KWayland::Server::Display *waylandDisplay() const override {
return nullptr;
}
bool animationsSupported() const override {
return m_animationsSuported;
}
void setAnimationsSupported(bool set) {
m_animationsSuported = set;
}
KWin::PlatformCursorImage cursorImage() const override {
return KWin::PlatformCursorImage();
}
void hideCursor() override {}
void showCursor() override {}
void startInteractiveWindowSelection(std::function<void(KWin::EffectWindow*)> callback) override {
callback(nullptr);
}
void startInteractivePositionSelection(std::function<void (const QPoint &)> callback) override {
callback(QPoint(-1, -1));
}
void showOnScreenMessage(const QString &message, const QString &iconName = QString()) override {
Q_UNUSED(message)
Q_UNUSED(iconName)
}
void hideOnScreenMessage(OnScreenMessageHideFlags flags = OnScreenMessageHideFlags()) override { Q_UNUSED(flags)}
void windowToDesktops(KWin::EffectWindow *w, const QVector<uint> &desktops) override {
Q_UNUSED(w)
Q_UNUSED(desktops)
}
KSharedConfigPtr config() const override;
KSharedConfigPtr inputConfig() const override;
void renderEffectQuickView(KWin::EffectQuickView *quickView) const override {
Q_UNUSED(quickView);
}
private:
bool m_animationsSuported = true;
};
#endif