Merge branch 'animation-rework'

[libs/gl.git] / source / renderable.h

diff --git a/source/renderable.h b/source/renderable.h
index e90ab0243ee140173256ee3f2a6a1ba904fce7cc..6e1505ca5a728c0ac1b012eb797cf00c84321ff4 100644 (file)
--- a/source/renderable.h
+++ b/source/renderable.h
@@ -15,8 +15,9 @@ class Renderer;
 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
@@ -36,7 +37,8 @@ public:
        virtual long 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