1 /**************************************************************************
3 * Copyright 2013 Marek Olšák <maraeo@gmail.com>
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the
8 * "Software"), to deal in the Software without restriction, including
9 * without limitation the rights to use, copy, modify, merge, publish,
10 * distribute, sub license, and/or sell copies of the Software, and to
11 * permit persons to whom the Software is furnished to do so, subject to
12 * the following conditions:
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial portions
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
21 * IN NO EVENT SHALL THE AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR
22 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
23 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
24 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
26 **************************************************************************/
28 /* This head-up display module can draw transparent graphs on top of what
29 * the app is rendering, visualizing various data like framerate, cpu load,
30 * performance counters, etc. It can be hook up into any state tracker.
32 * The HUD is controlled with the GALLIUM_HUD environment variable.
33 * Set GALLIUM_HUD=help for more info.
38 #include "hud/hud_context.h"
39 #include "hud/hud_private.h"
42 #include "cso_cache/cso_context.h"
43 #include "util/u_draw_quad.h"
44 #include "util/u_inlines.h"
45 #include "util/u_memory.h"
46 #include "util/u_math.h"
47 #include "util/u_simple_shaders.h"
48 #include "util/u_string.h"
49 #include "util/u_upload_mgr.h"
50 #include "tgsi/tgsi_text.h"
51 #include "tgsi/tgsi_dump.h"
55 struct pipe_context
*pipe
;
56 struct cso_context
*cso
;
57 struct u_upload_mgr
*uploader
;
59 struct list_head pane_list
;
62 struct pipe_blend_state alpha_blend
;
63 struct pipe_depth_stencil_alpha_state dsa
;
64 void *fs_color
, *fs_text
;
65 struct pipe_rasterizer_state rasterizer
;
67 struct pipe_vertex_element velems
[2];
70 struct util_font font
;
71 struct pipe_sampler_view
*font_sampler_view
;
72 struct pipe_sampler_state font_sampler_state
;
74 /* VS constant buffer */
77 float two_div_fb_width
;
78 float two_div_fb_height
;
83 struct pipe_constant_buffer constbuf
;
85 unsigned fb_width
, fb_height
;
87 /* vertices for text and background drawing are accumulated here and then
88 * drawn all at once */
91 struct pipe_vertex_buffer vbuf
;
92 unsigned max_num_vertices
;
93 unsigned num_vertices
;
94 } text
, bg
, whitelines
;
99 hud_draw_colored_prims(struct hud_context
*hud
, unsigned prim
,
100 float *buffer
, unsigned num_vertices
,
101 float r
, float g
, float b
, float a
,
102 int xoffset
, int yoffset
, float yscale
)
104 struct cso_context
*cso
= hud
->cso
;
105 struct pipe_vertex_buffer vbuffer
= {0};
107 hud
->constants
.color
[0] = r
;
108 hud
->constants
.color
[1] = g
;
109 hud
->constants
.color
[2] = b
;
110 hud
->constants
.color
[3] = a
;
111 hud
->constants
.translate
[0] = (float) xoffset
;
112 hud
->constants
.translate
[1] = (float) yoffset
;
113 hud
->constants
.scale
[0] = 1;
114 hud
->constants
.scale
[1] = yscale
;
115 cso_set_constant_buffer(cso
, PIPE_SHADER_VERTEX
, 0, &hud
->constbuf
);
117 vbuffer
.user_buffer
= buffer
;
118 vbuffer
.stride
= 2 * sizeof(float);
120 cso_set_vertex_buffers(cso
, cso_get_aux_vertex_buffer_slot(cso
),
122 cso_set_fragment_shader_handle(hud
->cso
, hud
->fs_color
);
123 cso_draw_arrays(cso
, prim
, 0, num_vertices
);
127 hud_draw_colored_quad(struct hud_context
*hud
, unsigned prim
,
128 unsigned x1
, unsigned y1
, unsigned x2
, unsigned y2
,
129 float r
, float g
, float b
, float a
)
132 (float) x1
, (float) y1
,
133 (float) x1
, (float) y2
,
134 (float) x2
, (float) y2
,
135 (float) x2
, (float) y1
,
138 hud_draw_colored_prims(hud
, prim
, buffer
, 4, r
, g
, b
, a
, 0, 0, 1);
142 hud_draw_background_quad(struct hud_context
*hud
,
143 unsigned x1
, unsigned y1
, unsigned x2
, unsigned y2
)
145 float *vertices
= hud
->bg
.vertices
+ hud
->bg
.num_vertices
*2;
148 assert(hud
->bg
.num_vertices
+ 4 <= hud
->bg
.max_num_vertices
);
150 vertices
[num
++] = (float) x1
;
151 vertices
[num
++] = (float) y1
;
153 vertices
[num
++] = (float) x1
;
154 vertices
[num
++] = (float) y2
;
156 vertices
[num
++] = (float) x2
;
157 vertices
[num
++] = (float) y2
;
159 vertices
[num
++] = (float) x2
;
160 vertices
[num
++] = (float) y1
;
162 hud
->bg
.num_vertices
+= num
/2;
166 hud_draw_string(struct hud_context
*hud
, unsigned x
, unsigned y
,
167 const char *str
, ...)
171 float *vertices
= hud
->text
.vertices
+ hud
->text
.num_vertices
*4;
176 util_vsnprintf(buf
, sizeof(buf
), str
, ap
);
182 hud_draw_background_quad(hud
,
184 x
+ strlen(buf
)*hud
->font
.glyph_width
,
185 y
+ hud
->font
.glyph_height
);
190 unsigned x2
= x
+ hud
->font
.glyph_width
;
191 unsigned y2
= y
+ hud
->font
.glyph_height
;
192 unsigned tx1
= (*s
% 16) * hud
->font
.glyph_width
;
193 unsigned ty1
= (*s
/ 16) * hud
->font
.glyph_height
;
194 unsigned tx2
= tx1
+ hud
->font
.glyph_width
;
195 unsigned ty2
= ty1
+ hud
->font
.glyph_height
;
198 x
+= hud
->font
.glyph_width
;
203 assert(hud
->text
.num_vertices
+ num
/4 + 4 <= hud
->text
.max_num_vertices
);
205 vertices
[num
++] = (float) x1
;
206 vertices
[num
++] = (float) y1
;
207 vertices
[num
++] = (float) tx1
;
208 vertices
[num
++] = (float) ty1
;
210 vertices
[num
++] = (float) x1
;
211 vertices
[num
++] = (float) y2
;
212 vertices
[num
++] = (float) tx1
;
213 vertices
[num
++] = (float) ty2
;
215 vertices
[num
++] = (float) x2
;
216 vertices
[num
++] = (float) y2
;
217 vertices
[num
++] = (float) tx2
;
218 vertices
[num
++] = (float) ty2
;
220 vertices
[num
++] = (float) x2
;
221 vertices
[num
++] = (float) y1
;
222 vertices
[num
++] = (float) tx2
;
223 vertices
[num
++] = (float) ty1
;
225 x
+= hud
->font
.glyph_width
;
229 hud
->text
.num_vertices
+= num
/4;
233 number_to_human_readable(uint64_t num
, boolean is_in_bytes
, char *out
)
235 static const char *byte_units
[] =
236 {"", " KB", " MB", " GB", " TB", " PB", " EB"};
237 static const char *metric_units
[] =
238 {"", " k", " M", " G", " T", " P", " E"};
239 const char **units
= is_in_bytes
? byte_units
: metric_units
;
240 double divisor
= is_in_bytes
? 1024 : 1000;
244 while (d
> divisor
) {
249 if (d
>= 100 || d
== (int)d
)
250 sprintf(out
, "%.0f%s", d
, units
[unit
]);
251 else if (d
>= 10 || d
*10 == (int)(d
*10))
252 sprintf(out
, "%.1f%s", d
, units
[unit
]);
254 sprintf(out
, "%.2f%s", d
, units
[unit
]);
258 hud_draw_graph_line_strip(struct hud_context
*hud
, const struct hud_graph
*gr
,
259 unsigned xoffset
, unsigned yoffset
, float yscale
)
261 if (gr
->num_vertices
<= 1)
264 assert(gr
->index
<= gr
->num_vertices
);
266 hud_draw_colored_prims(hud
, PIPE_PRIM_LINE_STRIP
,
267 gr
->vertices
, gr
->index
,
268 gr
->color
[0], gr
->color
[1], gr
->color
[2], 1,
269 xoffset
+ (gr
->pane
->max_num_vertices
- gr
->index
- 1) * 2 - 1,
272 if (gr
->num_vertices
<= gr
->index
)
275 hud_draw_colored_prims(hud
, PIPE_PRIM_LINE_STRIP
,
276 gr
->vertices
+ gr
->index
*2,
277 gr
->num_vertices
- gr
->index
,
278 gr
->color
[0], gr
->color
[1], gr
->color
[2], 1,
279 xoffset
- gr
->index
*2 - 1, yoffset
, yscale
);
283 hud_pane_accumulate_vertices(struct hud_context
*hud
,
284 const struct hud_pane
*pane
)
286 struct hud_graph
*gr
;
287 float *line_verts
= hud
->whitelines
.vertices
+ hud
->whitelines
.num_vertices
*2;
291 /* draw background */
292 hud_draw_background_quad(hud
,
296 /* draw numbers on the right-hand side */
297 for (i
= 0; i
< 6; i
++) {
298 unsigned x
= pane
->x2
+ 2;
299 unsigned y
= pane
->inner_y1
+ pane
->inner_height
* (5 - i
) / 5 -
300 hud
->font
.glyph_height
/ 2;
302 number_to_human_readable(pane
->max_value
* i
/ 5,
303 pane
->uses_byte_units
, str
);
304 hud_draw_string(hud
, x
, y
, str
);
307 /* draw info below the pane */
309 LIST_FOR_EACH_ENTRY(gr
, &pane
->graph_list
, head
) {
310 unsigned x
= pane
->x1
+ 2;
311 unsigned y
= pane
->y2
+ 2 + i
*hud
->font
.glyph_height
;
313 number_to_human_readable(gr
->current_value
,
314 pane
->uses_byte_units
, str
);
315 hud_draw_string(hud
, x
, y
, " %s: %s", gr
->name
, str
);
320 assert(hud
->whitelines
.num_vertices
+ num
/2 + 8 <= hud
->whitelines
.max_num_vertices
);
321 line_verts
[num
++] = (float) pane
->x1
;
322 line_verts
[num
++] = (float) pane
->y1
;
323 line_verts
[num
++] = (float) pane
->x2
;
324 line_verts
[num
++] = (float) pane
->y1
;
326 line_verts
[num
++] = (float) pane
->x2
;
327 line_verts
[num
++] = (float) pane
->y1
;
328 line_verts
[num
++] = (float) pane
->x2
;
329 line_verts
[num
++] = (float) pane
->y2
;
331 line_verts
[num
++] = (float) pane
->x1
;
332 line_verts
[num
++] = (float) pane
->y2
;
333 line_verts
[num
++] = (float) pane
->x2
;
334 line_verts
[num
++] = (float) pane
->y2
;
336 line_verts
[num
++] = (float) pane
->x1
;
337 line_verts
[num
++] = (float) pane
->y1
;
338 line_verts
[num
++] = (float) pane
->x1
;
339 line_verts
[num
++] = (float) pane
->y2
;
341 /* draw horizontal lines inside the graph */
342 for (i
= 0; i
<= 5; i
++) {
343 float y
= round((pane
->max_value
* i
/ 5.0) * pane
->yscale
+ pane
->inner_y2
);
345 assert(hud
->whitelines
.num_vertices
+ num
/2 + 2 <= hud
->whitelines
.max_num_vertices
);
346 line_verts
[num
++] = pane
->x1
;
347 line_verts
[num
++] = y
;
348 line_verts
[num
++] = pane
->x2
;
349 line_verts
[num
++] = y
;
352 hud
->whitelines
.num_vertices
+= num
/2;
356 hud_pane_draw_colored_objects(struct hud_context
*hud
,
357 const struct hud_pane
*pane
)
359 struct hud_graph
*gr
;
362 /* draw colored quads below the pane */
364 LIST_FOR_EACH_ENTRY(gr
, &pane
->graph_list
, head
) {
365 unsigned x
= pane
->x1
+ 2;
366 unsigned y
= pane
->y2
+ 2 + i
*hud
->font
.glyph_height
;
368 hud_draw_colored_quad(hud
, PIPE_PRIM_QUADS
, x
+ 1, y
+ 1, x
+ 12, y
+ 13,
369 gr
->color
[0], gr
->color
[1], gr
->color
[2], 1);
373 /* draw the line strips */
374 LIST_FOR_EACH_ENTRY(gr
, &pane
->graph_list
, head
) {
375 hud_draw_graph_line_strip(hud
, gr
, pane
->inner_x1
, pane
->inner_y2
, pane
->yscale
);
380 hud_alloc_vertices(struct hud_context
*hud
, struct vertex_queue
*v
,
381 unsigned num_vertices
, unsigned stride
)
384 v
->max_num_vertices
= num_vertices
;
385 v
->vbuf
.stride
= stride
;
386 u_upload_alloc(hud
->uploader
, 0, v
->vbuf
.stride
* v
->max_num_vertices
,
387 &v
->vbuf
.buffer_offset
, &v
->vbuf
.buffer
,
388 (void**)&v
->vertices
);
392 * Draw the HUD to the texture \p tex.
393 * The texture is usually the back buffer being displayed.
396 hud_draw(struct hud_context
*hud
, struct pipe_resource
*tex
)
398 struct cso_context
*cso
= hud
->cso
;
399 struct pipe_context
*pipe
= hud
->pipe
;
400 struct pipe_framebuffer_state fb
;
401 struct pipe_surface surf_templ
, *surf
;
402 struct pipe_viewport_state viewport
;
403 const struct pipe_sampler_state
*sampler_states
[] =
404 { &hud
->font_sampler_state
};
405 struct hud_pane
*pane
;
406 struct hud_graph
*gr
;
408 hud
->fb_width
= tex
->width0
;
409 hud
->fb_height
= tex
->height0
;
410 hud
->constants
.two_div_fb_width
= 2.0f
/ hud
->fb_width
;
411 hud
->constants
.two_div_fb_height
= 2.0f
/ hud
->fb_height
;
413 cso_save_framebuffer(cso
);
414 cso_save_sample_mask(cso
);
416 cso_save_depth_stencil_alpha(cso
);
417 cso_save_fragment_shader(cso
);
418 cso_save_sampler_views(cso
, PIPE_SHADER_FRAGMENT
);
419 cso_save_samplers(cso
, PIPE_SHADER_FRAGMENT
);
420 cso_save_rasterizer(cso
);
421 cso_save_viewport(cso
);
422 cso_save_stream_outputs(cso
);
423 cso_save_geometry_shader(cso
);
424 cso_save_vertex_shader(cso
);
425 cso_save_vertex_elements(cso
);
426 cso_save_aux_vertex_buffer_slot(cso
);
427 cso_save_constant_buffer_slot0(cso
, PIPE_SHADER_VERTEX
);
428 cso_save_render_condition(cso
);
431 memset(&surf_templ
, 0, sizeof(surf_templ
));
432 surf_templ
.format
= tex
->format
;
433 surf
= pipe
->create_surface(pipe
, tex
, &surf_templ
);
435 memset(&fb
, 0, sizeof(fb
));
439 fb
.width
= hud
->fb_width
;
440 fb
.height
= hud
->fb_height
;
442 viewport
.scale
[0] = 0.5f
* hud
->fb_width
;
443 viewport
.scale
[1] = 0.5f
* hud
->fb_height
;
444 viewport
.scale
[2] = 1.0f
;
445 viewport
.scale
[3] = 1.0f
;
446 viewport
.translate
[0] = 0.5f
* hud
->fb_width
;
447 viewport
.translate
[1] = 0.5f
* hud
->fb_height
;
448 viewport
.translate
[2] = 0.0f
;
449 viewport
.translate
[3] = 0.0f
;
451 cso_set_framebuffer(cso
, &fb
);
452 cso_set_sample_mask(cso
, ~0);
453 cso_set_blend(cso
, &hud
->alpha_blend
);
454 cso_set_depth_stencil_alpha(cso
, &hud
->dsa
);
455 cso_set_rasterizer(cso
, &hud
->rasterizer
);
456 cso_set_viewport(cso
, &viewport
);
457 cso_set_stream_outputs(cso
, 0, NULL
, 0);
458 cso_set_geometry_shader_handle(cso
, NULL
);
459 cso_set_vertex_shader_handle(cso
, hud
->vs
);
460 cso_set_vertex_elements(cso
, 2, hud
->velems
);
461 cso_set_render_condition(cso
, NULL
, FALSE
, 0);
462 cso_set_sampler_views(cso
, PIPE_SHADER_FRAGMENT
, 1,
463 &hud
->font_sampler_view
);
464 cso_set_samplers(cso
, PIPE_SHADER_FRAGMENT
, 1, sampler_states
);
465 cso_set_constant_buffer(cso
, PIPE_SHADER_VERTEX
, 0, &hud
->constbuf
);
467 /* prepare vertex buffers */
468 hud_alloc_vertices(hud
, &hud
->bg
, 4 * 128, 2 * sizeof(float));
469 hud_alloc_vertices(hud
, &hud
->whitelines
, 4 * 256, 2 * sizeof(float));
470 hud_alloc_vertices(hud
, &hud
->text
, 4 * 512, 4 * sizeof(float));
472 /* prepare all graphs */
473 LIST_FOR_EACH_ENTRY(pane
, &hud
->pane_list
, head
) {
474 LIST_FOR_EACH_ENTRY(gr
, &pane
->graph_list
, head
) {
475 gr
->query_new_value(gr
);
478 hud_pane_accumulate_vertices(hud
, pane
);
481 /* unmap the uploader's vertex buffer before drawing */
482 u_upload_unmap(hud
->uploader
);
484 /* draw accumulated vertices for background quads */
485 cso_set_fragment_shader_handle(hud
->cso
, hud
->fs_color
);
487 if (hud
->bg
.num_vertices
) {
488 hud
->constants
.color
[0] = 0;
489 hud
->constants
.color
[1] = 0;
490 hud
->constants
.color
[2] = 0;
491 hud
->constants
.color
[3] = 0.666f
;
492 hud
->constants
.translate
[0] = 0;
493 hud
->constants
.translate
[1] = 0;
494 hud
->constants
.scale
[0] = 1;
495 hud
->constants
.scale
[1] = 1;
497 cso_set_constant_buffer(cso
, PIPE_SHADER_VERTEX
, 0, &hud
->constbuf
);
498 cso_set_vertex_buffers(cso
, cso_get_aux_vertex_buffer_slot(cso
), 1,
500 cso_draw_arrays(cso
, PIPE_PRIM_QUADS
, 0, hud
->bg
.num_vertices
);
502 pipe_resource_reference(&hud
->bg
.vbuf
.buffer
, NULL
);
504 /* draw accumulated vertices for white lines */
505 hud
->constants
.color
[0] = 1;
506 hud
->constants
.color
[1] = 1;
507 hud
->constants
.color
[2] = 1;
508 hud
->constants
.color
[3] = 1;
509 hud
->constants
.translate
[0] = 0;
510 hud
->constants
.translate
[1] = 0;
511 hud
->constants
.scale
[0] = 1;
512 hud
->constants
.scale
[1] = 1;
513 cso_set_constant_buffer(cso
, PIPE_SHADER_VERTEX
, 0, &hud
->constbuf
);
515 if (hud
->whitelines
.num_vertices
) {
516 cso_set_vertex_buffers(cso
, cso_get_aux_vertex_buffer_slot(cso
), 1,
517 &hud
->whitelines
.vbuf
);
518 cso_set_fragment_shader_handle(hud
->cso
, hud
->fs_color
);
519 cso_draw_arrays(cso
, PIPE_PRIM_LINES
, 0, hud
->whitelines
.num_vertices
);
521 pipe_resource_reference(&hud
->whitelines
.vbuf
.buffer
, NULL
);
523 /* draw accumulated vertices for text */
524 if (hud
->text
.num_vertices
) {
525 cso_set_vertex_buffers(cso
, cso_get_aux_vertex_buffer_slot(cso
), 1,
527 cso_set_fragment_shader_handle(hud
->cso
, hud
->fs_text
);
528 cso_draw_arrays(cso
, PIPE_PRIM_QUADS
, 0, hud
->text
.num_vertices
);
530 pipe_resource_reference(&hud
->text
.vbuf
.buffer
, NULL
);
533 LIST_FOR_EACH_ENTRY(pane
, &hud
->pane_list
, head
) {
535 hud_pane_draw_colored_objects(hud
, pane
);
539 cso_restore_framebuffer(cso
);
540 cso_restore_sample_mask(cso
);
541 cso_restore_blend(cso
);
542 cso_restore_depth_stencil_alpha(cso
);
543 cso_restore_fragment_shader(cso
);
544 cso_restore_sampler_views(cso
, PIPE_SHADER_FRAGMENT
);
545 cso_restore_samplers(cso
, PIPE_SHADER_FRAGMENT
);
546 cso_restore_rasterizer(cso
);
547 cso_restore_viewport(cso
);
548 cso_restore_stream_outputs(cso
);
549 cso_restore_geometry_shader(cso
);
550 cso_restore_vertex_shader(cso
);
551 cso_restore_vertex_elements(cso
);
552 cso_restore_aux_vertex_buffer_slot(cso
);
553 cso_restore_constant_buffer_slot0(cso
, PIPE_SHADER_VERTEX
);
554 cso_restore_render_condition(cso
);
556 pipe_surface_reference(&surf
, NULL
);
560 * Set the maximum value for the Y axis of the graph.
561 * This scales the graph accordingly.
564 hud_pane_set_max_value(struct hud_pane
*pane
, uint64_t value
)
566 pane
->max_value
= value
;
567 pane
->yscale
= -(int)pane
->inner_height
/ (float)pane
->max_value
;
570 static struct hud_pane
*
571 hud_pane_create(unsigned x1
, unsigned y1
, unsigned x2
, unsigned y2
,
572 unsigned period
, uint64_t max_value
)
574 struct hud_pane
*pane
= CALLOC_STRUCT(hud_pane
);
583 pane
->inner_x1
= x1
+ 1;
584 pane
->inner_x2
= x2
- 1;
585 pane
->inner_y1
= y1
+ 1;
586 pane
->inner_y2
= y2
- 1;
587 pane
->inner_width
= pane
->inner_x2
- pane
->inner_x1
;
588 pane
->inner_height
= pane
->inner_y2
- pane
->inner_y1
;
589 pane
->period
= period
;
590 pane
->max_num_vertices
= (x2
- x1
+ 2) / 2;
591 hud_pane_set_max_value(pane
, max_value
);
592 LIST_INITHEAD(&pane
->graph_list
);
597 * Add a graph to an existing pane.
598 * One pane can contain multiple graphs over each other.
601 hud_pane_add_graph(struct hud_pane
*pane
, struct hud_graph
*gr
)
603 static const float colors
[][3] = {
612 char *name
= gr
->name
;
614 /* replace '-' with a space */
621 assert(pane
->num_graphs
< Elements(colors
));
622 gr
->vertices
= MALLOC(pane
->max_num_vertices
* sizeof(float) * 2);
623 gr
->color
[0] = colors
[pane
->num_graphs
][0];
624 gr
->color
[1] = colors
[pane
->num_graphs
][1];
625 gr
->color
[2] = colors
[pane
->num_graphs
][2];
627 LIST_ADDTAIL(&gr
->head
, &pane
->graph_list
);
632 hud_graph_add_value(struct hud_graph
*gr
, uint64_t value
)
634 if (gr
->index
== gr
->pane
->max_num_vertices
) {
636 gr
->vertices
[1] = gr
->vertices
[(gr
->index
-1)*2+1];
639 gr
->vertices
[(gr
->index
)*2+0] = (float) (gr
->index
* 2);
640 gr
->vertices
[(gr
->index
)*2+1] = (float) value
;
643 if (gr
->num_vertices
< gr
->pane
->max_num_vertices
) {
647 gr
->current_value
= value
;
648 if (value
> gr
->pane
->max_value
) {
649 hud_pane_set_max_value(gr
->pane
, value
);
654 hud_graph_destroy(struct hud_graph
*graph
)
656 FREE(graph
->vertices
);
657 if (graph
->free_query_data
)
658 graph
->free_query_data(graph
->query_data
);
663 * Read a string from the environment variable.
664 * The separators "+", ",", ":", and ";" terminate the string.
665 * Return the number of read characters.
668 parse_string(const char *s
, char *out
)
672 for (i
= 0; *s
&& *s
!= '+' && *s
!= ',' && *s
!= ':' && *s
!= ';';
679 fprintf(stderr
, "gallium_hud: syntax error: unexpected '%c' (%i) while "
680 "parsing a string\n", *s
, *s
);
685 has_occlusion_query(struct pipe_screen
*screen
)
687 return screen
->get_param(screen
, PIPE_CAP_OCCLUSION_QUERY
) != 0;
691 has_streamout(struct pipe_screen
*screen
)
693 return screen
->get_param(screen
, PIPE_CAP_MAX_STREAM_OUTPUT_BUFFERS
) != 0;
697 has_pipeline_stats_query(struct pipe_screen
*screen
)
699 return screen
->get_param(screen
, PIPE_CAP_QUERY_PIPELINE_STATISTICS
) != 0;
703 hud_parse_env_var(struct hud_context
*hud
, const char *env
)
706 char name
[256], s
[256];
707 struct hud_pane
*pane
= NULL
;
708 unsigned x
= 10, y
= 10;
709 unsigned width
= 251, height
= 100;
710 unsigned period
= 500 * 1000; /* default period (1/2 second) */
711 const char *period_env
;
714 * The GALLIUM_HUD_PERIOD env var sets the graph update rate.
715 * The env var is in seconds (a float).
716 * Zero means update after every frame.
718 period_env
= getenv("GALLIUM_HUD_PERIOD");
720 float p
= (float) atof(period_env
);
722 period
= (unsigned) (p
* 1000 * 1000);
726 while ((num
= parse_string(env
, name
)) != 0) {
730 pane
= hud_pane_create(x
, y
, x
+ width
, y
+ height
, period
, 10);
736 /* IF YOU CHANGE THIS, UPDATE print_help! */
737 if (strcmp(name
, "fps") == 0) {
738 hud_fps_graph_install(pane
);
740 else if (strcmp(name
, "cpu") == 0) {
741 hud_cpu_graph_install(pane
, ALL_CPUS
);
743 else if (sscanf(name
, "cpu%u%s", &i
, s
) == 1) {
744 hud_cpu_graph_install(pane
, i
);
746 else if (strcmp(name
, "samples-passed") == 0 &&
747 has_occlusion_query(hud
->pipe
->screen
)) {
748 hud_pipe_query_install(pane
, hud
->pipe
, "samples-passed",
749 PIPE_QUERY_OCCLUSION_COUNTER
, 0, 0, FALSE
);
751 else if (strcmp(name
, "primitives-generated") == 0 &&
752 has_streamout(hud
->pipe
->screen
)) {
753 hud_pipe_query_install(pane
, hud
->pipe
, "primitives-generated",
754 PIPE_QUERY_PRIMITIVES_GENERATED
, 0, 0, FALSE
);
757 boolean processed
= FALSE
;
759 /* pipeline statistics queries */
760 if (has_pipeline_stats_query(hud
->pipe
->screen
)) {
761 static const char *pipeline_statistics_names
[] =
768 "clipper-invocations",
769 "clipper-primitives-generated",
775 for (i
= 0; i
< Elements(pipeline_statistics_names
); ++i
)
776 if (strcmp(name
, pipeline_statistics_names
[i
]) == 0)
778 if (i
< Elements(pipeline_statistics_names
)) {
779 hud_pipe_query_install(pane
, hud
->pipe
, name
,
780 PIPE_QUERY_PIPELINE_STATISTICS
, i
,
788 if (!hud_driver_query_install(pane
, hud
->pipe
, name
)){
789 fprintf(stderr
, "gallium_hud: unknown driver query '%s'\n", name
);
798 fprintf(stderr
, "gallium_hud: syntax error: unexpected ':', "
799 "expected a name\n");
803 num
= parse_string(env
, s
);
806 if (num
&& sscanf(s
, "%u", &i
) == 1) {
807 hud_pane_set_max_value(pane
, i
);
810 fprintf(stderr
, "gallium_hud: syntax error: unexpected '%c' (%i) "
811 "after ':'\n", *env
, *env
);
818 /* parse a separator */
826 y
+= height
+ hud
->font
.glyph_height
* (pane
->num_graphs
+ 2);
828 if (pane
&& pane
->num_graphs
) {
829 LIST_ADDTAIL(&pane
->head
, &hud
->pane_list
);
837 x
+= width
+ hud
->font
.glyph_width
* 7;
839 if (pane
&& pane
->num_graphs
) {
840 LIST_ADDTAIL(&pane
->head
, &hud
->pane_list
);
846 fprintf(stderr
, "gallium_hud: syntax error: unexpected '%c'\n", *env
);
851 if (pane
->num_graphs
) {
852 LIST_ADDTAIL(&pane
->head
, &hud
->pane_list
);
861 print_help(struct pipe_screen
*screen
)
863 int i
, num_queries
, num_cpus
= hud_get_num_cpus();
865 puts("Syntax: GALLIUM_HUD=name1[+name2][...][:value1][,nameI...][;nameJ...]");
867 puts(" Names are identifiers of data sources which will be drawn as graphs");
868 puts(" in panes. Multiple graphs can be drawn in the same pane.");
869 puts(" There can be multiple panes placed in rows and columns.");
871 puts(" '+' separates names which will share a pane.");
872 puts(" ':[value]' specifies the initial maximum value of the Y axis");
873 puts(" for the given pane.");
874 puts(" ',' creates a new pane below the last one.");
875 puts(" ';' creates a new pane at the top of the next column.");
877 puts(" Example: GALLIUM_HUD=\"cpu,fps;primitives-generated\"");
879 puts(" Available names:");
883 for (i
= 0; i
< num_cpus
; i
++)
884 printf(" cpu%i\n", i
);
886 if (has_occlusion_query(screen
))
887 puts(" samples-passed");
888 if (has_streamout(screen
))
889 puts(" primitives-generated");
891 if (has_pipeline_stats_query(screen
)) {
892 puts(" ia-vertices");
893 puts(" ia-primitives");
894 puts(" vs-invocations");
895 puts(" gs-invocations");
896 puts(" gs-primitives");
897 puts(" clipper-invocations");
898 puts(" clipper-primitives-generated");
899 puts(" ps-invocations");
900 puts(" hs-invocations");
901 puts(" ds-invocations");
902 puts(" cs-invocations");
905 if (screen
->get_driver_query_info
){
906 struct pipe_driver_query_info info
;
907 num_queries
= screen
->get_driver_query_info(screen
, 0, NULL
);
909 for (i
= 0; i
< num_queries
; i
++){
910 screen
->get_driver_query_info(screen
, i
, &info
);
911 printf(" %s\n", info
.name
);
919 hud_create(struct pipe_context
*pipe
, struct cso_context
*cso
)
921 struct hud_context
*hud
;
922 struct pipe_sampler_view view_templ
;
924 const char *env
= debug_get_option("GALLIUM_HUD", NULL
);
929 if (strcmp(env
, "help") == 0) {
930 print_help(pipe
->screen
);
934 hud
= CALLOC_STRUCT(hud_context
);
940 hud
->uploader
= u_upload_create(pipe
, 256 * 1024, 16,
941 PIPE_BIND_VERTEX_BUFFER
);
944 if (!util_font_create(pipe
, UTIL_FONT_FIXED_8X13
, &hud
->font
)) {
945 u_upload_destroy(hud
->uploader
);
951 hud
->alpha_blend
.rt
[0].colormask
= PIPE_MASK_RGBA
;
952 hud
->alpha_blend
.rt
[0].blend_enable
= 1;
953 hud
->alpha_blend
.rt
[0].rgb_func
= PIPE_BLEND_ADD
;
954 hud
->alpha_blend
.rt
[0].rgb_src_factor
= PIPE_BLENDFACTOR_SRC_ALPHA
;
955 hud
->alpha_blend
.rt
[0].rgb_dst_factor
= PIPE_BLENDFACTOR_INV_SRC_ALPHA
;
956 hud
->alpha_blend
.rt
[0].alpha_func
= PIPE_BLEND_ADD
;
957 hud
->alpha_blend
.rt
[0].alpha_src_factor
= PIPE_BLENDFACTOR_ZERO
;
958 hud
->alpha_blend
.rt
[0].alpha_dst_factor
= PIPE_BLENDFACTOR_ONE
;
960 /* fragment shader */
962 util_make_fragment_passthrough_shader(pipe
,
964 TGSI_INTERPOLATE_CONSTANT
,
968 /* Read a texture and do .xxxx swizzling. */
969 static const char *fragment_shader_text
= {
971 "DCL IN[0], GENERIC[0], LINEAR\n"
973 "DCL OUT[0], COLOR[0]\n"
976 "TEX TEMP[0], IN[0], SAMP[0], RECT\n"
977 "MOV OUT[0], TEMP[0].xxxx\n"
981 struct tgsi_token tokens
[1000];
982 struct pipe_shader_state state
= {tokens
};
984 if (!tgsi_text_translate(fragment_shader_text
, tokens
, Elements(tokens
))) {
986 pipe_resource_reference(&hud
->font
.texture
, NULL
);
987 u_upload_destroy(hud
->uploader
);
992 hud
->fs_text
= pipe
->create_fs_state(pipe
, &state
);
996 hud
->rasterizer
.half_pixel_center
= 1;
997 hud
->rasterizer
.bottom_edge_rule
= 1;
998 hud
->rasterizer
.depth_clip
= 1;
999 hud
->rasterizer
.line_width
= 1;
1000 hud
->rasterizer
.line_last_pixel
= 1;
1004 static const char *vertex_shader_text
= {
1007 "DCL OUT[0], POSITION\n"
1008 "DCL OUT[1], COLOR[0]\n" /* color */
1009 "DCL OUT[2], GENERIC[0]\n" /* texcoord */
1011 * [1] = (2/fb_width, 2/fb_height, xoffset, yoffset)
1012 * [2] = (xscale, yscale, 0, 0) */
1015 "IMM[0] FLT32 { -1, 0, 0, 1 }\n"
1017 /* v = in * (xscale, yscale) + (xoffset, yoffset) */
1018 "MAD TEMP[0].xy, IN[0], CONST[2].xyyy, CONST[1].zwww\n"
1019 /* pos = v * (2 / fb_width, 2 / fb_height) - (1, 1) */
1020 "MAD OUT[0].xy, TEMP[0], CONST[1].xyyy, IMM[0].xxxx\n"
1021 "MOV OUT[0].zw, IMM[0]\n"
1023 "MOV OUT[1], CONST[0]\n"
1024 "MOV OUT[2], IN[1]\n"
1028 struct tgsi_token tokens
[1000];
1029 struct pipe_shader_state state
= {tokens
};
1031 if (!tgsi_text_translate(vertex_shader_text
, tokens
, Elements(tokens
))) {
1033 pipe_resource_reference(&hud
->font
.texture
, NULL
);
1034 u_upload_destroy(hud
->uploader
);
1039 hud
->vs
= pipe
->create_vs_state(pipe
, &state
);
1042 /* vertex elements */
1043 for (i
= 0; i
< 2; i
++) {
1044 hud
->velems
[i
].src_offset
= i
* 2 * sizeof(float);
1045 hud
->velems
[i
].src_format
= PIPE_FORMAT_R32G32_FLOAT
;
1046 hud
->velems
[i
].vertex_buffer_index
= cso_get_aux_vertex_buffer_slot(cso
);
1050 memset(&view_templ
, 0, sizeof(view_templ
));
1051 view_templ
.format
= hud
->font
.texture
->format
;
1052 view_templ
.swizzle_r
= PIPE_SWIZZLE_RED
;
1053 view_templ
.swizzle_g
= PIPE_SWIZZLE_GREEN
;
1054 view_templ
.swizzle_b
= PIPE_SWIZZLE_BLUE
;
1055 view_templ
.swizzle_a
= PIPE_SWIZZLE_ALPHA
;
1056 hud
->font_sampler_view
= pipe
->create_sampler_view(pipe
, hud
->font
.texture
,
1059 /* sampler state (for font drawing) */
1060 hud
->font_sampler_state
.wrap_s
= PIPE_TEX_WRAP_CLAMP_TO_EDGE
;
1061 hud
->font_sampler_state
.wrap_t
= PIPE_TEX_WRAP_CLAMP_TO_EDGE
;
1062 hud
->font_sampler_state
.wrap_r
= PIPE_TEX_WRAP_CLAMP_TO_EDGE
;
1063 hud
->font_sampler_state
.normalized_coords
= 0;
1066 hud
->constbuf
.buffer_size
= sizeof(hud
->constants
);
1067 hud
->constbuf
.user_buffer
= &hud
->constants
;
1069 LIST_INITHEAD(&hud
->pane_list
);
1071 hud_parse_env_var(hud
, env
);
1076 hud_destroy(struct hud_context
*hud
)
1078 struct pipe_context
*pipe
= hud
->pipe
;
1079 struct hud_pane
*pane
, *pane_tmp
;
1080 struct hud_graph
*graph
, *graph_tmp
;
1082 LIST_FOR_EACH_ENTRY_SAFE(pane
, pane_tmp
, &hud
->pane_list
, head
) {
1083 LIST_FOR_EACH_ENTRY_SAFE(graph
, graph_tmp
, &pane
->graph_list
, head
) {
1084 LIST_DEL(&graph
->head
);
1085 hud_graph_destroy(graph
);
1087 LIST_DEL(&pane
->head
);
1091 pipe
->delete_fs_state(pipe
, hud
->fs_color
);
1092 pipe
->delete_fs_state(pipe
, hud
->fs_text
);
1093 pipe
->delete_vs_state(pipe
, hud
->vs
);
1094 pipe_sampler_view_reference(&hud
->font_sampler_view
, NULL
);
1095 pipe_resource_reference(&hud
->font
.texture
, NULL
);
1096 u_upload_destroy(hud
->uploader
);