Add a pointer to metrics_info_t from metrics_t

[fips] / metrics.h

diff --git a/metrics.h b/metrics.h
index b5f985977a5a6ecbeec45024a1a45864a5b196c0..230d668422cc702ee61b8c0da6fe0096e19bf4ce 100644 (file)
--- 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,6 +52,29 @@ typedef enum
        METRICS_OP_SHADER
 } metrics_op_t;
 
+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
+ *
+ * All outstanding metrics counters are discarded.
+ *
+ * The metrics_t object remains valid and may be used again.
+ */
+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.
  *
  * The time accumulated will be accounted against the
@@ -77,6 +102,12 @@ metrics_counter_stop (void);
 void
 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).
  *
@@ -86,4 +117,18 @@ metrics_set_current_op (metrics_op_t op);
 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