source/blender/editors/space_sequencer/sequencer_quads_batch.hh

@@ -15,16 +15,27 @@ struct GPUIndexBuf;
 struct GPUBatch;
 struct ColorVertex;
 
+/**
+ * Flat-colored 2D geometry draw batching utility.
+ *
+ * Internally uses #GPU_SHADER_3D_FLAT_COLOR to draw single-colored rectangles, quads
+ * or lines. After adding a number of primitives with #add_quad, #add_wire_quad, #add_line,
+ * draw them using #draw. Note that #draw can be called behind the scenes if number of primitives
+ * is larger than the internal batch buffer size.
+ */
 class SeqQuadsBatch {
  public:
   SeqQuadsBatch();
   ~SeqQuadsBatch();
 
+  /** Draw all the previously added primitives.  */
   void draw();
+  /** Add an axis-aligned quad. */
   void add_quad(float x1, float y1, float x2, float y2, const uchar color[4])
   {
     add_quad(x1, y1, x1, y2, x2, y1, x2, y2, color);
   }
+  /** Add a quad. */
   void add_quad(float x1,
                 float y1,
                 float x2,
@@ -34,7 +45,9 @@ class SeqQuadsBatch {
                 float x4,
                 float y4,
                 const uchar color[4]);
+  /** Add four lines of an axis-aligned quad edges. */
   void add_wire_quad(float x1, float y1, float x2, float y2, const uchar color[4]);
+  /** Add a line. */
   void add_line(float x1, float y1, float x2, float y2, const uchar color[4]);
 
  private: