Some comment updates

diff --git a/source/extension.h b/source/extension.h
index 1b149367eecd7ef9c5978138a0a41a837ee7b9c4..cf824e24b0a189b65fc88de30adc6dc862fb5e09 100644 (file)
--- a/source/extension.h
+++ b/source/extension.h
@@ -34,6 +34,10 @@ struct Version
 };
 
 
+/**
+Holds metadata about an extension.  Evaluates to true if the extension is
+supported.
+*/
 class Extension
 {
 public:

diff --git a/source/pipeline.h b/source/pipeline.h
index 1e5b6aa4c9894529e44cb0094c5b9a08837b01e6..4ee594444a5e6c465d50347793c572f6f2e076ff 100644 (file)
--- a/source/pipeline.h
+++ b/source/pipeline.h
@@ -87,7 +87,10 @@ public:
        Pipeline(unsigned, unsigned, bool = false);
        ~Pipeline();
 
+       /* Sets high dynamic range mode.  Requires floating-point texture support.
+       A ColorCurve postprocessor is recommended for full benefit. */
        void set_hdr(bool);
+
        void set_multisample(unsigned);
 
        // Deprecated

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

diff --git a/source/text.h b/source/text.h
index 7bf7956033d28b592e23790992507ad293ccd5f9..40c9b8500097d1591f8be68b1ad6b3234870729b 100644 (file)
--- a/source/text.h
+++ b/source/text.h
@@ -46,7 +46,7 @@ public:
        const Mesh *get_mesh() const { return &mesh; }
 
        /** Sets technique to render with.  It should have a texture slot named
-       "diffusemap", which will be replaced with the font's texture. */
+       "diffuse_map", which will be replaced with the font's texture. */
        void set_technique(const Technique *);
 
        const Technique *get_technique() const { return object.get_technique(); }