summaryrefslogtreecommitdiff
path: root/plugins/composite/include/composite/composite.h
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/composite/include/composite/composite.h')
-rw-r--r--plugins/composite/include/composite/composite.h32
1 files changed, 30 insertions, 2 deletions
diff --git a/plugins/composite/include/composite/composite.h b/plugins/composite/include/composite/composite.h
index 0524764..85627b3 100644
--- a/plugins/composite/include/composite/composite.h
+++ b/plugins/composite/include/composite/composite.h
@@ -68,15 +68,32 @@ class PrivateCompositeWindow;
class CompositeScreen;
class CompositeWindow;
+///
+/// Interface for painting to composite output.
+///
class CompositeScreenInterface :
public WrapableInterface<CompositeScreen, CompositeScreenInterface>
{
public:
-
+
+ ///
+ /// Pre-paint hook
+ ///
virtual void preparePaint (int);
+
+ ///
+ /// Post-paint hook
+ ///
virtual void donePaint ();
+
+ ///
+ /// Paint to composite (multiple) outputs
+ ///
virtual void paint (CompOutput::ptrList &outputs, unsigned int);
-
+
+ ///
+ /// Gets a list of windows that need to evaluated for repainting
+ ///
virtual const CompWindowList & getWindowPaintList ();
};
@@ -217,6 +234,9 @@ class CompositeWindowInterface :
virtual bool damageRect (bool, const CompRect &);
};
+///
+/// A Window that has compositing effects
+///
class CompositeWindow :
public WrapableHandler<CompositeWindowInterface, 1>,
public PluginClassHandler<CompositeWindow, CompWindow, COMPIZ_COMPOSITE_ABI>
@@ -227,7 +247,15 @@ class CompositeWindow :
~CompositeWindow ();
bool bind ();
+
+ ///
+ /// Releases the pixmap data for this window with XFreePixmap.
+ ///
void release ();
+
+ ///
+ /// Gets the X server pixel map for this
+ ///
Pixmap pixmap ();
void redirect ();