X-Git-Url: http://git.tdb.fi/?a=blobdiff_plain;f=source%2Fvertexarray.h;h=efbf8ce27cb2f4ef25c74c5b14c49ce1b2c2dd02;hb=42923751e8e2ef1472058f32194ad95d47d073ea;hp=9fa55b7117c32fdc2901c74215223b6616f9fa53;hpb=0ef8e620a008e92069b0dd9ae4e972bc69430fc7;p=libs%2Fgl.git

diff --git a/source/vertexarray.h b/source/vertexarray.h
index 9fa55b71..efbf8ce2 100644
--- a/source/vertexarray.h
+++ b/source/vertexarray.h
@@ -17,6 +17,16 @@ namespace GL {
 
 class Buffer;
 
+/**
+Stores vertex data.
+
+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:
@@ -46,18 +56,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;
@@ -68,8 +84,12 @@ public:
 	const std::vector<float> &get_data() const { return data; }
 	const float *operator[](unsigned i) const { return &data[0]+i*stride; }
 
-	void bind() const;
-	void apply() const { bind(); }
+	/// Equivalent to apply().  For compatibility with the Bindable interface.
+	void bind() const { apply(); }
+
+	/// Applies component arrays to the GL.
+	void apply() const;
+
 private:
 	static void apply_arrays(const std::vector<Array> *, const std::vector<Array> *, const float *, unsigned);
 public: