Update and improve documentation

[libs/gl.git] / source / render / view.h

diff --git a/source/render/view.h b/source/render/view.h
index 9c756bbcdb453c62b1701a8421d3df075c6076f0..23425a86e3dff251322f219c6a337bac27e3bd0d 100644 (file)
--- a/source/render/view.h
+++ b/source/render/view.h
@@ -11,7 +11,11 @@ class Renderable;
 class Renderer;
 
 /**
-Manages the presentation of rendering results on the screen.
+An ultimate render target, which is typically visible to the user of the
+application in some way.
+
+The content renderable's render() function is called with an empty tag.  A
+Sequence can be used to specify other tags and add post-processing.
 */
 class View
 {
@@ -29,7 +33,10 @@ public:
        virtual unsigned get_height() const { return target.get_height(); }
        float get_aspect_ratio() const { return static_cast<float>(get_width())/get_height(); }
 
+       /** Sets the camera to render with.  The camera's aspect ratio is set to
+       match that of the view. */
        void set_camera(Camera *);
+
        void set_content(Renderable *);
 
        virtual void render();