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
28 METRICS_OP_BUFFER_DATA,
29 METRICS_OP_BUFFER_SUB_DATA,
31 METRICS_OP_BLIT_FRAMEBUFFER,
33 METRICS_OP_CLEAR_BUFFER_DATA,
34 METRICS_OP_CLEAR_TEX_IMAGE,
35 METRICS_OP_COPY_PIXELS,
36 METRICS_OP_COPY_TEX_IMAGE,
37 METRICS_OP_DRAW_PIXELS,
38 METRICS_OP_GET_TEX_IMAGE,
39 METRICS_OP_READ_PIXELS,
42 /* METRICS_OP_SHADER must be last.
44 * All larger values for metrics_op_t are interpreted as:
46 * METRICS_OP_SHADER + shader_program_number
48 * to indicate a specific shader program.
53 /* Initialize metrics info
55 * This queries the names and ranges for all available performance counters.
57 * This should be called once before any other metrics functions.
60 metrics_info_init (void);
62 /* Finalize metrics info state.
64 * The function should be called just before setting a new, current,
68 metrics_info_fini (void);
70 /* Start accumulating GPU time.
72 * The time accumulated will be accounted against the
73 * current program (as set with metrics_set_current_program).
76 metrics_counter_start (void);
78 /* Stop accumulating GPU time (stops the most-recently started counter) */
80 metrics_counter_stop (void);
82 /* Set a metrics_op_t value to indicate what kind of operation is
85 * The metrics-tracking code will account for timings by accumulating
86 * measured counter values into a separate counter for each
87 * metrics_op_t value, (so that the report can describe which
88 * operations are the most expensive).
90 * In addition, for the value METRICS_OP_SHADER, each specific shader
91 * program can be distinguished. To accomplish this, pass a value of
92 * METRICS_OP_SHADER + shader_program_number to this function.
95 metrics_set_current_op (metrics_op_t op);
97 /* Return the current metrics_op_t value, (the value most-recently-set
98 * with a call to metrics_set_current_op).
101 metrics_get_current_op (void);
103 /* Should be called at the end of every function wrapper for a
104 * function that ends a frame, (glXSwapBuffers and similar).
106 * This function performs whatever bookkeeping is necessary to
107 * generate a timing report, then emits that report.
110 metrics_end_frame (void);