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

127 lines
3.7 KiB
C++

/*
KWin - the KDE window manager
This file is part of the KDE project.
SPDX-FileCopyrightText: 2006 Lubos Lunak <l.lunak@kde.org>
SPDX-FileCopyrightText: 2010 Sebastian Sauer <sebsauer@kdab.com>
SPDX-License-Identifier: GPL-2.0-or-later
*/
#ifndef KWIN_ZOOM_H
#define KWIN_ZOOM_H
#include <config-kwin.h>
#include <kwineffects.h>
#include <QTime>
#include <QTimeLine>
namespace KWin
{
#if HAVE_ACCESSIBILITY
class ZoomAccessibilityIntegration;
#endif
class GLTexture;
class XRenderPicture;
class ZoomEffect
: public Effect
{
Q_OBJECT
Q_PROPERTY(qreal zoomFactor READ configuredZoomFactor)
Q_PROPERTY(int mousePointer READ configuredMousePointer)
Q_PROPERTY(int mouseTracking READ configuredMouseTracking)
Q_PROPERTY(bool focusTrackingEnabled READ isFocusTrackingEnabled)
Q_PROPERTY(bool textCaretTrackingEnabled READ isTextCaretTrackingEnabled)
Q_PROPERTY(int focusDelay READ configuredFocusDelay)
Q_PROPERTY(qreal moveFactor READ configuredMoveFactor)
Q_PROPERTY(qreal targetZoom READ targetZoom)
public:
ZoomEffect();
~ZoomEffect() override;
void reconfigure(ReconfigureFlags flags) override;
void prePaintScreen(ScreenPrePaintData& data, std::chrono::milliseconds presentTime) override;
void paintScreen(int mask, const QRegion &region, ScreenPaintData& data) override;
void postPaintScreen() override;
bool isActive() const override;
// for properties
qreal configuredZoomFactor() const {
return zoomFactor;
}
int configuredMousePointer() const {
return mousePointer;
}
int configuredMouseTracking() const {
return mouseTracking;
}
bool isFocusTrackingEnabled() const;
bool isTextCaretTrackingEnabled() const;
int configuredFocusDelay() const {
return focusDelay;
}
qreal configuredMoveFactor() const {
return moveFactor;
}
qreal targetZoom() const {
return target_zoom;
}
private Q_SLOTS:
inline void zoomIn() { zoomIn(-1.0); };
void zoomIn(double to);
void zoomOut();
void actualSize();
void moveZoomLeft();
void moveZoomRight();
void moveZoomUp();
void moveZoomDown();
void moveMouseToFocus();
void moveMouseToCenter();
void timelineFrameChanged(int frame);
void moveFocus(const QPoint &point);
void slotMouseChanged(const QPoint& pos, const QPoint& old,
Qt::MouseButtons buttons, Qt::MouseButtons oldbuttons,
Qt::KeyboardModifiers modifiers, Qt::KeyboardModifiers oldmodifiers);
void recreateTexture();
private:
void showCursor();
void hideCursor();
void moveZoom(int x, int y);
private:
#if HAVE_ACCESSIBILITY
ZoomAccessibilityIntegration *m_accessibilityIntegration = nullptr;
#endif
double zoom;
double target_zoom;
double source_zoom;
bool polling; // Mouse polling
double zoomFactor;
enum MouseTrackingType { MouseTrackingProportional = 0, MouseTrackingCentred = 1, MouseTrackingPush = 2, MouseTrackingDisabled = 3 };
MouseTrackingType mouseTracking;
enum MousePointerType { MousePointerScale = 0, MousePointerKeep = 1, MousePointerHide = 2 };
MousePointerType mousePointer;
int focusDelay;
QPoint cursorPoint;
QPoint cursorHotSpot;
QPoint focusPoint;
QPoint prevPoint;
QTime lastMouseEvent;
QTime lastFocusEvent;
QScopedPointer<GLTexture> texture;
#ifdef KWIN_HAVE_XRENDER_COMPOSITING
QScopedPointer<XRenderPicture> xrenderPicture;
#endif
int imageWidth;
int imageHeight;
bool isMouseHidden;
QTimeLine timeline;
int xMove, yMove;
double moveFactor;
std::chrono::milliseconds lastPresentTime;
};
} // namespace
#endif