kwin/effects/desktopgrid/desktopgrid.h
Vlad Zahorodnii 9f2cb0ae1b Provide expected presentation time to effects
Effects are given the interval between two consecutive frames. The main
flaw of this approach is that if the Compositor transitions from the idle
state to "active" state, i.e. when there is something to repaint,
effects may see a very large interval between the last painted frame and
the current. In order to address this issue, the Scene invalidates the
timer that is used to measure time between consecutive frames before the
Compositor is about to become idle.

While this works perfectly fine with Xinerama-style rendering, with per
screen rendering, determining whether the compositor is about to idle is
rather a tedious task mostly because a single output can't be used for
the test.

Furthermore, since the Compositor schedules pointless repaints just to
ensure that it's idle, it might take several attempts to figure out
whether the scene timer must be invalidated if you use (true) per screen
rendering.

Ideally, all effects should use a timeline helper that is aware of the
underlying render loop and its timings. However, this option is off the
table because it will involve a lot of work to implement it.

Alternative and much simpler option is to pass the expected presentation
time to effects rather than time between consecutive frames. This means
that effects are responsible for determining how much animation timelines
have to be advanced. Typically, an effect would have to store the
presentation timestamp provided in either prePaint{Screen,Window} and
use it in the subsequent prePaint{Screen,Window} call to estimate the
amount of time passed between the next and the last frames.

Unfortunately, this is an API incompatible change. However, it shouldn't
take a lot of work to port third-party binary effects, which don't use the
AnimationEffect class, to the new API. On the bright side, we no longer
need to be concerned about the Compositor getting idle.

We do still try to determine whether the Compositor is about to idle,
primarily, because the OpenGL render backend swaps buffers on present,
but that will change with the ongoing compositing timing rework.
2020-12-10 07:14:42 +00:00

166 lines
5.2 KiB
C++

/*
KWin - the KDE window manager
This file is part of the KDE project.
SPDX-FileCopyrightText: 2007 Lubos Lunak <l.lunak@kde.org>
SPDX-FileCopyrightText: 2008 Lucas Murray <lmurray@undefinedfire.com>
SPDX-License-Identifier: GPL-2.0-or-later
*/
#ifndef KWIN_DESKTOPGRID_H
#define KWIN_DESKTOPGRID_H
#include <kwineffects.h>
#include <QObject>
#include <QTimeLine>
class QTimer;
#include "kwineffectquickview.h"
namespace KWin
{
class PresentWindowsEffectProxy;
class DesktopGridEffect
: public Effect
{
Q_OBJECT
Q_PROPERTY(int zoomDuration READ configuredZoomDuration)
Q_PROPERTY(int border READ configuredBorder)
Q_PROPERTY(Qt::Alignment desktopNameAlignment READ configuredDesktopNameAlignment)
Q_PROPERTY(int layoutMode READ configuredLayoutMode)
Q_PROPERTY(int customLayoutRows READ configuredCustomLayoutRows)
Q_PROPERTY(bool usePresentWindows READ isUsePresentWindows)
// TODO: electric borders
public:
DesktopGridEffect();
~DesktopGridEffect() override;
void reconfigure(ReconfigureFlags) override;
void prePaintScreen(ScreenPrePaintData& data, std::chrono::milliseconds presentTime) override;
void paintScreen(int mask, const QRegion &region, ScreenPaintData& data) override;
void postPaintScreen() override;
void prePaintWindow(EffectWindow* w, WindowPrePaintData& data, std::chrono::milliseconds presentTime) override;
void paintWindow(EffectWindow* w, int mask, QRegion region, WindowPaintData& data) override;
void windowInputMouseEvent(QEvent* e) override;
void grabbedKeyboardEvent(QKeyEvent* e) override;
bool borderActivated(ElectricBorder border) override;
bool isActive() const override;
int requestedEffectChainPosition() const override {
return 50;
}
enum { LayoutPager, LayoutAutomatic, LayoutCustom }; // Layout modes
enum { SwitchDesktopAndActivateWindow, SwitchDesktopOnly }; // Click behavior
// for properties
int configuredZoomDuration() const {
return zoomDuration;
}
int configuredBorder() const {
return border;
}
Qt::Alignment configuredDesktopNameAlignment() const {
return desktopNameAlignment;
}
int configuredLayoutMode() const {
return layoutMode;
}
int configuredCustomLayoutRows() const {
return customLayoutRows;
}
bool isUsePresentWindows() const {
return clickBehavior == SwitchDesktopAndActivateWindow;
}
private Q_SLOTS:
void toggle();
// slots for global shortcut changed
// needed to toggle the effect
void globalShortcutChanged(QAction *action, const QKeySequence& seq);
void slotAddDesktop();
void slotRemoveDesktop();
void slotWindowAdded(KWin::EffectWindow* w);
void slotWindowClosed(KWin::EffectWindow *w);
void slotWindowDeleted(KWin::EffectWindow *w);
void slotNumberDesktopsChanged(uint old);
void slotWindowFrameGeometryChanged(KWin::EffectWindow *w, const QRect &old);
private:
QPointF scalePos(const QPoint& pos, int desktop, int screen = -1) const;
QPoint unscalePos(const QPoint& pos, int* desktop = nullptr) const;
int posToDesktop(const QPoint& pos) const;
EffectWindow* windowAt(QPoint pos) const;
void setCurrentDesktop(int desktop);
void setHighlightedDesktop(int desktop);
int desktopToRight(int desktop, bool wrap = true) const;
int desktopToLeft(int desktop, bool wrap = true) const;
int desktopUp(int desktop, bool wrap = true) const;
int desktopDown(int desktop, bool wrap = true) const;
void setActive(bool active);
void setup();
void setupGrid();
void finish();
bool isMotionManagerMovingWindows() const;
bool isRelevantWithPresentWindows(EffectWindow *w) const;
bool isUsingPresentWindows() const;
QRectF moveGeometryToDesktop(int desktop) const;
void desktopsAdded(int old);
void desktopsRemoved(int old);
QVector<int> desktopList(const EffectWindow *w) const;
QList<ElectricBorder> borderActivate;
int zoomDuration;
int border;
Qt::Alignment desktopNameAlignment;
int layoutMode;
int customLayoutRows;
int clickBehavior;
bool activated;
QTimeLine timeline;
int paintingDesktop;
int highlightedDesktop;
int sourceDesktop;
int m_originalMovingDesktop;
bool keyboardGrab;
bool wasWindowMove, wasWindowCopy, wasDesktopMove, isValidMove;
EffectWindow* windowMove;
QPoint windowMoveDiff;
QPoint dragStartPos;
QTimer *windowMoveElevateTimer;
std::chrono::milliseconds lastPresentTime;
// Soft highlighting
QList<QTimeLine*> hoverTimeline;
QList< EffectFrame* > desktopNames;
QSize gridSize;
Qt::Orientation orientation;
QPoint activeCell;
// Per screen variables
QList<double> scale; // Because the border isn't a ratio each screen is different
QList<double> unscaledBorder;
QList<QSizeF> scaledSize;
QList<QPointF> scaledOffset;
// Shortcut - needed to toggle the effect
QList<QKeySequence> shortcut;
PresentWindowsEffectProxy* m_proxy;
QList<WindowMotionManager> m_managers;
QRect m_windowMoveGeometry;
QPoint m_windowMoveStartPoint;
QVector<EffectQuickScene*> m_desktopButtons;
QAction *m_activateAction;
};
} // namespace
#endif