kwin/plugins/windowsystem/windoweffects.cpp

151 lines
4.1 KiB
C++
Raw Normal View History

Add windowsystem plugin for KWin's qpa Summary: KWindowSystem provides a plugin interface to have platform specific implementations. So far KWin relied on the implementation in KWayland-integration repository. This is something I find unsuited, for the following reasons: * any test in KWin for functionality set through the plugin would fail * it's not clear what's going on where * in worst case some code could deadlock * KWin shouldn't use KWindowSystem and only a small subset is allowed to be used The last point needs some further explanation. KWin internally does not and cannot use KWindowSystem. KWindowSystem (especially KWindowInfo) is exposing information which KWin sets. It's more than weird if KWin asks KWindowSystem for the state of a window it set itself. On X11 it's just slow, on Wayland it can result in roundtrips to KWin itself which is dangerous. But due to using Plasma components we have a few areas where we use KWindowSystem. E.g. a Plasma::Dialog sets a window type, the slide in direction, blur and background contrast. This we want to support and need to support. Other API elements we do not want, like for examples the available windows. KWin internal windows either have direct access to KWin or a scripting interface exposed providing (limited) access - there is just no need to have this in KWindowSystem. To make it more clear what KWin supports as API of KWindowSystem for internal windows this change implements a stripped down version of the kwayland-integration plugin. The main difference is that it does not use KWayland at all, but a QWindow internal side channel. To support this EffectWindow provides an accessor for internalWindow and the three already mentioned effects are adjusted to read from the internal QWindow and it's dynamic properties. This change is a first step for a further refactoring. I plan to split the internal window out of ShellClient into a dedicated class. I think there are nowadays too many special cases. If it moves out there is the question whether we really want to use Wayland for the internal windows or whether this is just historic ballast (after all we used to use qwayland for that in the beginning). As the change could introduce regressions I'm targetting 5.16. Test Plan: new test case for window type, manual testing using Alt+Tab for the effects integration. Sliding popups, blur and contrast worked fine. Reviewers: #kwin Subscribers: kwin Tags: #kwin Differential Revision: https://phabricator.kde.org/D18228
2019-01-13 16:50:32 +00:00
/*
* Copyright 2019 Martin Flöser <mgraesslin@kde.org>
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as
* published by the Free Software Foundation; either version 2 of
* the License or (at your option) version 3 or any later version
* accepted by the membership of KDE e.V. (or its successor approved
* by the membership of KDE e.V.), which shall act as a proxy
* defined in Section 14 of version 3 of the license.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include "windoweffects.h"
#include "effect_builtins.h"
#include "../../effects.h"
#include <QGuiApplication>
#include <QWidget>
#include <QWindow>
Q_DECLARE_METATYPE(KWindowEffects::SlideFromLocation)
namespace KWin
{
WindowEffects::WindowEffects()
: QObject(),
KWindowEffectsPrivate()
{
}
WindowEffects::~WindowEffects()
{}
namespace
{
QWindow *findWindow(WId win)
{
const auto windows = qApp->allWindows();
auto it = std::find_if(windows.begin(), windows.end(), [win] (QWindow *w) { return w->winId() == win; });
if (it == windows.end()) {
return nullptr;
}
return *it;
}
}
bool WindowEffects::isEffectAvailable(KWindowEffects::Effect effect)
{
if (!effects) {
return false;
}
auto e = static_cast<EffectsHandlerImpl*>(effects);
switch (effect) {
case KWindowEffects::BackgroundContrast:
return e->isEffectLoaded(BuiltInEffects::nameForEffect(BuiltInEffect::Contrast));
case KWindowEffects::BlurBehind:
return e->isEffectLoaded(BuiltInEffects::nameForEffect(BuiltInEffect::Blur));
case KWindowEffects::Slide:
return e->isEffectLoaded(BuiltInEffects::nameForEffect(BuiltInEffect::SlidingPopups));
default:
// plugin does not provide integration for other effects
return false;
}
}
void WindowEffects::slideWindow(WId id, KWindowEffects::SlideFromLocation location, int offset)
{
auto w = findWindow(id);
if (!w) {
return;
}
w->setProperty("kwin_slide", QVariant::fromValue(location));
w->setProperty("kwin_slide_offset", offset);
}
void WindowEffects::slideWindow(QWidget *widget, KWindowEffects::SlideFromLocation location)
{
slideWindow(widget->winId(), location, 0);
}
QList<QSize> WindowEffects::windowSizes(const QList<WId> &ids)
{
Q_UNUSED(ids)
return {};
}
void WindowEffects::presentWindows(WId controller, const QList<WId> &ids)
{
Q_UNUSED(controller)
Q_UNUSED(ids)
}
void WindowEffects::presentWindows(WId controller, int desktop)
{
Q_UNUSED(controller)
Q_UNUSED(desktop)
}
void WindowEffects::highlightWindows(WId controller, const QList<WId> &ids)
{
Q_UNUSED(controller)
Q_UNUSED(ids)
}
void WindowEffects::enableBlurBehind(WId window, bool enable, const QRegion &region)
{
auto w = findWindow(window);
if (!w) {
return;
}
if (enable) {
w->setProperty("kwin_blur", region);
} else {
w->setProperty("kwin_blur", {});
}
}
void WindowEffects::enableBackgroundContrast(WId window, bool enable, qreal contrast, qreal intensity, qreal saturation, const QRegion &region)
{
auto w = findWindow(window);
if (!w) {
return;
}
if (enable) {
w->setProperty("kwin_background_region", region);
w->setProperty("kwin_background_contrast", contrast);
w->setProperty("kwin_background_intensity", intensity);
w->setProperty("kwin_background_saturation", saturation);
} else {
w->setProperty("kwin_background_region", {});
w->setProperty("kwin_background_contrast", {});
w->setProperty("kwin_background_intensity", {});
w->setProperty("kwin_background_saturation", {});
}
}
void WindowEffects::markAsDashboard(WId window)
{
Q_UNUSED(window)
}
}