]> git.tdb.fi Git - libs/gl.git/blobdiff - source/materials/rendermethod.h
Check the flat qualifier from the correct member
[libs/gl.git] / source / materials / rendermethod.h
index 94f716a41c871d4705f76bc585ad493087379fa6..8fd289fe47c4a6638c7bc25e3e9fa6dc7e25bc7e 100644 (file)
@@ -17,8 +17,11 @@ class Sampler;
 class Texture;
 
 /**
-Encapsulates the data that determines the appearance of a rendered surface.
-This includes shader and data for it, material and texturing.
+Describes the appearance of a surface with a shader, uniform values and
+textures.
+
+A Material can be used to automatically populate most of the fields of a
+RenderMethod.
 */
 class RenderMethod
 {
@@ -82,20 +85,27 @@ private:
        const Material *material = 0;
        std::string material_slot;
        std::vector<TextureSlot> textures;
-       CullMode face_cull = CULL_BACK;
+       CullMode face_cull = NO_CULL;
        Blend blend;
        bool receive_shadows = false;
        bool image_based_lighting = false;
+       bool instancing = false;
 
        void maybe_create_material_shader();
        void set_material_textures();
 
 public:
+       /** Sets the shader program and uniform values. */
        void set_shader_program(const Program *, const ProgramData *);
+
        const Program *get_shader_program() const { return shprog; }
        const ProgramData *get_shader_data() const { return shdata.get(); }
        Tag get_slotted_uniform_tag(Tag) const;
+
+       /** Sets a Material to use as a basis for the render method.  If a shader
+       has not been explicitly set, the material's shader will be used. */
        void set_material(const Material *);
+
        const Material *get_material() const { return material; }
        const std::string &get_material_slot_name() const { return material_slot; }
        void set_texture(Tag, const Texture *, const Sampler * = 0);
@@ -104,11 +114,25 @@ public:
        CullMode get_face_cull() const { return face_cull; }
        void set_blend(const Blend &);
        const Blend &get_blend() const { return blend; }
+
+       /** Toggles shadows on objects using this render method.  Only affects
+       shaders created from materials.  A ShadowMap effect is required. */
        void set_receive_shadows(bool);
+
        bool get_receive_shadows() const { return receive_shadows; }
+
+       /** Toggles the use of an environment map as a light source.  Only affects
+       shaders created from materials.  An EnvironmentMap effect is required. */
        void set_image_based_lighting(bool);
+
        bool get_image_based_lighting() const { return image_based_lighting; }
 
+       /** Toggles instanced rendering.  Only affects shaders created from
+       materials.  Should be used with InstanceArray. */
+       void set_instancing(bool);
+
+       bool get_instancing() const { return instancing; }
+
        void apply(Renderer &) const;
 
        void set_debug_name(const std::string &);