Copy the material slot of RenderPass

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

diff --git a/source/vertexarray.h b/source/vertexarray.h
index d6dee7dd59ce3a9f3c81185aed2a405fa571277a..6e54f681717f4269fb135f66bd18420b5d87943e 100644 (file)
--- a/source/vertexarray.h
+++ b/source/vertexarray.h
@@ -17,6 +17,17 @@ namespace GL {
 
 class Buffer;
 
+/**
+Stores vertex data.  Both legacy and generic attributes are supported.  Mixing
+the two is possible but discouraged, as driver-specific issues may arise.
+
+The array's contents can be modified with the append and modify methods.  To
+obtain the location of an individual component within the vertex, use
+VertexFormat::offset.
+
+A higher-level interface for filling in vertex data is available in the
+VertexArrayBuilder class.
+*/
 class VertexArray: public Bindable<VertexArray>, public Bufferable
 {
 public:
@@ -49,18 +60,24 @@ public:
        VertexArray(const VertexFormat &);
        ~VertexArray();
 
+       /// Resets the VertexArray to a different format.  All data is cleared.
        void reset(const VertexFormat &);
+
        const VertexFormat &get_format() const { return format; }
 private:
        static unsigned get_array_slot(unsigned char);
 
 public:
-       /// Deprecated alias for use_buffer
-       void use_vertex_buffer(Buffer *b) { use_buffer(b); }
-
+       /// Clears all vertices from the array.
        void clear();
+
+       /// Reserve space for vertices.
        void reserve(unsigned);
+
+       /// Append a new vertex at the end of the array and return its location.
        float *append();
+
+       /// Returns the location of a vertex for modification.
        float *modify(unsigned);
 private:
        virtual unsigned get_data_size() const;
@@ -71,8 +88,15 @@ public:
        const std::vector<float> &get_data() const { return data; }
        const float *operator[](unsigned i) const { return &data[0]+i*stride; }
 
+       /** Equivalent to apply(true).  For compatibility with the Bindable
+       interface. */
        void bind() const { apply(); }
-       void apply(bool = true) const;
+
+       /** Applies component arrays to the GL.  If legacy is true, they are applied
+       as is.  If legacy is false, any legacy attributes are converted to generic
+       attributes. */
+       void apply(bool legacy = true) const;
+
 private:
        static void apply_arrays(const std::vector<Array> *, const std::vector<Array> *, const float *, unsigned, bool);
 public: