Difference between revisions of "Projects/KWin"

Revision as of 16:03, 21 January 2008

This is a starting page for all relevant KWin documentation, most of which is stored in SVN or on external WWW pages.

KWin mailing list
COMPLIANCE - a document on KWin's compliance to the window manager specifications ICCCM and EWMH (also known as NETWM).
KDE4.0 release notes - information about changes and new features in KWin in KDE4.0

HACKING - Starting document for developers interested in helping with developing KWin, including information on the KWin mailing list, KWin structure, developing tips, etc.
libkdecoration API documentation - API documentation for the library used for developing KWin decorations (the link points to documentation for the current development version, for other versions: 4.0 ).
clients/PORTING - List of changes needed to port decorations from KDE3 to KDE4.
KWin decorations HOWTO - tutorial on writing KWin decorations. Note that it is written for KDE3.2, but it is also usable for newer versions (see also the PORTING document above)
COMPOSITE_TODO - TODO list for compositing support in KWin.
libkwineffects API documentation - Documentation on API for compositing effects - currently needs to be done, developers interested in developing compositing effects for KWin are currently suggested to use source of already existing effects shipped with KWin (especially the Howto effect in the tests/ directory as a starting point) and/or ask on the KWin mailing list if necessary. NOTE: This API is currently considered unstable and subject to change.

COMPOSITE_HOWTO - document on setting up support for compositing feature of KWin (X.Org configuration, driver issues, etc.).
CONFIGURING - document on advanced KWin configuration (such as pre-configuring window-specific settings).

@@ Line 14: / Line 14: @@
 * [http://www.usermode.org/docs/kwintheme.html KWin decorations HOWTO] - tutorial on writing KWin decorations. Note that it is written for KDE3.2, but it is also usable for newer versions (see also the PORTING document above)
 * [http://websvn.kde.org/*checkout*/trunk/KDE/kdebase/workspace/kwin/COMPOSITE_TODO COMPOSITE_TODO ] - TODO list for compositing support in KWin.
-* Documentation on API for compositing effects - currently needs to be done, developers interested in developing compositing effects for KWin are currently suggested to use source of already [http://websvn.kde.org/trunk/KDE/kdebase/workspace/kwin/effects/ existing effects shipped with KWin] (especially the Howto effect in the tests/ directory as a starting point) and/or ask on the KWin mailing list if necessary.
+* [http://api.kde.org/4.x-api/kdebase-apidocs/workspace/kwin/lib/html/group__kwineffects.html libkwineffects API documentation ] - Documentation on API for compositing effects - currently needs to be done, developers interested in developing compositing effects for KWin are currently suggested to use source of already [http://websvn.kde.org/trunk/KDE/kdebase/workspace/kwin/effects/ existing effects shipped with KWin] (especially the Howto effect in the tests/ directory as a starting point) and/or ask on the KWin mailing list if necessary. NOTE: This API is currently considered unstable and subject to change.
 == Configuration ==