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

156 lines
4.4 KiB
C++

/*
KWin - the KDE window manager
This file is part of the KDE project.
SPDX-FileCopyrightText: 2008 Martin Gräßlin <mgraesslin@kde.org>
SPDX-License-Identifier: GPL-2.0-or-later
*/
#ifndef KWIN_COVERSWITCH_H
#define KWIN_COVERSWITCH_H
#include <QHash>
#include <QRect>
#include <QRegion>
#include <QSize>
#include <QFont>
#include <QQueue>
#include <kwineffects.h>
#include <kwinglutils.h>
namespace KWin
{
class CoverSwitchEffect
: public Effect
{
Q_OBJECT
Q_PROPERTY(int animationDuration READ configuredAnimationDuration)
Q_PROPERTY(bool animateSwitch READ isAnimateSwitch)
Q_PROPERTY(bool animateStart READ isAnimateStart)
Q_PROPERTY(bool animateStop READ isAnimateStop)
Q_PROPERTY(bool reflection READ isReflection)
Q_PROPERTY(bool windowTitle READ isWindowTitle)
Q_PROPERTY(qreal zPosition READ windowZPosition)
Q_PROPERTY(bool primaryTabBox READ isPrimaryTabBox)
Q_PROPERTY(bool secondaryTabBox READ isSecondaryTabBox)
// TODO: mirror colors
public:
CoverSwitchEffect();
~CoverSwitchEffect() 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 paintWindow(EffectWindow *w, int mask, QRegion region, WindowPaintData &data) override;
void windowInputMouseEvent(QEvent *e) override;
bool isActive() const override;
static bool supported();
// for properties
int configuredAnimationDuration() const {
return animationDuration.count();
}
bool isAnimateSwitch() const {
return animateSwitch;
}
bool isAnimateStart() const {
return animateStart;
}
bool isAnimateStop() const {
return animateStop;
}
bool isReflection() const {
return reflection;
}
bool isWindowTitle() const {
return windowTitle;
}
qreal windowZPosition() const {
return zPosition;
}
bool isPrimaryTabBox() const {
return primaryTabBox;
}
bool isSecondaryTabBox() const {
return secondaryTabBox;
}
int requestedEffectChainPosition() const override {
return 50;
}
public Q_SLOTS:
void slotWindowClosed(KWin::EffectWindow *c);
void slotTabBoxAdded(int mode);
void slotTabBoxClosed();
void slotTabBoxUpdated();
void slotTabBoxKeyEvent(QKeyEvent* event);
private:
void paintScene(EffectWindow* frontWindow, const EffectWindowList& leftWindows, const EffectWindowList& rightWindows,
bool reflectedWindows = false);
void paintWindowCover(EffectWindow* w, bool reflectedWindow, WindowPaintData& data);
void paintFrontWindow(EffectWindow* frontWindow, int width, int leftWindows, int rightWindows, bool reflectedWindow);
void paintWindows(const EffectWindowList& windows, bool left, bool reflectedWindows, EffectWindow* additionalWindow = nullptr);
void selectNextOrPreviousWindow(bool forward);
inline void selectNextWindow() { selectNextOrPreviousWindow(true); }
inline void selectPreviousWindow() { selectNextOrPreviousWindow(false); }
void abort();
/**
* 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();
bool mActivated;
float angle;
bool animateSwitch;
bool animateStart;
bool animateStop;
bool animation;
bool start;
bool stop;
bool reflection;
float mirrorColor[2][4];
bool windowTitle;
std::chrono::milliseconds animationDuration;
bool stopRequested;
bool startRequested;
TimeLine timeLine;
std::chrono::milliseconds lastPresentTime;
QRect area;
float zPosition;
float scaleFactor;
enum Direction {
Left,
Right
};
Direction direction;
QQueue<Direction> scheduled_directions;
EffectWindow* selected_window;
int activeScreen;
QList< EffectWindow* > leftWindows;
QList< EffectWindow* > rightWindows;
EffectWindowList currentWindowList;
EffectWindowList referrencedWindows;
EffectFrame* captionFrame;
QFont captionFont;
bool primaryTabBox;
bool secondaryTabBox;
GLShader *m_reflectionShader;
QMatrix4x4 m_projectionMatrix;
QMatrix4x4 m_modelviewMatrix;
};
} // namespace
#endif