KWin: Difference between revisions

Latest revision as of 07:43, 18 October 2024

Developer Documentation

There are several subsites with some developer documentation:

KWin/Hacking General development information
KWin/Building How to build KWin from master
KWin/Getting_Involved How You could get involved in KWin development
KWin/Frameworks How to build KWin on frameworks and help porting
KWin/Dependencies Dependencies of KWin on frameworks 5
KWin/KConfigXT_Effects Project: Port Effects to KConfigXT
KWin/KConfigXT Project: Create KConfigXT for KWin core
KWin/Animations Project: Find all animation details in Effects
KWin/Default_Options Default Options Project for 4.9
KWin/Ideas Ideas for small tasks in KWin
KWin/Environment_Variables Overview on the available environment variables in KWin
KWin/Wayland General information about KWin and Wayland
KWin/Wayland_Development Information for developing KWin + Wayland
KWin/QT5 Progress on making KWin ready for QT5
KWin/Bugzilla Information on Bug Triaging
KWin/Class_Diagram Class Diagram of KWin
KWin/Shadow New Shadow System
KWin/Screen_Edges New Screen Edge Handling
KWin/Decoration New Window Decoration API (Discussion)
KWin/Screenlocker Moving Screenlocker to KWin (Discussion)
KWin/GSoC/Modularization Documentation for GSoC Modularization of KWin
KWin/GSoC/Color_Correction Information about the GSoC Color Correction project
KWin/Mission_Statement Mission Statement for KWin (Discussion)
KWin/Changelog_5 Changelog of new features in KWin 5
KWin/Debugging Debugging the compositor with gdb is extra tricky, thus here a chaet sheet
KWin/Packaging Packaging documentation in particular WRT X11 vs. Wayland
KWin/Window_Metadata DBus protocol for passing additional window information

@@ Line 1: / Line 1: @@
-==Unsorted/undebated TODO==
+[[File:Mascot konqi-base-plasma.png|thumbnail|right|Move the windows with [[Konqi]]!]]
+== Developer Documentation ==
-* If WindowQuadList used floats instead of doubles it could be possible to point glVertexPointer() directly instead of doing unnecessary copying and conversion every paint call. -- '''fredrikh''' (Paraphrased by [[User:Lmurray|Lmurray]] 11:39, 29 November 2010 (UTC))
+There are several subsites with some developer documentation:
-* EffectFrame and EffectWindow are basically the same thing from an effect's point of view; a texture and a set of vertices and texcoords. They could share the same base class. -- '''fredrikh''' (Paraphrased by [[User:Lmurray|Lmurray]] 11:39, 29 November 2010 (UTC))
+* [[KWin/Hacking]] General development information
-* PaintClipper calls glDrawArrays() once per clip rectangle. -- '''fredrikh''' (Paraphrased by [[User:Lmurray|Lmurray]] 11:39, 29 November 2010 (UTC))
+* [[KWin/Building]] How to build KWin from master
+* [[KWin/Getting_Involved]] How You could get involved in KWin development
-==Detailed TODO==
+* [[KWin/Frameworks]] How to build KWin on frameworks and help porting
+* [[KWin/Dependencies]] Dependencies of KWin on frameworks 5
-===Coding style===
+* [[KWin/KConfigXT_Effects]] Project: Port Effects to KConfigXT
+* [[KWin/KConfigXT]] Project: Create KConfigXT for KWin core
-Fredrikh and myself discussed coding styles on IRC briefly a few weeks ago (I do not have the logs) and decided that the Qt coding style with some minor adjustments would be best for KWin as it's well documented [http://qt.gitorious.org/qt/pages/QtCodingStyle] and makes sense to be used within a core KDE project. -- [[User:Lmurray|Lmurray]] 11:39, 29 November 2010 (UTC)
+* [[KWin/Animations]] Project: Find all animation details in Effects
+* [[KWin/Default_Options]] Default Options Project for 4.9
-===APIs are poorly designed===
+* [[KWin/Ideas]] Ideas for small tasks in KWin
+* [[KWin/Environment_Variables]] Overview on the available environment variables in KWin
-APIs should use Qt signals and slots [http://doc.qt.nokia.com/4.7/signalsandslots.html] as well as the Qt property system [http://doc.qt.nokia.com/4.7/properties.html] instead of large amounts of virtual functions. -- '''fredrikh''' (Paraphrased by [[User:Lmurray|Lmurray]] 11:39, 29 November 2010 (UTC))
+* [[KWin/Wayland]] General information about KWin and Wayland
+* [[KWin/Wayland_Development]] Information for developing KWin + Wayland
-:For system software, such as KWin, that communicates a lot with external processes all the time it makes sense to attempt to make as much of the KWin code event based as possible, especially as all the low-level code already does so. This applies to pretty much every KWin object and not just the public APIs. While it does make it slightly more difficult for inexperienced developers to understand and to debug in general due to losing full stack traces it can vastly improve the responsiveness and efficiency of KWin as a whole. -- [[User:Lmurray|Lmurray]] 11:39, 29 November 2010 (UTC)
+* [[KWin/QT5]] Progress on making KWin ready for QT5
+* [[KWin/Bugzilla]] Information on Bug Triaging
-==Useful IRC logs==
+* [[KWin/Class_Diagram]] Class Diagram of KWin
+* [[KWin/Shadow]] New Shadow System
-TODO
+* [[KWin/Screen_Edges]] New Screen Edge Handling
+* [[KWin/Decoration]] New Window Decoration API (Discussion)
+* [[KWin/Screenlocker]] Moving Screenlocker to KWin (Discussion)
+* [[KWin/GSoC/Modularization]] Documentation for GSoC Modularization of KWin
+* [[KWin/GSoC/Color_Correction]] Information about the GSoC Color Correction project
+* [[KWin/Mission_Statement]] Mission Statement for KWin (Discussion)
+* [[KWin/Changelog_5]] Changelog of new features in KWin 5
+* [[KWin/Debugging]] Debugging the compositor with gdb is extra tricky, thus here a chaet sheet
+* [[KWin/Packaging]] Packaging documentation in particular WRT X11 vs. Wayland
+* [[KWin/Window_Metadata]] DBus protocol for passing additional window information