Summary: EffectQuickView/Scene is a convenient class to render a QtQuick scenegraph into an effect. Current methods (such as present windows) involve creating an underlying platform window which is expensive, causes a headache to filter out again in the rest of the code, and only works as an overlay. The new class exposes things more natively to an effect where we don't mess with real windows, we can perform the painting anywhere in the view and we don't have issues with hiding/closing. QtQuick has both software and hardware accelerated modes, and kwin also has 3 render backends. Every combination is supported. * When used in OpenGL mode for both, we render into an FBO export the texture ID then it's up to the effect to render that into a scene. * When using software QtQuick rendering we blit into an image, upload that into a KWinGLTexture which serves as an abstraction layer and render that into the scene. * When using GL for QtQuick and XRender/QPainter in kwin everything is rendered into the internal FBO, blit and exported as an image. * When using software rendering for both an image gets passed directly. Mouse and keyboard events can be forwarded, only if the effect intercepts them. The class is meant to be generic enough that we can remove all the QtQuick code from Aurorae. The intention is also to replace EffectFrameImpl using this backend and we can kill all of the EffectFrame code throughout the scenes. The close button in present windows will also be ported to this, simplifiying that code base. Classes that handle the rendering and handling QML are intentionally split so that in the future we can have a declarative effects API create overlays from within the same context. Similar to how one can instantiate windows from a typical QML scene. Notes: I don't like how I pass the kwin GL context from the backends into the effect, but I need something that works with the library separation. It also currently has wayland problem if I create a QOpenGLContext before the QPA is set up with a scene - but I don't have anything better? I know for the EffectFrame we need an API to push things through the effects stack to handle blur/invert etc. Will deal with that when we port the EffectFrame. Test Plan: Used in an effect Reviewers: #kwin, zzag Reviewed By: #kwin, zzag Subscribers: zzag, kwin Tags: #kwin Differential Revision: https://phabricator.kde.org/D24215 |
||
---|---|---|
autotests | ||
cmake/modules | ||
colorcorrection | ||
data | ||
decorations | ||
doc | ||
effects | ||
helpers | ||
kcmkwin | ||
kconf_update | ||
libinput | ||
libkwineffects | ||
platformsupport | ||
plugins | ||
qml | ||
scripting | ||
scripts | ||
tabbox | ||
tests | ||
xwl | ||
.arcconfig | ||
.arclint | ||
abstract_client.cpp | ||
abstract_client.h | ||
abstract_opengl_context_attribute_builder.cpp | ||
abstract_opengl_context_attribute_builder.h | ||
abstract_output.cpp | ||
abstract_output.h | ||
abstract_wayland_output.cpp | ||
abstract_wayland_output.h | ||
activation.cpp | ||
activities.cpp | ||
activities.h | ||
appmenu.cpp | ||
appmenu.h | ||
atoms.cpp | ||
atoms.h | ||
client_machine.cpp | ||
client_machine.h | ||
CMakeLists.txt | ||
composite.cpp | ||
composite.h | ||
config-kwin.h.cmake | ||
COPYING | ||
cursor.cpp | ||
cursor.h | ||
dbusinterface.cpp | ||
dbusinterface.h | ||
debug_console.cpp | ||
debug_console.h | ||
debug_console.ui | ||
deleted.cpp | ||
deleted.h | ||
effectloader.cpp | ||
effectloader.h | ||
effects.cpp | ||
effects.h | ||
egl_context_attribute_builder.cpp | ||
egl_context_attribute_builder.h | ||
events.cpp | ||
fixqopengl.h | ||
focuschain.cpp | ||
focuschain.h | ||
geometry.cpp | ||
geometrytip.cpp | ||
geometrytip.h | ||
gestures.cpp | ||
gestures.h | ||
globalshortcuts.cpp | ||
globalshortcuts.h | ||
group.cpp | ||
group.h | ||
HACKING.md | ||
idle_inhibition.cpp | ||
idle_inhibition.h | ||
input.cpp | ||
input.h | ||
input_event.cpp | ||
input_event.h | ||
input_event_spy.cpp | ||
input_event_spy.h | ||
internal_client.cpp | ||
internal_client.h | ||
keyboard_input.cpp | ||
keyboard_input.h | ||
keyboard_layout.cpp | ||
keyboard_layout.h | ||
keyboard_layout_switching.cpp | ||
keyboard_layout_switching.h | ||
keyboard_repeat.cpp | ||
keyboard_repeat.h | ||
killwindow.cpp | ||
killwindow.h | ||
kwin.kcfg | ||
kwin.notifyrc | ||
kwinbindings.cpp | ||
KWinDBusInterfaceConfig.cmake.in | ||
layers.cpp | ||
logind.cpp | ||
logind.h | ||
main.cpp | ||
main.h | ||
main_wayland.cpp | ||
main_wayland.h | ||
main_x11.cpp | ||
main_x11.h | ||
Mainpage.dox | ||
manage.cpp | ||
Messages.sh | ||
modifier_only_shortcuts.cpp | ||
modifier_only_shortcuts.h | ||
moving_client_x11_filter.cpp | ||
moving_client_x11_filter.h | ||
netinfo.cpp | ||
netinfo.h | ||
onscreennotification.cpp | ||
onscreennotification.h | ||
options.cpp | ||
options.h | ||
org.kde.kappmenu.xml | ||
org.kde.kwin.ColorCorrect.xml | ||
org.kde.kwin.Compositing.xml | ||
org.kde.kwin.Effects.xml | ||
org.kde.kwin.OrientationSensor.xml | ||
org.kde.KWin.VirtualDesktopManager.xml | ||
org.kde.KWin.xml | ||
orientation_sensor.cpp | ||
orientation_sensor.h | ||
osd.cpp | ||
osd.h | ||
outline.cpp | ||
outline.h | ||
outputscreens.cpp | ||
outputscreens.h | ||
overlaywindow.cpp | ||
overlaywindow.h | ||
placement.cpp | ||
placement.h | ||
platform.cpp | ||
platform.h | ||
pointer_input.cpp | ||
pointer_input.h | ||
popup_input_filter.cpp | ||
popup_input_filter.h | ||
README.md | ||
rootinfo_filter.cpp | ||
rootinfo_filter.h | ||
rules.cpp | ||
rules.h | ||
scene.cpp | ||
scene.h | ||
screenedge.cpp | ||
screenedge.h | ||
screenlockerwatcher.cpp | ||
screenlockerwatcher.h | ||
screens.cpp | ||
screens.h | ||
settings.kcfgc | ||
shadow.cpp | ||
shadow.h | ||
shortcutdialog.ui | ||
sm.cpp | ||
sm.h | ||
tabletmodemanager.cpp | ||
tabletmodemanager.h | ||
TESTING.md | ||
thumbnailitem.cpp | ||
thumbnailitem.h | ||
toplevel.cpp | ||
toplevel.h | ||
touch_hide_cursor_spy.cpp | ||
touch_hide_cursor_spy.h | ||
touch_input.cpp | ||
touch_input.h | ||
udev.cpp | ||
udev.h | ||
unmanaged.cpp | ||
unmanaged.h | ||
useractions.cpp | ||
useractions.h | ||
utils.cpp | ||
utils.h | ||
virtual_terminal.cpp | ||
virtual_terminal.h | ||
virtualdesktops.cpp | ||
virtualdesktops.h | ||
virtualdesktopsdbustypes.cpp | ||
virtualdesktopsdbustypes.h | ||
virtualkeyboard.cpp | ||
virtualkeyboard.h | ||
virtualkeyboard_dbus.cpp | ||
virtualkeyboard_dbus.h | ||
was_user_interaction_x11_filter.cpp | ||
was_user_interaction_x11_filter.h | ||
wayland_cursor_theme.cpp | ||
wayland_cursor_theme.h | ||
wayland_server.cpp | ||
wayland_server.h | ||
window_property_notify_x11_filter.cpp | ||
window_property_notify_x11_filter.h | ||
workspace.cpp | ||
workspace.h | ||
x11client.cpp | ||
x11client.h | ||
x11eventfilter.cpp | ||
x11eventfilter.h | ||
xcbutils.cpp | ||
xcbutils.h | ||
xdgshellclient.cpp | ||
xdgshellclient.h | ||
xkb.cpp | ||
xkb.h | ||
xkb_qt_mapping.h |
KWin
KWin is an easy to use, but flexible, composited Window Manager for Xorg windowing systems (Wayland, X11) on Linux. Its primary usage is in conjunction with a Desktop Shell (e.g. KDE Plasma Desktop). KWin is designed to go out of the way; users should not notice that they use a window manager at all. Nevertheless KWin provides a steep learning curve for advanced features, which are available, if they do not conflict with the primary mission. KWin does not have a dedicated targeted user group, but follows the targeted user group of the Desktop Shell using KWin as it's window manager.
KWin is not...
- a standalone window manager (c.f. openbox, i3) and does not provide any functionality belonging to a Desktop Shell.
- a replacement for window managers designed for use with a specific Desktop Shell (e.g. GNOME Shell)
- a minimalistic window manager
- designed for use without compositing or for X11 network transparency, though both are possible.
Contacting KWin development team
- mailing list: kwin@kde.org
- IRC: #kwin on freenode
Support
Application Developer
If you are an application developer having questions regarding windowing systems (either X11 or Wayland) please do not hesitate to contact us. Preferable through our mailing list. Ideally subscribe to the mailing list, so that your mail doesn't get stuck in the moderation queue.
End user
Please contact the support channels of your Linux distribution for user support. The KWin development team does not provide end user support.
Reporting bugs
Please use KDE's bugtracker and report for product KWin.
Developing on KWin
Please refer to hacking documentation for how to build and start KWin. Further information about KWin's test suite can be found in TESTING.md.
Guidelines for new features
A new Feature can only be added to KWin if:
- it does not violate the primary missions as stated at the start of this document
- it does not introduce instabilities
- it is maintained, that is bugs are fixed in a timely manner (second next minor release) if it is not a corner case.
- it works together with all existing features
- it supports both single and multi screen (xrandr)
- it adds a significant advantage
- it is feature complete, that is supports at least all useful features from competitive implementations
- it is not a special case for a small user group
- it does not increase code complexity significantly
- it does not affect KWin's license (GPLv2+)
All new added features are under probation, that is if any of the non-functional requirements as listed above do not hold true in the next two feature releases, the added feature will be removed again.
The same non functional requirements hold true for any kind of plugins (effects, scripts, etc.). It is suggested to use scripted plugins and distribute them separately.