kwin/effects/flipswitch/flipswitch.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

155 lines
4.4 KiB
C++

/*
KWin - the KDE window manager
This file is part of the KDE project.
SPDX-FileCopyrightText: 2008, 2009 Martin Gräßlin <mgraesslin@kde.org>
SPDX-License-Identifier: GPL-2.0-or-later
*/
#ifndef KWIN_FLIPSWITCH_H
#define KWIN_FLIPSWITCH_H
#include <kwineffects.h>
#include <QMatrix4x4>
#include <QQueue>
#include <QTimeLine>
#include <QFont>
namespace KWin
{
class FlipSwitchEffect
: public Effect
{
Q_OBJECT
Q_PROPERTY(bool tabBox READ isTabBox)
Q_PROPERTY(bool tabBoxAlternative READ isTabBoxAlternative)
Q_PROPERTY(int duration READ duration)
Q_PROPERTY(int angle READ angle)
Q_PROPERTY(qreal xPosition READ xPosition)
Q_PROPERTY(qreal yPosition READ yPosition)
Q_PROPERTY(bool windowTitle READ isWindowTitle)
public:
FlipSwitchEffect();
~FlipSwitchEffect() 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 grabbedKeyboardEvent(QKeyEvent* e) override;
void windowInputMouseEvent(QEvent* e) override;
bool isActive() const override;
int requestedEffectChainPosition() const override {
return 50;
}
static bool supported();
// for properties
bool isTabBox() const {
return m_tabbox;
}
bool isTabBoxAlternative() const {
return m_tabboxAlternative;
}
int duration() const {
return m_timeLine.duration();
}
int angle() const {
return m_angle;
}
qreal xPosition() const {
return m_xPosition;
}
qreal yPosition() const {
return m_yPosition;
}
bool isWindowTitle() const {
return m_windowTitle;
}
private Q_SLOTS:
void toggleActiveCurrent();
void toggleActiveAllDesktops();
void globalShortcutChanged(QAction *action, const QKeySequence &shortcut);
void slotWindowAdded(KWin::EffectWindow* w);
void slotWindowClosed(KWin::EffectWindow *w);
void slotTabBoxAdded(int mode);
void slotTabBoxClosed();
void slotTabBoxUpdated();
void slotTabBoxKeyEvent(QKeyEvent* event);
private:
class ItemInfo;
enum SwitchingDirection {
DirectionForward,
DirectionBackward
};
enum FlipSwitchMode {
TabboxMode,
CurrentDesktopMode,
AllDesktopsMode
};
void setActive(bool activate, FlipSwitchMode mode);
bool isSelectableWindow(EffectWindow *w) const;
void scheduleAnimation(const SwitchingDirection& direction, int distance = 1);
void adjustWindowMultiScreen(const EffectWindow *w, WindowPaintData& data);
void selectNextOrPreviousWindow(bool forward);
inline void selectNextWindow() { selectNextOrPreviousWindow(true); }
inline void selectPreviousWindow() { selectNextOrPreviousWindow(false); }
/**
* Updates the caption of the caption frame.
* Taking care of rewording the desktop client.
* As well sets the icon for the caption frame.
*/
void updateCaption();
QQueue< SwitchingDirection> m_scheduledDirections;
EffectWindow* m_selectedWindow;
QTimeLine m_timeLine;
QTimeLine m_startStopTimeLine;
QEasingCurve m_currentAnimationEasingCurve;
std::chrono::milliseconds m_lastPresentTime;
QRect m_screenArea;
int m_activeScreen;
bool m_active;
bool m_start;
bool m_stop;
bool m_animation;
bool m_hasKeyboardGrab;
FlipSwitchMode m_mode;
EffectFrame* m_captionFrame;
QFont m_captionFont;
EffectWindowList m_flipOrderedWindows;
QHash< const EffectWindow*, ItemInfo* > m_windows;
QMatrix4x4 m_projectionMatrix;
QMatrix4x4 m_modelviewMatrix;
// options
bool m_tabbox;
bool m_tabboxAlternative;
float m_angle;
float m_xPosition;
float m_yPosition;
bool m_windowTitle;
// Shortcuts
QList<QKeySequence> m_shortcutCurrent;
QList<QKeySequence> m_shortcutAll;
};
class FlipSwitchEffect::ItemInfo
{
public:
ItemInfo();
~ItemInfo();
bool deleted;
double opacity;
double brightness;
double saturation;
};
} // namespace
#endif