From: Brian Paul <brianp@vmware.com>
Date: Thu, 15 Jul 2010 21:41:48 +0000 (-0600)
Subject: draw: update comments for drawing functions
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=839608a8be2dbcb759626b629f98176e4125e0a2;p=mesa.git

draw: update comments for drawing functions
---

diff --git a/src/gallium/auxiliary/draw/draw_pt.c b/src/gallium/auxiliary/draw/draw_pt.c
index 32bd3d99cce..79d2e58b124 100644
--- a/src/gallium/auxiliary/draw/draw_pt.c
+++ b/src/gallium/auxiliary/draw/draw_pt.c
@@ -297,11 +297,8 @@ draw_print_arrays(struct draw_context *draw, uint prim, int start, uint count)
 
 
 /**
- * Draw vertex arrays
- * This is the main entrypoint into the drawing module.
- * \param prim  one of PIPE_PRIM_x
- * \param start  index of first vertex to draw
- * \param count  number of vertices to draw
+ * Non-instanced drawing.
+ * \sa draw_arrays_instanced
  */
 void
 draw_arrays(struct draw_context *draw, unsigned prim,
@@ -310,6 +307,20 @@ draw_arrays(struct draw_context *draw, unsigned prim,
    draw_arrays_instanced(draw, prim, start, count, 0, 1);
 }
 
+
+/**
+ * Draw vertex arrays.
+ * This is the main entrypoint into the drawing module.
+ * If drawing an indexed primitive, the draw_set_mapped_element_buffer_range()
+ * function should have already been called to specify the element/index buffer
+ * information.
+ *
+ * \param prim  one of PIPE_PRIM_x
+ * \param start  index of first vertex to draw
+ * \param count  number of vertices to draw
+ * \param startInstance  number for the first primitive instance (usually 0).
+ * \param instanceCount  number of instances to draw (1=non-instanced)
+ */
 void
 draw_arrays_instanced(struct draw_context *draw,
                       unsigned mode,