9f2cb0ae1b
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.
253 lines
7.2 KiB
C++
253 lines
7.2 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_CUBE_H
|
|
#define KWIN_CUBE_H
|
|
|
|
#include <kwineffects.h>
|
|
#include <kwinglutils.h>
|
|
#include <QObject>
|
|
#include <QQueue>
|
|
#include <QMatrix4x4>
|
|
#include <QFont>
|
|
#include "cube_inside.h"
|
|
#include "cube_proxy.h"
|
|
|
|
namespace KWin
|
|
{
|
|
|
|
class CubeEffect
|
|
: public Effect
|
|
{
|
|
Q_OBJECT
|
|
Q_PROPERTY(qreal cubeOpacity READ configuredCubeOpacity)
|
|
Q_PROPERTY(bool opacityDesktopOnly READ isOpacityDesktopOnly)
|
|
Q_PROPERTY(bool displayDesktopName READ isDisplayDesktopName)
|
|
Q_PROPERTY(bool reflection READ isReflection)
|
|
Q_PROPERTY(int rotationDuration READ configuredRotationDuration)
|
|
Q_PROPERTY(QColor backgroundColor READ configuredBackgroundColor)
|
|
Q_PROPERTY(QColor capColor READ configuredCapColor)
|
|
Q_PROPERTY(bool paintCaps READ isPaintCaps)
|
|
Q_PROPERTY(bool closeOnMouseRelease READ isCloseOnMouseRelease)
|
|
Q_PROPERTY(qreal zPosition READ configuredZPosition)
|
|
Q_PROPERTY(bool useForTabBox READ isUseForTabBox)
|
|
Q_PROPERTY(bool invertKeys READ isInvertKeys)
|
|
Q_PROPERTY(bool invertMouse READ isInvertMouse)
|
|
Q_PROPERTY(qreal capDeformationFactor READ configuredCapDeformationFactor)
|
|
Q_PROPERTY(bool useZOrdering READ isUseZOrdering)
|
|
Q_PROPERTY(bool texturedCaps READ isTexturedCaps)
|
|
// TODO: electric borders: not a registered type
|
|
public:
|
|
CubeEffect();
|
|
~CubeEffect() override;
|
|
void reconfigure(ReconfigureFlags) override;
|
|
void prePaintScreen(ScreenPrePaintData& data, std::chrono::milliseconds presentTime) override;
|
|
void paintScreen(int mask, const QRegion ®ion, 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;
|
|
bool borderActivated(ElectricBorder border) override;
|
|
void grabbedKeyboardEvent(QKeyEvent* e) override;
|
|
void windowInputMouseEvent(QEvent* e) override;
|
|
bool isActive() const override;
|
|
|
|
int requestedEffectChainPosition() const override {
|
|
return 50;
|
|
}
|
|
|
|
// proxy functions
|
|
void* proxy() override;
|
|
void registerCubeInsideEffect(CubeInsideEffect* effect);
|
|
void unregisterCubeInsideEffect(CubeInsideEffect* effect);
|
|
|
|
static bool supported();
|
|
|
|
// for properties
|
|
qreal configuredCubeOpacity() const {
|
|
return cubeOpacity;
|
|
}
|
|
bool isOpacityDesktopOnly() const {
|
|
return opacityDesktopOnly;
|
|
}
|
|
bool isDisplayDesktopName() const {
|
|
return displayDesktopName;
|
|
}
|
|
bool isReflection() const {
|
|
return reflection;
|
|
}
|
|
int configuredRotationDuration() const {
|
|
return rotationDuration.count();
|
|
}
|
|
QColor configuredBackgroundColor() const {
|
|
return backgroundColor;
|
|
}
|
|
QColor configuredCapColor() const {
|
|
return capColor;
|
|
}
|
|
bool isPaintCaps() const {
|
|
return paintCaps;
|
|
}
|
|
bool isCloseOnMouseRelease() const {
|
|
return closeOnMouseRelease;
|
|
}
|
|
qreal configuredZPosition() const {
|
|
return zPosition;
|
|
}
|
|
bool isUseForTabBox() const {
|
|
return useForTabBox;
|
|
}
|
|
bool isInvertKeys() const {
|
|
return invertKeys;
|
|
}
|
|
bool isInvertMouse() const {
|
|
return invertMouse;
|
|
}
|
|
qreal configuredCapDeformationFactor() const {
|
|
return capDeformationFactor;
|
|
}
|
|
bool isUseZOrdering() const {
|
|
return useZOrdering;
|
|
}
|
|
bool isTexturedCaps() const {
|
|
return texturedCaps;
|
|
}
|
|
private Q_SLOTS:
|
|
void toggleCube();
|
|
void toggleCylinder();
|
|
void toggleSphere();
|
|
// slots for global shortcut changed
|
|
// needed to toggle the effect
|
|
void globalShortcutChanged(QAction *action, const QKeySequence &seq);
|
|
void slotTabBoxAdded(int mode);
|
|
void slotTabBoxUpdated();
|
|
void slotTabBoxClosed();
|
|
void slotCubeCapLoaded();
|
|
void slotWallPaperLoaded();
|
|
private:
|
|
enum class AnimationState {
|
|
None,
|
|
Start,
|
|
Stop,
|
|
Left,
|
|
Right
|
|
};
|
|
enum class VerticalAnimationState {
|
|
None,
|
|
Upwards,
|
|
Downwards
|
|
};
|
|
enum CubeMode {
|
|
Cube,
|
|
Cylinder,
|
|
Sphere
|
|
};
|
|
void toggle(CubeMode newMode = Cube);
|
|
void paintCube(int mask, QRegion region, ScreenPaintData& data);
|
|
void paintCap(bool frontFirst, float zOffset, const QMatrix4x4 &projection);
|
|
void paintCubeCap();
|
|
void paintCylinderCap();
|
|
void paintSphereCap();
|
|
bool loadShader();
|
|
void rotateCube();
|
|
void rotateToDesktop(int desktop);
|
|
void setActive(bool active);
|
|
QImage loadCubeCap(const QString &capPath);
|
|
QImage loadWallPaper(const QString &file);
|
|
void startAnimation(AnimationState state);
|
|
void startVerticalAnimation(VerticalAnimationState state);
|
|
|
|
bool activated;
|
|
bool cube_painting;
|
|
bool keyboard_grab;
|
|
bool schedule_close;
|
|
QList<ElectricBorder> borderActivate;
|
|
QList<ElectricBorder> borderActivateCylinder;
|
|
QList<ElectricBorder> borderActivateSphere;
|
|
int painting_desktop;
|
|
int frontDesktop;
|
|
float cubeOpacity;
|
|
bool opacityDesktopOnly;
|
|
bool displayDesktopName;
|
|
EffectFrame* desktopNameFrame;
|
|
QFont desktopNameFont;
|
|
bool reflection;
|
|
bool rotating;
|
|
bool verticalRotating;
|
|
bool desktopChangedWhileRotating;
|
|
bool paintCaps;
|
|
QColor backgroundColor;
|
|
QColor capColor;
|
|
GLTexture* wallpaper;
|
|
bool texturedCaps;
|
|
GLTexture* capTexture;
|
|
// animations
|
|
// Horizontal/start/stop
|
|
float startAngle;
|
|
float currentAngle;
|
|
int startFrontDesktop;
|
|
AnimationState animationState;
|
|
TimeLine timeLine;
|
|
QQueue<AnimationState> animations;
|
|
// vertical
|
|
float verticalStartAngle;
|
|
float verticalCurrentAngle;
|
|
VerticalAnimationState verticalAnimationState;
|
|
TimeLine verticalTimeLine;
|
|
QQueue<VerticalAnimationState> verticalAnimations;
|
|
std::chrono::milliseconds lastPresentTime;
|
|
|
|
bool reflectionPainting;
|
|
std::chrono::milliseconds rotationDuration;
|
|
int activeScreen;
|
|
bool bottomCap;
|
|
bool closeOnMouseRelease;
|
|
float zoom;
|
|
float zPosition;
|
|
bool useForTabBox;
|
|
bool invertKeys;
|
|
bool invertMouse;
|
|
bool tabBoxMode;
|
|
bool shortcutsRegistered;
|
|
CubeMode mode;
|
|
bool useShaders;
|
|
GLShader* cylinderShader;
|
|
GLShader* sphereShader;
|
|
GLShader* m_reflectionShader;
|
|
GLShader* m_capShader;
|
|
float capDeformationFactor;
|
|
bool useZOrdering;
|
|
float zOrderingFactor;
|
|
bool useList;
|
|
// needed for reflection
|
|
float mAddedHeightCoeff1;
|
|
float mAddedHeightCoeff2;
|
|
|
|
QMatrix4x4 m_rotationMatrix;
|
|
QMatrix4x4 m_reflectionMatrix;
|
|
QMatrix4x4 m_textureMirrorMatrix;
|
|
QMatrix4x4 m_currentFaceMatrix;
|
|
GLVertexBuffer *m_cubeCapBuffer;
|
|
|
|
// Shortcuts - needed to toggle the effect
|
|
QList<QKeySequence> cubeShortcut;
|
|
QList<QKeySequence> cylinderShortcut;
|
|
QList<QKeySequence> sphereShortcut;
|
|
|
|
// proxy
|
|
CubeEffectProxy m_proxy;
|
|
QList< CubeInsideEffect* > m_cubeInsideEffects;
|
|
|
|
QAction *m_cubeAction;
|
|
QAction *m_cylinderAction;
|
|
QAction *m_sphereAction;
|
|
};
|
|
|
|
} // namespace
|
|
|
|
#endif
|