yukijoou/kwin
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
My KWIN fork where I work on features like per-output virtual desktops
18963 commits 3 branches 0 tags 96 MiB
C++ 94.2%
QML 2.7%
CMake 1.8%
JavaScript 0.8%
GLSL 0.3%
Other 0.1%
Find a file
Vlad Zahorodnii 2ce49877f7 platforms/wayland: Emit outputEnabled() signal 
Otherwise the QPA won't create QPlatformScreens and the compositor may
not work as expected.
2021-02-11 12:03:26 +00:00
autotests Move source code to src/ directory 2021-02-10 15:31:43 +00:00
cmake/modules cmake: Remove FindFontconfig.cmake 2021-01-06 11:21:03 +02:00
data GIT_SILENT: don't use deprecated cmake variable 2021-02-08 20:19:33 +01:00
doc GIT_SILENT: dont use deprecated cmake variable 2021-01-29 11:34:52 +01:00
kconf_update Fix a typo 2021-01-07 21:28:00 +02:00
LICENSES Switch to SPDX license markers 2020-08-07 19:57:56 +00:00
src platforms/wayland: Emit outputEnabled() signal 2021-02-11 12:03:26 +00:00
tests Move source code to src/ directory 2021-02-10 15:31:43 +00:00
.gitignore Add .gitignore file to ignore generated .clang-format 2020-12-18 10:03:45 +00:00
CMakeLists.txt Move source code to src/ directory 2021-02-10 15:31:43 +00:00
HACKING.md Introduce coding-conventions.md 2020-02-03 12:45:47 +02:00
KWinDBusInterfaceConfig.cmake.in Add path to kwin_wayland binary to KWin's installed CMakeConfig 2015-11-19 09:28:16 +01:00
logo.png GIT_SILENT: add KWin icon as repository logo 2020-05-20 12:47:52 +00:00
Mainpage.dox
plasma-kwin_wayland.service.in Update systemd units 2020-09-29 06:10:20 +00:00
plasma-kwin_x11.service.in Update systemd units 2020-09-29 06:10:20 +00:00
README.md Capstone commit to prevent force push reversed commits returning accidentally. 2020-06-03 09:54:00 +00:00
TESTING.md [platform/virtual] Drop support for vgem and rendernode 2019-01-12 07:37:25 +01: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.