X-Git-Url: http://git.tdb.fi/?p=libs%2Fgl.git;a=blobdiff_plain;f=source%2Frenderable.h;h=80fe172eb7435b44f147d4324294b6c72b5d5fd2;hp=9a534e9038579f37256c2722f6681235dc062eea;hb=bec07999d95b76f4b47cffcc564d0cd0afc0435e;hpb=a1eb8711ba225bb4423868c50369ad5592465171

diff --git a/source/renderable.h b/source/renderable.h
index 9a534e90..80fe172e 100644
--- a/source/renderable.h
+++ b/source/renderable.h
@@ -2,6 +2,7 @@
 #define MSP_GL_RENDERABLE_H_
 
 #include <string>
+#include <msp/core/inttypes.h>
 #include <msp/geometry/boundingsphere.h>
 #include "tag.h"
 
@@ -12,11 +13,12 @@ class Matrix;
 class Renderer;
 
 /**
-Base class for renderable objects.  All Renderables must support rendering with
-a Renderer, and may optionally provide support for standalone rendering.
+Base class for renderable objects.  Rendering is performed with the help of a
+Renderer object.
 
-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.
+The render method takes a Tag to identify a render pass.  It can be used with
+a Technique to select alternative rendering methods, such as simplified shaders
+for a depth-only shadow pass.
 
 The setup_frame and finish_frame methods provide a mechanism for performing
 once-per-frame operations.  This is most useful for effects, which may need to
@@ -33,10 +35,11 @@ public:
 
 	/** 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; }
+	virtual IntPtr get_instance_key() const { return 0; }
 
 	/** Returns the model matrix of the Renderable.  Null is returned if no such
-	matrix exists. */
+	matrix exists.  The matrix should be in world space for some effects to work
+	correctly. */
 	virtual const Matrix *get_matrix() const { return 0; }
 
 	/** Returns a bounding sphere that completely encloses the Renderable.  The
@@ -45,15 +48,10 @@ public:
 	virtual const Geometry::BoundingSphere<float, 3> *get_bounding_sphere() const { return 0; }
 
 	/** Called when starting to render a new frame. */
-	virtual void setup_frame() const { }
+	virtual void setup_frame(Renderer &) { }
 
 	/** Called when a complete frame has been rendered. */
-	virtual void finish_frame() const { }
-
-	/** 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 finish_frame() { }
 
 	/** Renders the Renderable.  Implementors should take care to return the
 	renderer to the state it was in, for example by using Renderer::Push. */