From 02343325a49437532a6b263b1c5453cc6e51b71b Mon Sep 17 00:00:00 2001 From: Mikko Rasa Date: Sun, 10 Sep 2017 15:07:24 +0300 Subject: [PATCH] Some comment updates --- source/extension.h | 4 ++++ source/pipeline.h | 3 +++ source/renderable.h | 8 +++++--- source/text.h | 2 +- 4 files changed, 13 insertions(+), 4 deletions(-) diff --git a/source/extension.h b/source/extension.h index 1b149367..cf824e24 100644 --- 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 1e5b6aa4..4ee59444 100644 --- 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 e90ab024..6e1505ca 100644 --- 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 7bf79560..40c9b850 100644 --- 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(); } -- 2.45.2