You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Vlad Zahorodnii c766e5da6d Introduce infrastructure for compositor extensions
The scripting api is not suitable for implementing all features that
should not be implemented in libkwin. For example, the krunner
integration or screencasting are the things that don't belong to be
compiled right into kwin and yet we don't have any other choice.

This change introduces a quick and dirty plugin infrastructure that
can be used to implement things such as colord integration, krunner
integration, etc.
4 years ago
3rdparty
LICENSES
autotests Introduce infrastructure for compositor extensions 4 years ago
cmake/modules
colorcorrection
data
decorations Add a QRect to showWindowMenu 4 years ago
doc
effects Raise default blur strenght 4 years ago
helpers
kcmkwin Add a QRect to showWindowMenu 4 years ago
kconf_update
libinput
libkwineffects Add emit to signal calls 4 years ago
platformsupport minor: fix coding style in abstract_egl_backend 4 years ago
plugins Introduce infrastructure for compositor extensions 4 years ago
qml
runners SVN_SILENT made messages (.desktop file) - always resolve ours 4 years ago
scripting
scripts
tabbox [kcmkwin/kwinscreenedges] Disable left touch edge by default 4 years ago
tests
xwl
CMakeLists.txt Introduce infrastructure for compositor extensions 4 years ago
HACKING.md
KWinDBusInterfaceConfig.cmake.in
Mainpage.dox
Messages.sh
README.md
TESTING.md
abstract_client.cpp fix: Restore full screen window to the right screen 4 years ago
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
composite.cpp Remove assert in Compositor::aboutToSwapBuffers() 4 years ago
composite.h
config-kwin.h.cmake Introduce infrastructure for compositor extensions 4 years ago
cursor.cpp
cursor.h
dbusinterface.cpp Introduce infrastructure for compositor extensions 4 years ago
dbusinterface.h Introduce infrastructure for compositor extensions 4 years ago
debug_console.cpp
debug_console.h
debug_console.ui
deleted.cpp
deleted.h
dmabuftexture.cpp
dmabuftexture.h
effectloader.cpp
effectloader.h
effects.cpp [libkwineffects] Add windowId to EffectWindow 4 years ago
effects.h [libkwineffects] Add windowId to EffectWindow 4 years ago
egl_context_attribute_builder.cpp
egl_context_attribute_builder.h
events.cpp
fixqopengl.h
focuschain.cpp
focuschain.h
geometrytip.cpp
geometrytip.h
gestures.cpp
gestures.h
globalshortcuts.cpp
globalshortcuts.h
group.cpp
group.h
idle_inhibition.cpp
idle_inhibition.h
input.cpp adapt to changes in seat and keyboard interface 4 years ago
input.h
input_event.cpp
input_event.h
input_event_spy.cpp
input_event_spy.h
inputmethod.cpp adapt to changes in seat and keyboard interface 4 years ago
inputmethod.h
inputpanelv1client.cpp
inputpanelv1client.h
inputpanelv1integration.cpp
inputpanelv1integration.h
internal_client.cpp
internal_client.h
keyboard_input.cpp
keyboard_input.h
keyboard_layout.cpp feat: expose keyboard layout Short Name via DBus 4 years ago
keyboard_layout.h feat: expose keyboard layout Short Name via DBus 4 years ago
keyboard_layout_switching.cpp
keyboard_layout_switching.h
keyboard_repeat.cpp
keyboard_repeat.h
killwindow.cpp
killwindow.h
kwin.kcfg
kwin.notifyrc SVN_SILENT made messages (.desktop file) - always resolve ours 4 years ago
kwinbindings.cpp
layers.cpp
layershellv1client.cpp
layershellv1client.h
layershellv1integration.cpp
layershellv1integration.h
linux_dmabuf.cpp
linux_dmabuf.h
logind.cpp
logind.h
logo.png
main.cpp
main.h
main_wayland.cpp Introduce infrastructure for compositor extensions 4 years ago
main_wayland.h
main_x11.cpp Introduce infrastructure for compositor extensions 4 years ago
main_x11.h
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 Prefer Q_ENUM to Q_ENUMS 4 years ago
org.kde.KWin.Plugins.xml Introduce infrastructure for compositor extensions 4 years ago
org.kde.KWin.Session.xml Add an explicit quit mechanism controlled by plasma 4 years ago
org.kde.KWin.VirtualDesktopManager.xml
org.kde.KWin.xml
org.kde.kappmenu.xml
org.kde.kwin.ColorCorrect.xml
org.kde.kwin.Compositing.xml
org.kde.kwin.Effects.xml
osd.cpp
osd.h
outline.cpp
outline.h
outputscreens.cpp
outputscreens.h
overlaywindow.cpp
overlaywindow.h
placement.cpp placement: Remove unused function 4 years ago
placement.h placement: Make internal methods private 4 years ago
plasma-kwin_wayland.service.in Update systemd units 4 years ago
plasma-kwin_x11.service.in
platform.cpp
platform.h
plugin.cpp Introduce infrastructure for compositor extensions 4 years ago
plugin.h Introduce infrastructure for compositor extensions 4 years ago
pluginmanager.cpp Introduce infrastructure for compositor extensions 4 years ago
pluginmanager.h Introduce infrastructure for compositor extensions 4 years ago
pointer_input.cpp
pointer_input.h
popup_input_filter.cpp
popup_input_filter.h
rootinfo_filter.cpp
rootinfo_filter.h
rulebooksettings.cpp
rulebooksettings.h Prettify license headers 4 years ago
rulebooksettingsbase.kcfg
rulebooksettingsbase.kcfgc
rules.cpp
rules.h
rulesettings.kcfg
rulesettings.kcfgc
scene.cpp
scene.h
screenedge.cpp
screenedge.h
screenlockerwatcher.cpp
screenlockerwatcher.h
screens.cpp
screens.h
service_utils.cpp
service_utils.h
settings.kcfgc
shadow.cpp
shadow.h
shortcutdialog.ui
sm.cpp Add an explicit quit mechanism controlled by plasma 4 years ago
sm.h Add an explicit quit mechanism controlled by plasma 4 years ago
subsurfacemonitor.cpp
subsurfacemonitor.h
syncalarmx11filter.cpp
syncalarmx11filter.h
tablet_input.cpp
tablet_input.h
tabletmodemanager.cpp Add emit to signal calls 4 years ago
tabletmodemanager.h
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 Initializes 'UserActionsMenu::m_multipleDesktopsMenu' and 'UserActionsMenu::m_shortcutOperation' in the constructor 4 years ago
useractions.h
utils.cpp
utils.h
virtual_terminal.cpp
virtual_terminal.h
virtualdesktops.cpp
virtualdesktops.h
virtualdesktopsdbustypes.cpp
virtualdesktopsdbustypes.h
virtualkeyboard_dbus.cpp
virtualkeyboard_dbus.h
was_user_interaction_x11_filter.cpp
was_user_interaction_x11_filter.h
wayland_server.cpp Update to wayland-server changes for plasmashell 4 years ago
wayland_server.h
waylandclient.cpp
waylandclient.h
waylandshellintegration.cpp
waylandshellintegration.h
window_property_notify_x11_filter.cpp
window_property_notify_x11_filter.h
workspace.cpp Introduce infrastructure for compositor extensions 4 years ago
workspace.h Fix typos in comment 4 years ago
x11client.cpp fix: Restore the default properties of dialog window so that the max and min buttons can be customized 4 years ago
x11client.h
x11eventfilter.cpp
x11eventfilter.h
xcbutils.cpp Prettify license headers 4 years ago
xcbutils.h
xcursortheme.cpp
xcursortheme.h
xdgshellclient.cpp
xdgshellclient.h
xdgshellintegration.cpp
xdgshellintegration.h
xkb.cpp feat: expose keyboard layout Short Name via DBus 4 years ago
xkb.h feat: expose keyboard layout Short Name via DBus 4 years ago
xkb_qt_mapping.h
xwaylandclient.cpp
xwaylandclient.h

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.