KWin 5 with ICC color correction effect
 
 
 
 
 
 
Go to file
Vlad Zahorodnii 84d75cb567 [x11] Add support for _GTK_FRAME_EXTENTS
Summary:
KDE is known for having a strong view on the client-side decorations vs
server-side decorations issue. The main argument raised against CSD is
that desktop will look less consistent when clients start drawing window
decorations by themselves, which is somewhat true. It all ties to how
well each toolkit is integrated with the desktop environment.

KDE doesn't control the desktop market on Linux. Another big "player"
is GNOME. Both KDE and GNOME have very polarized views on in which
direction desktop should move forward. The KDE community is pushing more
toward server-side decorations while the GNOME community is pushing
more toward client-side decorations. Both communities have developed
great applications and it's not rare to see a GNOME application being
used in KDE Plasma. The only problem is that these different views are
not left behind the curtain and our users pay the price. Resizing GTK
clients in Plasma became practically impossible due to resize borders
having small hit area.

When a client draws its window decoration, it's more likely that it also
draws the drop-shadow around the decoration. The compositor must know
the extents of the shadow so things like snapping and so on work as
expected. And here lies the problem... While the xdg-shell protocol has
a way to specify such things, the NetWM spec doesn't have anything like
that. There's _GTK_FRAME_EXTENTS in the wild, however the problem with
it is that it's a proprietary atom, which is specific only to GTK apps.

Due to that, _GTK_FRAME_EXTENTS wasn't implemented because implementing
anything like that would require major changes in how we think about
geometry.

Recent xdg-shell window geometry patches adjusted geometry abstractions
in kwin to such a degree that it's very easy to add support for client
side decorated clients on X11. We just have to make sure that the
X11Client class provides correct buffer geometry and frame geometry when
the gtk frame extents are set.

Even though the X11 code is feature frozen, I still think it's worth
to have _GTK_FRAME_EXTENTS support in kwin because it will fix the resize
issues. Also, because KWin/Wayland is unfortunately far from becoming
default, it will help us with testing some implementation bits of the
window geometry from xdg-shell.

BUG: 390550
FIXED-IN: 5.18.0

Test Plan:
Things like quick tiling, maximizing, tiling scripts and so on work as
expected with GTK clients.

Reviewers: #kwin, davidedmundson

Reviewed By: #kwin, davidedmundson

Subscribers: cblack, trmdi, kwin

Tags: #kwin

Differential Revision: https://phabricator.kde.org/D24660
2019-11-27 14:12:30 +02:00
autotests [libkwineffects] Expose frame and buffer geometry to effects 2019-11-27 14:12:30 +02:00
cmake/modules Update URLs to use https 2019-03-25 19:26:23 +01:00
colorcorrection Fix minor typos 2019-11-26 19:48:29 +02:00
data Cleanup style in CMakeLists.txt files 2019-09-17 16:03:05 +03:00
decorations Use more traditional doxygen style 2019-07-29 22:06:19 +03:00
doc Improve comprehensibility and consistency of window placement mode names 2019-09-19 10:34:39 -06:00
effects Fix minor typos 2019-11-26 19:48:29 +02:00
helpers Cleanup style in CMakeLists.txt files 2019-09-17 16:03:05 +03:00
kcmkwin [kcmkwin/tabbox] Use an enum for role names 2019-11-22 21:38:29 +02:00
kconf_update [kconf_update] Explicitly request python3 in animation speed migration helper 2019-09-27 14:50:47 +01:00
libinput Use more traditional doxygen style 2019-07-29 22:06:19 +03:00
libkwineffects [libkwineffects] Expose frame and buffer geometry to effects 2019-11-27 14:12:30 +02:00
platformsupport [platforms/x11] Never block on retrace, always present after paint 2019-11-14 09:03:44 +01:00
plugins [x11] Add support for _GTK_FRAME_EXTENTS 2019-11-27 14:12:30 +02:00
qml Cleanup style in CMakeLists.txt files 2019-09-17 16:03:05 +03:00
scripting [effects] Add effect to hold the desktop window static after plasmashell quits 2019-11-01 17:14:55 +00:00
scripts SVN_SILENT made messages (.desktop file) - always resolve ours 2019-11-02 05:41:14 +01:00
tabbox [tabbox] Drop TabBoxClient::window() method 2019-11-18 10:43:41 +02:00
tests [tests] Drop wl-shell test client 2019-09-23 17:28:56 +03:00
xwl Fix minor typos 2019-11-26 19:48:29 +02:00
.arcconfig Adding .arcconfig 2016-03-15 13:37:47 +01:00
.arclint Add .arclint 2018-10-02 19:44:07 +03:00
CMakeLists.txt Use URL with transport encryption 2019-11-26 19:39:20 +02:00
COPYING Put licence files on each repo, removing from root. 2014-03-26 19:01:09 +01:00
HACKING.md Introduce a new HACKING.md document to replace the previous HACKING 2018-12-17 18:11:59 +01:00
KWinDBusInterfaceConfig.cmake.in Add path to kwin_wayland binary to KWin's installed CMakeConfig 2015-11-19 09:28:16 +01:00
Mainpage.dox Apidocs mainpage work. Just got Plasma and Solid to do here. 2007-07-24 18:30:36 +00:00
Messages.sh Fix untranslatable strings in debug_console.ui shortcutdialog.ui 2018-09-17 11:39:47 +02:00
README.md Add a new markdown README 2018-12-22 08:42:38 +01:00
TESTING.md [platform/virtual] Drop support for vgem and rendernode 2019-01-12 07:37:25 +01:00
abstract_client.cpp [x11] Add support for _GTK_FRAME_EXTENTS 2019-11-27 14:12:30 +02:00
abstract_client.h [x11] Add support for _GTK_FRAME_EXTENTS 2019-11-27 14:12:30 +02:00
abstract_opengl_context_attribute_builder.cpp Request a high-priority EGL contexts 2018-03-29 20:34:22 +09:00
abstract_opengl_context_attribute_builder.h Request a high-priority EGL contexts 2018-03-29 20:34:22 +09:00
abstract_output.cpp Associate output transforms and orientations 2019-11-26 22:29:40 +01:00
abstract_output.h Associate output transforms and orientations 2019-11-26 22:29:40 +01:00
abstract_wayland_output.cpp Set orientation from DRM on fallback 2019-11-26 22:33:59 +01:00
abstract_wayland_output.h Set orientation from DRM on fallback 2019-11-26 22:33:59 +01:00
activation.cpp Port one of session management connections state to a custom API 2019-11-01 17:14:42 +00:00
activities.cpp Port one of session management connections state to a custom API 2019-11-01 17:14:42 +00:00
activities.h Rename Client to X11Client 2019-09-25 21:11:37 +03:00
appmenu.cpp Rename Client to X11Client 2019-09-25 21:11:37 +03:00
appmenu.h Fix minor EBN issues 2018-08-29 21:02:16 +03:00
atoms.cpp [x11] Add support for _GTK_FRAME_EXTENTS 2019-11-27 14:12:30 +02:00
atoms.h [x11] Add support for _GTK_FRAME_EXTENTS 2019-11-27 14:12:30 +02:00
client_machine.cpp Use nullptr everywhere 2019-09-19 17:48:21 +03:00
client_machine.h Use nullptr everywhere 2019-09-19 17:48:21 +03:00
composite.cpp [platforms/x11] Never block on retrace, always present after paint 2019-11-14 09:03:44 +01:00
composite.h [platforms/x11] Never block on retrace, always present after paint 2019-11-14 09:03:44 +01:00
config-kwin.h.cmake [platforms/drm] EGLStream DRM Backend Initial Implementation 2019-04-15 07:26:22 -07:00
cursor.cpp Use nullptr everywhere 2019-09-19 17:48:21 +03:00
cursor.h Use more traditional doxygen style 2019-07-29 22:06:19 +03:00
dbusinterface.cpp Drop redundant Compositor::hasScene() 2019-09-07 10:19:04 +03:00
dbusinterface.h Use more traditional doxygen style 2019-07-29 22:06:19 +03:00
debug_console.cpp Rename Client to X11Client 2019-09-25 21:11:37 +03:00
debug_console.h Rename Client to X11Client 2019-09-25 21:11:37 +03:00
debug_console.ui fixuifiles 2018-09-18 07:52:44 +02:00
deleted.cpp Adjust scene for client-side decorated clients 2019-11-27 14:12:30 +02:00
deleted.h Adjust scene for client-side decorated clients 2019-11-27 14:12:30 +02:00
effectloader.cpp Introduce an EffectsHandler::animationsSupported -> bool 2016-08-15 17:38:33 +02:00
effectloader.h Use more traditional doxygen style 2019-07-29 22:06:19 +03:00
effects.cpp Adjust scene for client-side decorated clients 2019-11-27 14:12:30 +02:00
effects.h [libkwineffects] Expose frame and buffer geometry to effects 2019-11-27 14:12:30 +02:00
egl_context_attribute_builder.cpp Request a high-priority EGL contexts 2018-03-29 20:34:22 +09:00
egl_context_attribute_builder.h [qpa] Use the new OpenGLContextAttributeBuilder to create Qt's OpenGL context 2017-07-17 16:53:37 +02:00
events.cpp [x11] Add support for _GTK_FRAME_EXTENTS 2019-11-27 14:12:30 +02:00
fixqopengl.h Fix the build on armhf/aarch64 2018-03-06 09:25:33 +05:30
focuschain.cpp Use nullptr everywhere 2019-09-19 17:48:21 +03:00
focuschain.h Rename Client to X11Client 2019-09-25 21:11:37 +03:00
geometry.cpp [x11] Add support for _GTK_FRAME_EXTENTS 2019-11-27 14:12:30 +02:00
geometrytip.cpp Use nullptr everywhere 2019-09-19 17:48:21 +03:00
geometrytip.h Run clang-tidy with modernize-use-override check 2019-07-22 20:03:22 +03:00
gestures.cpp Fix build with clang and GCC6 2017-03-29 14:45:44 +02:00
gestures.h Use more traditional doxygen style 2019-07-29 22:06:19 +03:00
globalshortcuts.cpp Don't try to filter null key combinations 2018-04-24 16:23:47 +02:00
globalshortcuts.h Use more traditional doxygen style 2019-07-29 22:06:19 +03:00
group.cpp Rename Client to X11Client 2019-09-25 21:11:37 +03:00
group.h Rename Client to X11Client 2019-09-25 21:11:37 +03:00
idle_inhibition.cpp Update my last name 2019-09-29 17:03:25 +03:00
idle_inhibition.h Update my last name 2019-09-29 17:03:25 +03:00
input.cpp [effects] Forward wheel events 2019-11-14 12:50:45 +00:00
input.h Update my last name 2019-09-29 17:03:25 +03:00
input_event.cpp Send axis_source, axis_discrete, and axis_stop 2019-05-17 12:06:10 +03:00
input_event.h Send axis_source, axis_discrete, and axis_stop 2019-05-17 12:06:10 +03:00
input_event_spy.cpp Be consistent about touch point id type: use qint32 2019-08-11 22:15:05 +02:00
input_event_spy.h Be consistent about touch point id type: use qint32 2019-08-11 22:15:05 +02:00
internal_client.cpp Use better name for geometryBeforeUpdateBlocking 2019-11-27 14:12:30 +02:00
internal_client.h [wayland] Implement window geometry more properly 2019-11-27 14:12:30 +02:00
keyboard_input.cpp Remove X clipboard sync helper and rename its autotest 2019-02-19 12:30:43 +01:00
keyboard_input.h Use more traditional doxygen style 2019-07-29 22:06:19 +03:00
keyboard_layout.cpp Make the Keyboard Layout SNI passive 2019-04-09 23:38:52 +02:00
keyboard_layout.h Introduce support for keyboard layout switching policies 2017-04-22 08:15:25 +02:00
keyboard_layout_switching.cpp Use end() instead of constEnd() for where we compare to an iterator 2017-04-22 20:28:12 +02:00
keyboard_layout_switching.h Run clang-tidy with modernize-use-override check 2019-07-22 20:03:22 +03:00
keyboard_repeat.cpp Split Keyboard Repeat handling into a dedicated InputEventSpy 2017-01-27 16:03:37 +01:00
keyboard_repeat.h [wayland] Avoid compare to unintialised value in keyboard repeat 2019-09-23 22:13:54 +02:00
killwindow.cpp Use OnScreenNotification in kill window 2016-12-21 19:45:02 +01:00
killwindow.h Support interactive window selection through the Platform 2016-11-17 08:08:56 +01:00
kwin.kcfg Load animation speed from new global animation speed controller 2019-09-25 14:37:01 +01:00
kwin.notifyrc SVN_SILENT made messages (.desktop file) - always resolve ours 2019-10-23 09:29:41 +02:00
kwinbindings.cpp Remove disabled TabGroup feature 2019-09-14 10:58:48 +02:00
layers.cpp Rename geometry property to frameGeometry 2019-10-02 11:46:37 +03:00
linux_dmabuf.cpp Dmabuf recovery on EGL reset 2019-10-29 12:10:15 +01:00
linux_dmabuf.h Dmabuf recovery on EGL reset 2019-10-29 12:10:15 +01:00
logind.cpp remove superfluous code 2019-01-27 12:05:22 +05:30
logind.h Use more traditional doxygen style 2019-07-29 22:06:19 +03:00
main.cpp Don't notify ksplash in our wayland session 2019-09-23 22:13:43 +02:00
main.h Add some const & 2019-10-30 19:23:01 +01:00
main_wayland.cpp Don't notify ksplash in our wayland session 2019-09-23 22:13:43 +02:00
main_wayland.h Run clang-tidy with modernize-use-override check 2019-07-22 20:03:22 +03:00
main_x11.cpp Port one of session management connections state to a custom API 2019-11-01 17:14:42 +00:00
main_x11.h Don't notify ksplash in our wayland session 2019-09-23 22:13:43 +02:00
manage.cpp [x11] Add support for _GTK_FRAME_EXTENTS 2019-11-27 14:12:30 +02:00
modifier_only_shortcuts.cpp Track the actual pressed keys in ModifierOnlyShortcuts 2017-02-23 16:55:41 +01:00
modifier_only_shortcuts.h Track the actual pressed keys in ModifierOnlyShortcuts 2017-02-23 16:55:41 +01:00
moving_client_x11_filter.cpp Rename Client to X11Client 2019-09-25 21:11:37 +03:00
moving_client_x11_filter.h Move X11 movingClient handling into a dedicated X11EventFilter 2017-09-01 16:57:43 +02:00
netinfo.cpp [x11] Add support for _GTK_FRAME_EXTENTS 2019-11-27 14:12:30 +02:00
netinfo.h Rename Client to X11Client 2019-09-25 21:11:37 +03:00
onscreennotification.cpp Drop invalid .moc file inclusion 2018-03-04 16:10:18 +01:00
onscreennotification.h Add support for skip close animation to OnScreenMessage 2017-01-25 13:54:34 +01:00
options.cpp Use URL with transport encryption 2019-11-26 19:39:20 +02:00
options.h Remove vsync detection and configurability 2019-11-14 08:55:08 +01:00
org.kde.KWin.Session.xml Port one of session management connections state to a custom API 2019-11-01 17:14:42 +00:00
org.kde.KWin.VirtualDesktopManager.xml [wayland] Use the new plasma virtual desktop protocol 2018-11-01 16:35:29 +01:00
org.kde.KWin.xml Add a dbus method getWindowInfo returning same data as queryWindowInfo 2018-12-17 18:12:17 +01:00
org.kde.kappmenu.xml Restore global menu support 2017-01-11 10:21:03 +01:00
org.kde.kwin.ColorCorrect.xml [colorcorrection] Night Color - blue light filter at nighttime 2017-12-11 10:58:40 +01:00
org.kde.kwin.Compositing.xml [kcmkwin/compositing] Hide config options which don't make sense if Compositing is required 2016-09-13 15:47:42 +02:00
org.kde.kwin.Effects.xml [kwin] Add a new EffectLoader 2014-03-28 14:04:55 +01:00
org.kde.kwin.OrientationSensor.xml Add DBus interface to OrientationSensor and a persistent configuration 2017-12-26 22:02:47 +01:00
orientation_sensor.cpp Fix orientation sensor DBus 2019-09-01 16:15:25 +01:00
orientation_sensor.h Add some const & 2019-10-30 19:23:01 +01:00
osd.cpp Add support for skip close animation to OnScreenMessage 2017-01-25 13:54:34 +01:00
osd.h Add support for skip close animation to OnScreenMessage 2017-01-25 13:54:34 +01:00
outline.cpp [wayland] Make sure that only the fading popups effect animates outline 2019-04-09 14:21:22 +03:00
outline.h Use more traditional doxygen style 2019-07-29 22:06:19 +03:00
outputscreens.cpp Associate output transforms and orientations 2019-11-26 22:29:40 +01:00
outputscreens.h Associate output transforms and orientations 2019-11-26 22:29:40 +01:00
overlaywindow.cpp Move the X11 specific OverlayWindow into the platform/x11 2017-08-12 11:32:29 +02:00
overlaywindow.h Move the X11 specific OverlayWindow into the platform/x11 2017-08-12 11:32:29 +02:00
placement.cpp Don't compute frame extents in packPositionFoo methods 2019-10-02 11:46:40 +03:00
placement.h Delete unused forward declaration of Client class 2019-09-16 16:31:09 +03:00
platform.cpp Remove unused variable 2019-09-10 14:27:44 +02:00
platform.h [platforms/drm] Rework enablement and dpms switching 2019-09-05 17:36:21 +02:00
pointer_input.cpp Update my last name 2019-09-29 17:03:25 +03:00
pointer_input.h Update my last name 2019-09-29 17:03:25 +03:00
popup_input_filter.cpp Rename ShellClient to XdgShellClient 2019-09-23 17:28:56 +03:00
popup_input_filter.h Rename ShellClient to XdgShellClient 2019-09-23 17:28:56 +03:00
rootinfo_filter.cpp Create a dedicated X11EventFilter for the events used by RootInfo 2017-09-30 12:57:21 +02:00
rootinfo_filter.h Create a dedicated X11EventFilter for the events used by RootInfo 2017-09-30 12:57:21 +02:00
rules.cpp Fix minor typos 2019-11-26 19:48:29 +02:00
rules.h Rename Client to X11Client 2019-09-25 21:11:37 +03:00
scene.cpp Adjust scene for client-side decorated clients 2019-11-27 14:12:30 +02:00
scene.h Adjust scene for client-side decorated clients 2019-11-27 14:12:30 +02:00
screenedge.cpp Rename geometry property to frameGeometry 2019-10-02 11:46:37 +03:00
screenedge.h Use more traditional doxygen style 2019-07-29 22:06:19 +03:00
screenlockerwatcher.cpp Close screen grabbing effect when screensaver starts 2019-06-23 18:00:47 +02:00
screenlockerwatcher.h Run clang-tidy with modernize-use-override check 2019-07-22 20:03:22 +03:00
screens.cpp Rename Client to X11Client 2019-09-25 21:11:37 +03:00
screens.h Use more traditional doxygen style 2019-07-29 22:06:19 +03:00
settings.kcfgc Use KConfigXT in KWin::Options 2013-02-14 08:29:03 +01:00
shadow.cpp Rename geometry property to frameGeometry 2019-10-02 11:46:37 +03:00
shadow.h Use more traditional doxygen style 2019-07-29 22:06:19 +03:00
shortcutdialog.ui [kwin] Use ui-file for ShortcutDialog 2014-02-27 10:18:37 +01:00
sm.cpp Port one of session management connections state to a custom API 2019-11-01 17:14:42 +00:00
sm.h Port one of session management connections state to a custom API 2019-11-01 17:14:42 +00:00
tabletmodemanager.cpp Make it possible to autodetect the tablet mode 2019-03-22 18:29:21 +01:00
tabletmodemanager.h Run clang-tidy with modernize-use-override check 2019-07-22 20:03:22 +03:00
thumbnailitem.cpp Rename Client to X11Client 2019-09-25 21:11:37 +03:00
thumbnailitem.h Use nullptr everywhere 2019-09-19 17:48:21 +03:00
toplevel.cpp [x11] Add support for _GTK_FRAME_EXTENTS 2019-11-27 14:12:30 +02:00
toplevel.h Adjust scene for client-side decorated clients 2019-11-27 14:12:30 +02:00
touch_hide_cursor_spy.cpp Be consistent about touch point id type: use qint32 2019-08-11 22:15:05 +02:00
touch_hide_cursor_spy.h Be consistent about touch point id type: use qint32 2019-08-11 22:15:05 +02:00
touch_input.cpp Fix minor typos 2019-11-26 19:48:29 +02:00
touch_input.h Be consistent about touch point id type: use qint32 2019-08-11 22:15:05 +02:00
udev.cpp [platform/virtual] Drop support for vgem and rendernode 2019-01-12 07:37:25 +01:00
udev.h [platform/virtual] Drop support for vgem and rendernode 2019-01-12 07:37:25 +01:00
unmanaged.cpp [wayland] Implement window geometry more properly 2019-11-27 14:12:30 +02:00
unmanaged.h [wayland] Implement window geometry more properly 2019-11-27 14:12:30 +02:00
useractions.cpp Rename geometry property to frameGeometry 2019-10-02 11:46:37 +03:00
useractions.h Rename Client to X11Client 2019-09-25 21:11:37 +03:00
utils.cpp Don't initialize QFlags<T> with nullptr 2019-09-19 21:42:34 +03:00
utils.h Rename Client to X11Client 2019-09-25 21:11:37 +03:00
virtual_terminal.cpp Port away from deprecated headers 2019-07-09 23:59:07 +03:00
virtual_terminal.h Run clang-tidy with modernize-use-override check 2019-07-22 20:03:22 +03:00
virtualdesktops.cpp Use nullptr everywhere 2019-09-19 17:48:21 +03:00
virtualdesktops.h Add some const & 2019-10-30 19:23:01 +01:00
virtualdesktopsdbustypes.cpp [wayland] Use the new plasma virtual desktop protocol 2018-11-01 16:35:29 +01:00
virtualdesktopsdbustypes.h [wayland] Use the new plasma virtual desktop protocol 2018-11-01 16:35:29 +01:00
virtualkeyboard.cpp Rename ShellClient to XdgShellClient 2019-09-23 17:28:56 +03:00
virtualkeyboard.h Revert "Load the keyboard on-demand" 2019-08-09 11:40:22 +05:30
virtualkeyboard_dbus.cpp Add DBus protocol to virtual keyboard 2017-10-19 17:59:19 +02:00
virtualkeyboard_dbus.h Run clang-tidy with modernize-use-override check 2019-07-22 20:03:22 +03:00
was_user_interaction_x11_filter.cpp Create a dedicated X11EventFilter for recognizing first user interaction 2017-08-19 10:14:53 +02:00
was_user_interaction_x11_filter.h Create a dedicated X11EventFilter for recognizing first user interaction 2017-08-19 10:14:53 +02:00
wayland_cursor_theme.cpp Load Kwin's internal cursors for the highest resolution of attached monitors 2018-06-23 23:26:54 +01:00
wayland_cursor_theme.h Run clang-tidy with modernize-use-override check 2019-07-22 20:03:22 +03:00
wayland_server.cpp Merge branch 'Plasma/5.17' 2019-11-18 12:27:17 +02:00
wayland_server.h Merge branch 'Plasma/5.17' 2019-10-29 12:12:02 +01:00
window_property_notify_x11_filter.cpp Rename Client to X11Client 2019-09-25 21:11:37 +03:00
window_property_notify_x11_filter.h Add a dedicated X11EventFilter for forwarding property events to the effect system 2017-09-25 20:36:45 +02:00
workspace.cpp [platforms/x11] Never block on retrace, always present after paint 2019-11-14 09:03:44 +01:00
workspace.h Port one of session management connections state to a custom API 2019-11-01 17:14:42 +00:00
x11client.cpp [x11] Add support for _GTK_FRAME_EXTENTS 2019-11-27 14:12:30 +02:00
x11client.h [x11] Add support for _GTK_FRAME_EXTENTS 2019-11-27 14:12:30 +02:00
x11eventfilter.cpp Support multiple event types in X11EventFilter 2016-11-16 07:48:19 +01:00
x11eventfilter.h Use more traditional doxygen style 2019-07-29 22:06:19 +03:00
xcbutils.cpp Use nullptr everywhere 2019-09-19 17:48:21 +03:00
xcbutils.h Adjust scene for client-side decorated clients 2019-11-27 14:12:30 +02:00
xdgshellclient.cpp Use better name for geometryBeforeUpdateBlocking 2019-11-27 14:12:30 +02:00
xdgshellclient.h [wayland] Implement window geometry more properly 2019-11-27 14:12:30 +02:00
xkb.cpp Use nullptr everywhere 2019-09-19 17:48:21 +03:00
xkb.h Add some const & 2019-10-30 19:23:01 +01:00
xkb_qt_mapping.h Support mapping QKeyEvent to xkb_keysym_t 2017-09-19 19:09:17 +02:00

README.md

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

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.