kwin/autotests/mock_effectshandler.h
Martin Gräßlin 142aab2e24 Introduce an EffectsHandler::animationsSupported -> bool
Summary:
A new method to tell the effects system whether the compositor scene
is able to drive animations. E.g. on software emulation (llvmpipe) it's
better to not do any animations at all.

This information can be used by effects to adjust their behavior, e.g.
PresentWindows could skip transitions or effects can use it in their
supported check to completely disable themselves.

As a first step all scripted effects are considered to be unsupported
if animations are not supported. They inherit AnimationEffect and are
all about driving animations.

The information whether animations are supported comes from the Scene.
It's implemented in the following way:
 * XRender: animations are always supported
 * QPainter: animations are never supported
 * OpenGL: animations are supported, except for software emulation

In addition - for easier testing - there is a new env variable
KWIN_EFFECTS_FORCE_ANIMATIONS to overwrite the selection.

Reviewers: #kwin, #plasma

Subscribers: kwin

Tags: #kwin

Differential Revision: https://phabricator.kde.org/D2386
2016-08-15 17:38:33 +02:00

243 lines
8.3 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>
class MockEffectsHandler : public KWin::EffectsHandler
{
Q_OBJECT
public:
explicit MockEffectsHandler(KWin::CompositingType type);
void activateWindow(KWin::EffectWindow *) override {}
KWin::Effect *activeFullScreenEffect() const {
return nullptr;
}
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 {}
void deleteRootProperty(long int) const 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;
}
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 registerPropertyType(long int, bool) override {}
void reloadEffect(KWin::Effect *) override {}
void removeSupportProperty(const QByteArray &, KWin::Effect *) override {}
void reserveElectricBorder(KWin::ElectricBorder, KWin::Effect *) 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;
}
private:
bool m_animationsSuported = true;
};
#endif