X-Git-Url: http://git.tdb.fi/?a=blobdiff_plain;f=source%2Frenderable.h;h=2342ae288cfed9b4d8fa61f25bf932ae47058540;hb=904de4f7fd994886adbd3a6c03bc1b7c14ebc562;hp=9fe46956540d4af243e61b2a9316c7eb08ccf020;hpb=0e8ffd3b59e9b5c52c66c22c9ae4f9d3544aa6bf;p=libs%2Fgl.git

diff --git a/source/renderable.h b/source/renderable.h
index 9fe46956..2342ae28 100644
--- a/source/renderable.h
+++ b/source/renderable.h
@@ -1,10 +1,3 @@
-/* $Id$
-
-This file is part of libmspgl
-Copyright © 2007, 2011  Mikko Rasa, Mikkosoft Productions
-Distributed under the LGPL
-*/
-
 #ifndef MSP_GL_RENDERABLE_H_
 #define MSP_GL_RENDERABLE_H_
 
@@ -16,6 +9,13 @@ namespace GL {
 
 class Renderer;
 
+/**
+Base class for renderable objects.  All Renderables must support rendering with
+a Renderer, and may optionally provide support for standalone rendering.
+
+The render methods take a Tag to identify a render pass.  It is most commonly
+used together with Techniques and Pipelines to implement multipass rendering.
+*/
 class Renderable
 {
 protected:
@@ -23,11 +23,18 @@ protected:
 public:
 	virtual ~Renderable() { }
 
-	/** Returns a key used for grouping Renderables in an InstanceScene. */
+	/** Returns a key used for grouping Renderables in an InstanceScene.  The
+	returned value is treated as opaque. */
 	virtual long get_instance_key() const { return 0; }
 
+	/** Renders the renderable without a renderer.  This can be convenient in
+	some simple cases, but most renderables don't need to implement this
+	method. */
 	virtual void render(const Tag & = Tag()) const;
-	virtual void render(Renderer &, const Tag & = Tag()) const;
+
+	/** Renders the renderable.  Implementors should take care to return the
+	renderer to the state it was in, for example by using Renderer::Push. */
+	virtual void render(Renderer &, const Tag & = Tag()) const = 0;
 };
 
 } // namespace Msp