1 /* Copyright © 2013, Intel Corporation
3 * Permission is hereby granted, free of charge, to any person obtaining a copy
4 * of this software and associated documentation files (the "Software"), to deal
5 * in the Software without restriction, including without limitation the rights
6 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7 * copies of the Software, and to permit persons to whom the Software is
8 * furnished to do so, subject to the following conditions:
10 * The above copyright notice and this permission notice shall be included in
11 * all copies or substantial portions of the Software.
13 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 /* Add a new counter to the metrics tracking state.
27 * The value accumulated in this counter be accounted against the
28 * current program (as set with metrics_set_current_program).
30 * Returns: A counter ID suitable for use with metrics_counter_start
31 * and metrics_counter_stop.
34 metrics_counter_new (void);
36 /* Start accumulating GPU time spent into the given counter. */
38 metrics_counter_start (unsigned counter);
40 /* Stop accumulating GPU time (stops the most-recently started counter) */
42 metrics_counter_stop (void);
44 /* Set the ID of the currently executing shader program.
46 * The metrics-tracking code will account for per-shader-program
47 * timings by accumulating counter values measured while each porogram
48 * is active (see metrics_add_counter).
51 metrics_set_current_program (unsigned program);
53 /* Should be called at the end of every function wrapper for a
54 * function that ends a frame, (glXSwapBuffers and similar).
56 * This function performs whatever bookkeeping is necessary to
57 * generate a timing report, then emits that report.
60 metrics_end_frame (void);