Summary: | KWin::EffectWindow class documentation needs improvement | ||
---|---|---|---|
Product: | [Plasma] kwin | Reporter: | Richard <shiningarcanine> |
Component: | compositing | Assignee: | KWin default assignee <kwin-bugs-null> |
Status: | RESOLVED FIXED | ||
Severity: | wishlist | ||
Priority: | VLO | ||
Version: | unspecified | ||
Target Milestone: | --- | ||
Platform: | Gentoo Packages | ||
OS: | Linux | ||
Latest Commit: | Version Fixed In: |
Description
Richard
2010-08-28 01:57:27 UTC
a) all your examples are one :-P b) as you might have figured, effects are "stateless" - so there's no access to the manipulated window geometry since it's only known by the effecthandler (the engine, which might or might not support several transitions, ie. try to name the geometry() during the magic lamp effect =) - therefore the name is maybe unclear w/o understanding of the effect engine class (which you need to have to implement an effect) but it's not ambiguous c) no idea why hasOwnShape() is marked "for internal use" (martin?, lucas?) but that sounds pretty much wrong to me (and privating the function is please rather no option) d) in general and aside this, please notice that the effect lib is NOT part of kdelibs and esp. NOT stable e) HOWTO - never read it, though ;-P http://blog.martin-graesslin.com/blog/2009/07/how-to-write-a-kwin-effect/ (is it in KDE's howtos as well?) to c) No idea, but yes sounds wrong. to e) http://techbase.kde.org/User:Mgraesslin/Effects but I have to move it from my private space In general more and better documentation would be nice, but up to now the effects library has almoast exclusively been used by KWin developers. And EffectWindow is more or less just a copy of an internal class so it's to me understandable that it is not documented properly. The API documentation has been improved lately and will see another update very soon (one branch needs merging). If there is anything specific unclear please ask on the mailinglist, irc channel or in the forum. If we know exactly what needs improving, it's quite simple to add documentation :-) |