X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=metrics.h;h=69afafb9b69b5cf6f164dba37d4042dbda4e4092;hb=dfb96c9b64def8674a38dda2bc2276d4e2cdd58e;hp=accafe5f8e91f2660e46687dfc39cbf959b107cc;hpb=2760598732e9c373f3331d7d125b580a224bbbe3;p=fips

diff --git a/metrics.h b/metrics.h
index accafe5..69afafb 100644
--- a/metrics.h
+++ b/metrics.h
@@ -22,6 +22,8 @@
 #ifndef METRICS_H
 #define METRICS_H
 
+#include "metrics-info.h"
+
 typedef enum
 {
 	METRICS_OP_ACCUM,
@@ -50,14 +52,28 @@ typedef enum
 	METRICS_OP_SHADER
 } metrics_op_t;
 
-/* Initialize metrics info
+typedef struct metrics metrics_t;
+
+/* Create a new metrics_t object for tracking metrics, given the
+ * pre-initialized metrics_info_t* describing available counters. */
+metrics_t *
+metrics_create (metrics_info_t *info);
+
+/* Free all internal resources of a metrics_t
  *
- * This queries the names and ranges for all available performance counters.
+ * All outstanding metrics counters are discarded.
  *
- * This should be called once before any other metrics functions.
+ * The metrics_t object remains valid and may be used again.
  */
 void
-metrics_info_init (void);
+metrics_fini (metrics_t *metrics);
+
+/* Destroy a metrics_t object.
+ *
+ * After this call, the metrics_t* value is and must not be used
+ * further. */
+void
+metrics_destroy (metrics_t *metrics);
 
 /* Start accumulating GPU time.
  *
@@ -65,11 +81,11 @@ metrics_info_init (void);
  * current program (as set with metrics_set_current_program).
  */
 void
-metrics_counter_start (void);
+metrics_counter_start (metrics_t *metrics);
 
 /* Stop accumulating GPU time (stops the most-recently started counter) */
 void
-metrics_counter_stop (void);
+metrics_counter_stop (metrics_t *metrics);
 
 /* Set a metrics_op_t value to indicate what kind of operation is
  * being performed.
@@ -84,13 +100,13 @@ metrics_counter_stop (void);
  * METRICS_OP_SHADER + shader_program_number to this function.
  */
 void
-metrics_set_current_op (metrics_op_t op);
+metrics_set_current_op (metrics_t *metrics, 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);
+metrics_get_current_op (metrics_t *metrics);
 
 /* Should be called at the end of every function wrapper for a
  * function that ends a frame, (glXSwapBuffers and similar).
@@ -99,6 +115,20 @@ metrics_get_current_op (void);
  * generate a timing report, then emits that report.
  */
 void
-metrics_end_frame (void);
+metrics_end_frame (metrics_t *metrics);
+
+/* 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 (metrics_t *metrics);
 
 #endif