Begin re-factoring metrics.c into separate context.c and metrics-info.c

[fips] / metrics.h

diff --git a/metrics.h b/metrics.h
index 8b688678d2f5601d1471d67289418ff13f5fc8a4..8bae21f36a5c570f9b1bc0100910c36de002c60c 100644 (file)
--- a/metrics.h
+++ b/metrics.h
@@ -22,6 +22,34 @@
 #ifndef METRICS_H
 #define METRICS_H
 
+typedef enum
+{
+       METRICS_OP_ACCUM,
+       METRICS_OP_BUFFER_DATA,
+       METRICS_OP_BUFFER_SUB_DATA,
+       METRICS_OP_BITMAP,
+       METRICS_OP_BLIT_FRAMEBUFFER,
+       METRICS_OP_CLEAR,
+       METRICS_OP_CLEAR_BUFFER_DATA,
+       METRICS_OP_CLEAR_TEX_IMAGE,
+       METRICS_OP_COPY_PIXELS,
+       METRICS_OP_COPY_TEX_IMAGE,
+       METRICS_OP_DRAW_PIXELS,
+       METRICS_OP_GET_TEX_IMAGE,
+       METRICS_OP_READ_PIXELS,
+       METRICS_OP_TEX_IMAGE,
+
+       /* METRICS_OP_SHADER must be last.
+        * 
+        * All larger values for metrics_op_t are interpreted as:
+        *
+        *      METRICS_OP_SHADER + shader_program_number
+        *
+        * to indicate a specific shader program.
+        */
+       METRICS_OP_SHADER
+} metrics_op_t;
+
 /* Start accumulating GPU time.
  *
  * The time accumulated will be accounted against the
@@ -34,14 +62,26 @@ metrics_counter_start (void);
 void
 metrics_counter_stop (void);
 
-/* Set the ID of the currently executing shader program.
+/* Set a metrics_op_t value to indicate what kind of operation is
+ * being performed.
+ *
+ * The metrics-tracking code will account for timings by accumulating
+ * measured counter values into a separate counter for each
+ * metrics_op_t value, (so that the report can describe which
+ * operations are the most expensive).
  *
- * The metrics-tracking code will account for per-shader-program
- * timings by accumulating counter values measured while each porogram
- * is active (see metrics_add_counter).
+ * In addition, for the value METRICS_OP_SHADER, each specific shader
+ * program can be distinguished. To accomplish this, pass a value of
+ * METRICS_OP_SHADER + shader_program_number to this function.
  */
 void
-metrics_set_current_program (unsigned program);
+metrics_set_current_op (metrics_op_t op);
+
+/* Return the current metrics_op_t value, (the value most-recently-set
+ * with a call to metrics_set_current_op).
+ */
+metrics_op_t
+metrics_get_current_op (void);
 
 /* Should be called at the end of every function wrapper for a
  * function that ends a frame, (glXSwapBuffers and similar).
@@ -52,4 +92,18 @@ metrics_set_current_program (unsigned program);
 void
 metrics_end_frame (void);
 
+/* Process outstanding metrics requests, accumulating results.
+ *
+ * This function is called automatically by metrics_end_frame.
+ *
+ * During a frame, it may be important to call this function to avoid
+ * too many oustanding timer/performance-monitor queries. At the same
+ * time, it's important not to call this function too frequently,
+ * since collection of metrics information will result in flushes of
+ * the OpenGL pipeline which can interfere with the behavior being
+ * measured.
+ */
+void
+metrics_collect_available (void);
+
 #endif