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

130 lines
3.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: 2007 Christian Nitschkowski <christian.nitschkowski@kdemail.net>
SPDX-FileCopyrightText: 2018 Vlad Zahorodnii <vlad.zahorodnii@kde.org>
SPDX-License-Identifier: GPL-2.0-or-later
*/
#ifndef KWIN_DIMINACTIVE_H
#define KWIN_DIMINACTIVE_H
// kwineffects
#include <kwineffects.h>
namespace KWin
{
class DimInactiveEffect : public Effect
{
Q_OBJECT
Q_PROPERTY(int dimStrength READ dimStrength)
Q_PROPERTY(bool dimPanels READ dimPanels)
Q_PROPERTY(bool dimDesktop READ dimDesktop)
Q_PROPERTY(bool dimKeepAbove READ dimKeepAbove)
Q_PROPERTY(bool dimByGroup READ dimByGroup)
Q_PROPERTY(bool dimFullScreen READ dimFullScreen)
public:
DimInactiveEffect();
~DimInactiveEffect() override;
void reconfigure(ReconfigureFlags flags) override;
void prePaintScreen(ScreenPrePaintData &data, std::chrono::milliseconds presentTime) override;
void paintWindow(EffectWindow *w, int mask, QRegion region, WindowPaintData &data) override;
void postPaintScreen() override;
int requestedEffectChainPosition() const override;
bool isActive() const override;
int dimStrength() const;
bool dimPanels() const;
bool dimDesktop() const;
bool dimKeepAbove() const;
bool dimByGroup() const;
bool dimFullScreen() const;
private Q_SLOTS:
void windowActivated(EffectWindow *w);
void windowClosed(EffectWindow *w);
void windowDeleted(EffectWindow *w);
void activeFullScreenEffectChanged();
void updateActiveWindow(EffectWindow *w);
private:
void dimWindow(WindowPaintData &data, qreal strength);
bool canDimWindow(const EffectWindow *w) const;
void scheduleInTransition(EffectWindow *w);
void scheduleGroupInTransition(EffectWindow *w);
void scheduleOutTransition(EffectWindow *w);
void scheduleGroupOutTransition(EffectWindow *w);
void scheduleRepaint(EffectWindow *w);
private:
qreal m_dimStrength;
bool m_dimPanels;
bool m_dimDesktop;
bool m_dimKeepAbove;
bool m_dimByGroup;
bool m_dimFullScreen;
EffectWindow *m_activeWindow = nullptr;
const EffectWindowGroup *m_activeWindowGroup;
QHash<EffectWindow*, TimeLine> m_transitions;
QHash<EffectWindow*, qreal> m_forceDim;
std::chrono::milliseconds m_lastPresentTime = std::chrono::milliseconds::zero();
struct {
bool active = false;
TimeLine timeLine;
} m_fullScreenTransition;
};
inline int DimInactiveEffect::requestedEffectChainPosition() const
{
return 50;
}
inline bool DimInactiveEffect::isActive() const
{
return true;
}
inline int DimInactiveEffect::dimStrength() const
{
return qRound(m_dimStrength * 100.0);
}
inline bool DimInactiveEffect::dimPanels() const
{
return m_dimPanels;
}
inline bool DimInactiveEffect::dimDesktop() const
{
return m_dimDesktop;
}
inline bool DimInactiveEffect::dimKeepAbove() const
{
return m_dimKeepAbove;
}
inline bool DimInactiveEffect::dimByGroup() const
{
return m_dimByGroup;
}
inline bool DimInactiveEffect::dimFullScreen() const
{
return m_dimFullScreen;
}
} // namespace KWin
#endif