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_sampler.h"
48 #include "util/u_simple_shaders.h"
49 #include "util/u_string.h"
50 #include "util/u_upload_mgr.h"
51 #include "tgsi/tgsi_text.h"
52 #include "tgsi/tgsi_dump.h"
56 struct pipe_context
*pipe
;
57 struct cso_context
*cso
;
58 struct u_upload_mgr
*uploader
;
60 struct list_head pane_list
;
63 struct pipe_blend_state alpha_blend
;
64 struct pipe_depth_stencil_alpha_state dsa
;
65 void *fs_color
, *fs_text
;
66 struct pipe_rasterizer_state rasterizer
;
68 struct pipe_vertex_element velems
[2];
71 struct util_font font
;
72 struct pipe_sampler_view
*font_sampler_view
;
73 struct pipe_sampler_state font_sampler_state
;
75 /* VS constant buffer */
78 float two_div_fb_width
;
79 float two_div_fb_height
;
84 struct pipe_constant_buffer constbuf
;
86 unsigned fb_width
, fb_height
;
88 /* vertices for text and background drawing are accumulated here and then
89 * drawn all at once */
92 struct pipe_vertex_buffer vbuf
;
93 unsigned max_num_vertices
;
94 unsigned num_vertices
;
95 } text
, bg
, whitelines
;
100 hud_draw_colored_prims(struct hud_context
*hud
, unsigned prim
,
101 float *buffer
, unsigned num_vertices
,
102 float r
, float g
, float b
, float a
,
103 int xoffset
, int yoffset
, float yscale
)
105 struct cso_context
*cso
= hud
->cso
;
106 struct pipe_vertex_buffer vbuffer
= {0};
108 hud
->constants
.color
[0] = r
;
109 hud
->constants
.color
[1] = g
;
110 hud
->constants
.color
[2] = b
;
111 hud
->constants
.color
[3] = a
;
112 hud
->constants
.translate
[0] = (float) xoffset
;
113 hud
->constants
.translate
[1] = (float) yoffset
;
114 hud
->constants
.scale
[0] = 1;
115 hud
->constants
.scale
[1] = yscale
;
116 cso_set_constant_buffer(cso
, PIPE_SHADER_VERTEX
, 0, &hud
->constbuf
);
118 vbuffer
.user_buffer
= buffer
;
119 vbuffer
.stride
= 2 * sizeof(float);
121 cso_set_vertex_buffers(cso
, cso_get_aux_vertex_buffer_slot(cso
),
123 cso_set_fragment_shader_handle(hud
->cso
, hud
->fs_color
);
124 cso_draw_arrays(cso
, prim
, 0, num_vertices
);
128 hud_draw_colored_quad(struct hud_context
*hud
, unsigned prim
,
129 unsigned x1
, unsigned y1
, unsigned x2
, unsigned y2
,
130 float r
, float g
, float b
, float a
)
133 (float) x1
, (float) y1
,
134 (float) x1
, (float) y2
,
135 (float) x2
, (float) y2
,
136 (float) x2
, (float) y1
,
139 hud_draw_colored_prims(hud
, prim
, buffer
, 4, r
, g
, b
, a
, 0, 0, 1);
143 hud_draw_background_quad(struct hud_context
*hud
,
144 unsigned x1
, unsigned y1
, unsigned x2
, unsigned y2
)
146 float *vertices
= hud
->bg
.vertices
+ hud
->bg
.num_vertices
*2;
149 assert(hud
->bg
.num_vertices
+ 4 <= hud
->bg
.max_num_vertices
);
151 vertices
[num
++] = (float) x1
;
152 vertices
[num
++] = (float) y1
;
154 vertices
[num
++] = (float) x1
;
155 vertices
[num
++] = (float) y2
;
157 vertices
[num
++] = (float) x2
;
158 vertices
[num
++] = (float) y2
;
160 vertices
[num
++] = (float) x2
;
161 vertices
[num
++] = (float) y1
;
163 hud
->bg
.num_vertices
+= num
/2;
167 hud_draw_string(struct hud_context
*hud
, unsigned x
, unsigned y
,
168 const char *str
, ...)
172 float *vertices
= hud
->text
.vertices
+ hud
->text
.num_vertices
*4;
177 util_vsnprintf(buf
, sizeof(buf
), str
, ap
);
183 hud_draw_background_quad(hud
,
185 x
+ strlen(buf
)*hud
->font
.glyph_width
,
186 y
+ hud
->font
.glyph_height
);
191 unsigned x2
= x
+ hud
->font
.glyph_width
;
192 unsigned y2
= y
+ hud
->font
.glyph_height
;
193 unsigned tx1
= (*s
% 16) * hud
->font
.glyph_width
;
194 unsigned ty1
= (*s
/ 16) * hud
->font
.glyph_height
;
195 unsigned tx2
= tx1
+ hud
->font
.glyph_width
;
196 unsigned ty2
= ty1
+ hud
->font
.glyph_height
;
199 x
+= hud
->font
.glyph_width
;
204 assert(hud
->text
.num_vertices
+ num
/4 + 4 <= hud
->text
.max_num_vertices
);
206 vertices
[num
++] = (float) x1
;
207 vertices
[num
++] = (float) y1
;
208 vertices
[num
++] = (float) tx1
;
209 vertices
[num
++] = (float) ty1
;
211 vertices
[num
++] = (float) x1
;
212 vertices
[num
++] = (float) y2
;
213 vertices
[num
++] = (float) tx1
;
214 vertices
[num
++] = (float) ty2
;
216 vertices
[num
++] = (float) x2
;
217 vertices
[num
++] = (float) y2
;
218 vertices
[num
++] = (float) tx2
;
219 vertices
[num
++] = (float) ty2
;
221 vertices
[num
++] = (float) x2
;
222 vertices
[num
++] = (float) y1
;
223 vertices
[num
++] = (float) tx2
;
224 vertices
[num
++] = (float) ty1
;
226 x
+= hud
->font
.glyph_width
;
230 hud
->text
.num_vertices
+= num
/4;
234 number_to_human_readable(uint64_t num
, boolean is_in_bytes
, char *out
)
236 static const char *byte_units
[] =
237 {"", " KB", " MB", " GB", " TB", " PB", " EB"};
238 static const char *metric_units
[] =
239 {"", " k", " M", " G", " T", " P", " E"};
240 const char **units
= is_in_bytes
? byte_units
: metric_units
;
241 double divisor
= is_in_bytes
? 1024 : 1000;
245 while (d
> divisor
) {
250 if (d
>= 100 || d
== (int)d
)
251 sprintf(out
, "%.0f%s", d
, units
[unit
]);
252 else if (d
>= 10 || d
*10 == (int)(d
*10))
253 sprintf(out
, "%.1f%s", d
, units
[unit
]);
255 sprintf(out
, "%.2f%s", d
, units
[unit
]);
259 hud_draw_graph_line_strip(struct hud_context
*hud
, const struct hud_graph
*gr
,
260 unsigned xoffset
, unsigned yoffset
, float yscale
)
262 if (gr
->num_vertices
<= 1)
265 assert(gr
->index
<= gr
->num_vertices
);
267 hud_draw_colored_prims(hud
, PIPE_PRIM_LINE_STRIP
,
268 gr
->vertices
, gr
->index
,
269 gr
->color
[0], gr
->color
[1], gr
->color
[2], 1,
270 xoffset
+ (gr
->pane
->max_num_vertices
- gr
->index
- 1) * 2 - 1,
273 if (gr
->num_vertices
<= gr
->index
)
276 hud_draw_colored_prims(hud
, PIPE_PRIM_LINE_STRIP
,
277 gr
->vertices
+ gr
->index
*2,
278 gr
->num_vertices
- gr
->index
,
279 gr
->color
[0], gr
->color
[1], gr
->color
[2], 1,
280 xoffset
- gr
->index
*2 - 1, yoffset
, yscale
);
284 hud_pane_accumulate_vertices(struct hud_context
*hud
,
285 const struct hud_pane
*pane
)
287 struct hud_graph
*gr
;
288 float *line_verts
= hud
->whitelines
.vertices
+ hud
->whitelines
.num_vertices
*2;
292 /* draw background */
293 hud_draw_background_quad(hud
,
297 /* draw numbers on the right-hand side */
298 for (i
= 0; i
< 6; i
++) {
299 unsigned x
= pane
->x2
+ 2;
300 unsigned y
= pane
->inner_y1
+ pane
->inner_height
* (5 - i
) / 5 -
301 hud
->font
.glyph_height
/ 2;
303 number_to_human_readable(pane
->max_value
* i
/ 5,
304 pane
->uses_byte_units
, str
);
305 hud_draw_string(hud
, x
, y
, str
);
308 /* draw info below the pane */
310 LIST_FOR_EACH_ENTRY(gr
, &pane
->graph_list
, head
) {
311 unsigned x
= pane
->x1
+ 2;
312 unsigned y
= pane
->y2
+ 2 + i
*hud
->font
.glyph_height
;
314 number_to_human_readable(gr
->current_value
,
315 pane
->uses_byte_units
, str
);
316 hud_draw_string(hud
, x
, y
, " %s: %s", gr
->name
, str
);
321 assert(hud
->whitelines
.num_vertices
+ num
/2 + 8 <= hud
->whitelines
.max_num_vertices
);
322 line_verts
[num
++] = (float) pane
->x1
;
323 line_verts
[num
++] = (float) pane
->y1
;
324 line_verts
[num
++] = (float) pane
->x2
;
325 line_verts
[num
++] = (float) pane
->y1
;
327 line_verts
[num
++] = (float) pane
->x2
;
328 line_verts
[num
++] = (float) pane
->y1
;
329 line_verts
[num
++] = (float) pane
->x2
;
330 line_verts
[num
++] = (float) pane
->y2
;
332 line_verts
[num
++] = (float) pane
->x1
;
333 line_verts
[num
++] = (float) pane
->y2
;
334 line_verts
[num
++] = (float) pane
->x2
;
335 line_verts
[num
++] = (float) pane
->y2
;
337 line_verts
[num
++] = (float) pane
->x1
;
338 line_verts
[num
++] = (float) pane
->y1
;
339 line_verts
[num
++] = (float) pane
->x1
;
340 line_verts
[num
++] = (float) pane
->y2
;
342 /* draw horizontal lines inside the graph */
343 for (i
= 0; i
<= 5; i
++) {
344 float y
= round((pane
->max_value
* i
/ 5.0) * pane
->yscale
+ pane
->inner_y2
);
346 assert(hud
->whitelines
.num_vertices
+ num
/2 + 2 <= hud
->whitelines
.max_num_vertices
);
347 line_verts
[num
++] = pane
->x1
;
348 line_verts
[num
++] = y
;
349 line_verts
[num
++] = pane
->x2
;
350 line_verts
[num
++] = y
;
353 hud
->whitelines
.num_vertices
+= num
/2;
357 hud_pane_draw_colored_objects(struct hud_context
*hud
,
358 const struct hud_pane
*pane
)
360 struct hud_graph
*gr
;
363 /* draw colored quads below the pane */
365 LIST_FOR_EACH_ENTRY(gr
, &pane
->graph_list
, head
) {
366 unsigned x
= pane
->x1
+ 2;
367 unsigned y
= pane
->y2
+ 2 + i
*hud
->font
.glyph_height
;
369 hud_draw_colored_quad(hud
, PIPE_PRIM_QUADS
, x
+ 1, y
+ 1, x
+ 12, y
+ 13,
370 gr
->color
[0], gr
->color
[1], gr
->color
[2], 1);
374 /* draw the line strips */
375 LIST_FOR_EACH_ENTRY(gr
, &pane
->graph_list
, head
) {
376 hud_draw_graph_line_strip(hud
, gr
, pane
->inner_x1
, pane
->inner_y2
, pane
->yscale
);
381 hud_alloc_vertices(struct hud_context
*hud
, struct vertex_queue
*v
,
382 unsigned num_vertices
, unsigned stride
)
385 v
->max_num_vertices
= num_vertices
;
386 v
->vbuf
.stride
= stride
;
387 u_upload_alloc(hud
->uploader
, 0, v
->vbuf
.stride
* v
->max_num_vertices
,
388 &v
->vbuf
.buffer_offset
, &v
->vbuf
.buffer
,
389 (void**)&v
->vertices
);
393 * Draw the HUD to the texture \p tex.
394 * The texture is usually the back buffer being displayed.
397 hud_draw(struct hud_context
*hud
, struct pipe_resource
*tex
)
399 struct cso_context
*cso
= hud
->cso
;
400 struct pipe_context
*pipe
= hud
->pipe
;
401 struct pipe_framebuffer_state fb
;
402 struct pipe_surface surf_templ
, *surf
;
403 struct pipe_viewport_state viewport
;
404 const struct pipe_sampler_state
*sampler_states
[] =
405 { &hud
->font_sampler_state
};
406 struct hud_pane
*pane
;
407 struct hud_graph
*gr
;
409 hud
->fb_width
= tex
->width0
;
410 hud
->fb_height
= tex
->height0
;
411 hud
->constants
.two_div_fb_width
= 2.0f
/ hud
->fb_width
;
412 hud
->constants
.two_div_fb_height
= 2.0f
/ hud
->fb_height
;
414 cso_save_framebuffer(cso
);
415 cso_save_sample_mask(cso
);
416 cso_save_min_samples(cso
);
418 cso_save_depth_stencil_alpha(cso
);
419 cso_save_fragment_shader(cso
);
420 cso_save_sampler_views(cso
, PIPE_SHADER_FRAGMENT
);
421 cso_save_samplers(cso
, PIPE_SHADER_FRAGMENT
);
422 cso_save_rasterizer(cso
);
423 cso_save_viewport(cso
);
424 cso_save_stream_outputs(cso
);
425 cso_save_geometry_shader(cso
);
426 cso_save_vertex_shader(cso
);
427 cso_save_vertex_elements(cso
);
428 cso_save_aux_vertex_buffer_slot(cso
);
429 cso_save_constant_buffer_slot0(cso
, PIPE_SHADER_VERTEX
);
430 cso_save_render_condition(cso
);
433 memset(&surf_templ
, 0, sizeof(surf_templ
));
434 surf_templ
.format
= tex
->format
;
435 surf
= pipe
->create_surface(pipe
, tex
, &surf_templ
);
437 memset(&fb
, 0, sizeof(fb
));
441 fb
.width
= hud
->fb_width
;
442 fb
.height
= hud
->fb_height
;
444 viewport
.scale
[0] = 0.5f
* hud
->fb_width
;
445 viewport
.scale
[1] = 0.5f
* hud
->fb_height
;
446 viewport
.scale
[2] = 1.0f
;
447 viewport
.translate
[0] = 0.5f
* hud
->fb_width
;
448 viewport
.translate
[1] = 0.5f
* hud
->fb_height
;
449 viewport
.translate
[2] = 0.0f
;
451 cso_set_framebuffer(cso
, &fb
);
452 cso_set_sample_mask(cso
, ~0);
453 cso_set_min_samples(cso
, 1);
454 cso_set_blend(cso
, &hud
->alpha_blend
);
455 cso_set_depth_stencil_alpha(cso
, &hud
->dsa
);
456 cso_set_rasterizer(cso
, &hud
->rasterizer
);
457 cso_set_viewport(cso
, &viewport
);
458 cso_set_stream_outputs(cso
, 0, NULL
, NULL
);
459 cso_set_geometry_shader_handle(cso
, NULL
);
460 cso_set_vertex_shader_handle(cso
, hud
->vs
);
461 cso_set_vertex_elements(cso
, 2, hud
->velems
);
462 cso_set_render_condition(cso
, NULL
, FALSE
, 0);
463 cso_set_sampler_views(cso
, PIPE_SHADER_FRAGMENT
, 1,
464 &hud
->font_sampler_view
);
465 cso_set_samplers(cso
, PIPE_SHADER_FRAGMENT
, 1, sampler_states
);
466 cso_set_constant_buffer(cso
, PIPE_SHADER_VERTEX
, 0, &hud
->constbuf
);
468 /* prepare vertex buffers */
469 hud_alloc_vertices(hud
, &hud
->bg
, 4 * 128, 2 * sizeof(float));
470 hud_alloc_vertices(hud
, &hud
->whitelines
, 4 * 256, 2 * sizeof(float));
471 hud_alloc_vertices(hud
, &hud
->text
, 4 * 512, 4 * sizeof(float));
473 /* prepare all graphs */
474 LIST_FOR_EACH_ENTRY(pane
, &hud
->pane_list
, head
) {
475 LIST_FOR_EACH_ENTRY(gr
, &pane
->graph_list
, head
) {
476 gr
->query_new_value(gr
);
479 hud_pane_accumulate_vertices(hud
, pane
);
482 /* unmap the uploader's vertex buffer before drawing */
483 u_upload_unmap(hud
->uploader
);
485 /* draw accumulated vertices for background quads */
486 cso_set_fragment_shader_handle(hud
->cso
, hud
->fs_color
);
488 if (hud
->bg
.num_vertices
) {
489 hud
->constants
.color
[0] = 0;
490 hud
->constants
.color
[1] = 0;
491 hud
->constants
.color
[2] = 0;
492 hud
->constants
.color
[3] = 0.666f
;
493 hud
->constants
.translate
[0] = 0;
494 hud
->constants
.translate
[1] = 0;
495 hud
->constants
.scale
[0] = 1;
496 hud
->constants
.scale
[1] = 1;
498 cso_set_constant_buffer(cso
, PIPE_SHADER_VERTEX
, 0, &hud
->constbuf
);
499 cso_set_vertex_buffers(cso
, cso_get_aux_vertex_buffer_slot(cso
), 1,
501 cso_draw_arrays(cso
, PIPE_PRIM_QUADS
, 0, hud
->bg
.num_vertices
);
503 pipe_resource_reference(&hud
->bg
.vbuf
.buffer
, NULL
);
505 /* draw accumulated vertices for white lines */
506 hud
->constants
.color
[0] = 1;
507 hud
->constants
.color
[1] = 1;
508 hud
->constants
.color
[2] = 1;
509 hud
->constants
.color
[3] = 1;
510 hud
->constants
.translate
[0] = 0;
511 hud
->constants
.translate
[1] = 0;
512 hud
->constants
.scale
[0] = 1;
513 hud
->constants
.scale
[1] = 1;
514 cso_set_constant_buffer(cso
, PIPE_SHADER_VERTEX
, 0, &hud
->constbuf
);
516 if (hud
->whitelines
.num_vertices
) {
517 cso_set_vertex_buffers(cso
, cso_get_aux_vertex_buffer_slot(cso
), 1,
518 &hud
->whitelines
.vbuf
);
519 cso_set_fragment_shader_handle(hud
->cso
, hud
->fs_color
);
520 cso_draw_arrays(cso
, PIPE_PRIM_LINES
, 0, hud
->whitelines
.num_vertices
);
522 pipe_resource_reference(&hud
->whitelines
.vbuf
.buffer
, NULL
);
524 /* draw accumulated vertices for text */
525 if (hud
->text
.num_vertices
) {
526 cso_set_vertex_buffers(cso
, cso_get_aux_vertex_buffer_slot(cso
), 1,
528 cso_set_fragment_shader_handle(hud
->cso
, hud
->fs_text
);
529 cso_draw_arrays(cso
, PIPE_PRIM_QUADS
, 0, hud
->text
.num_vertices
);
531 pipe_resource_reference(&hud
->text
.vbuf
.buffer
, NULL
);
534 LIST_FOR_EACH_ENTRY(pane
, &hud
->pane_list
, head
) {
536 hud_pane_draw_colored_objects(hud
, pane
);
540 cso_restore_framebuffer(cso
);
541 cso_restore_sample_mask(cso
);
542 cso_restore_min_samples(cso
);
543 cso_restore_blend(cso
);
544 cso_restore_depth_stencil_alpha(cso
);
545 cso_restore_fragment_shader(cso
);
546 cso_restore_sampler_views(cso
, PIPE_SHADER_FRAGMENT
);
547 cso_restore_samplers(cso
, PIPE_SHADER_FRAGMENT
);
548 cso_restore_rasterizer(cso
);
549 cso_restore_viewport(cso
);
550 cso_restore_stream_outputs(cso
);
551 cso_restore_geometry_shader(cso
);
552 cso_restore_vertex_shader(cso
);
553 cso_restore_vertex_elements(cso
);
554 cso_restore_aux_vertex_buffer_slot(cso
);
555 cso_restore_constant_buffer_slot0(cso
, PIPE_SHADER_VERTEX
);
556 cso_restore_render_condition(cso
);
558 pipe_surface_reference(&surf
, NULL
);
562 * Set the maximum value for the Y axis of the graph.
563 * This scales the graph accordingly.
566 hud_pane_set_max_value(struct hud_pane
*pane
, uint64_t value
)
568 pane
->max_value
= value
;
569 pane
->yscale
= -(int)pane
->inner_height
/ (float)pane
->max_value
;
572 static struct hud_pane
*
573 hud_pane_create(unsigned x1
, unsigned y1
, unsigned x2
, unsigned y2
,
574 unsigned period
, uint64_t max_value
)
576 struct hud_pane
*pane
= CALLOC_STRUCT(hud_pane
);
585 pane
->inner_x1
= x1
+ 1;
586 pane
->inner_x2
= x2
- 1;
587 pane
->inner_y1
= y1
+ 1;
588 pane
->inner_y2
= y2
- 1;
589 pane
->inner_width
= pane
->inner_x2
- pane
->inner_x1
;
590 pane
->inner_height
= pane
->inner_y2
- pane
->inner_y1
;
591 pane
->period
= period
;
592 pane
->max_num_vertices
= (x2
- x1
+ 2) / 2;
593 hud_pane_set_max_value(pane
, max_value
);
594 LIST_INITHEAD(&pane
->graph_list
);
599 * Add a graph to an existing pane.
600 * One pane can contain multiple graphs over each other.
603 hud_pane_add_graph(struct hud_pane
*pane
, struct hud_graph
*gr
)
605 static const float colors
[][3] = {
614 char *name
= gr
->name
;
616 /* replace '-' with a space */
623 assert(pane
->num_graphs
< Elements(colors
));
624 gr
->vertices
= MALLOC(pane
->max_num_vertices
* sizeof(float) * 2);
625 gr
->color
[0] = colors
[pane
->num_graphs
][0];
626 gr
->color
[1] = colors
[pane
->num_graphs
][1];
627 gr
->color
[2] = colors
[pane
->num_graphs
][2];
629 LIST_ADDTAIL(&gr
->head
, &pane
->graph_list
);
634 hud_graph_add_value(struct hud_graph
*gr
, uint64_t value
)
636 if (gr
->index
== gr
->pane
->max_num_vertices
) {
638 gr
->vertices
[1] = gr
->vertices
[(gr
->index
-1)*2+1];
641 gr
->vertices
[(gr
->index
)*2+0] = (float) (gr
->index
* 2);
642 gr
->vertices
[(gr
->index
)*2+1] = (float) value
;
645 if (gr
->num_vertices
< gr
->pane
->max_num_vertices
) {
649 gr
->current_value
= value
;
650 if (value
> gr
->pane
->max_value
) {
651 hud_pane_set_max_value(gr
->pane
, value
);
656 hud_graph_destroy(struct hud_graph
*graph
)
658 FREE(graph
->vertices
);
659 if (graph
->free_query_data
)
660 graph
->free_query_data(graph
->query_data
);
665 * Read a string from the environment variable.
666 * The separators "+", ",", ":", and ";" terminate the string.
667 * Return the number of read characters.
670 parse_string(const char *s
, char *out
)
674 for (i
= 0; *s
&& *s
!= '+' && *s
!= ',' && *s
!= ':' && *s
!= ';';
681 fprintf(stderr
, "gallium_hud: syntax error: unexpected '%c' (%i) while "
682 "parsing a string\n", *s
, *s
);
687 has_occlusion_query(struct pipe_screen
*screen
)
689 return screen
->get_param(screen
, PIPE_CAP_OCCLUSION_QUERY
) != 0;
693 has_streamout(struct pipe_screen
*screen
)
695 return screen
->get_param(screen
, PIPE_CAP_MAX_STREAM_OUTPUT_BUFFERS
) != 0;
699 has_pipeline_stats_query(struct pipe_screen
*screen
)
701 return screen
->get_param(screen
, PIPE_CAP_QUERY_PIPELINE_STATISTICS
) != 0;
705 hud_parse_env_var(struct hud_context
*hud
, const char *env
)
708 char name
[256], s
[256];
709 struct hud_pane
*pane
= NULL
;
710 unsigned x
= 10, y
= 10;
711 unsigned width
= 251, height
= 100;
712 unsigned period
= 500 * 1000; /* default period (1/2 second) */
713 const char *period_env
;
716 * The GALLIUM_HUD_PERIOD env var sets the graph update rate.
717 * The env var is in seconds (a float).
718 * Zero means update after every frame.
720 period_env
= getenv("GALLIUM_HUD_PERIOD");
722 float p
= (float) atof(period_env
);
724 period
= (unsigned) (p
* 1000 * 1000);
728 while ((num
= parse_string(env
, name
)) != 0) {
732 pane
= hud_pane_create(x
, y
, x
+ width
, y
+ height
, period
, 10);
738 /* IF YOU CHANGE THIS, UPDATE print_help! */
739 if (strcmp(name
, "fps") == 0) {
740 hud_fps_graph_install(pane
);
742 else if (strcmp(name
, "cpu") == 0) {
743 hud_cpu_graph_install(pane
, ALL_CPUS
);
745 else if (sscanf(name
, "cpu%u%s", &i
, s
) == 1) {
746 hud_cpu_graph_install(pane
, i
);
748 else if (strcmp(name
, "samples-passed") == 0 &&
749 has_occlusion_query(hud
->pipe
->screen
)) {
750 hud_pipe_query_install(pane
, hud
->pipe
, "samples-passed",
751 PIPE_QUERY_OCCLUSION_COUNTER
, 0, 0, FALSE
);
753 else if (strcmp(name
, "primitives-generated") == 0 &&
754 has_streamout(hud
->pipe
->screen
)) {
755 hud_pipe_query_install(pane
, hud
->pipe
, "primitives-generated",
756 PIPE_QUERY_PRIMITIVES_GENERATED
, 0, 0, FALSE
);
759 boolean processed
= FALSE
;
761 /* pipeline statistics queries */
762 if (has_pipeline_stats_query(hud
->pipe
->screen
)) {
763 static const char *pipeline_statistics_names
[] =
770 "clipper-invocations",
771 "clipper-primitives-generated",
777 for (i
= 0; i
< Elements(pipeline_statistics_names
); ++i
)
778 if (strcmp(name
, pipeline_statistics_names
[i
]) == 0)
780 if (i
< Elements(pipeline_statistics_names
)) {
781 hud_pipe_query_install(pane
, hud
->pipe
, name
,
782 PIPE_QUERY_PIPELINE_STATISTICS
, i
,
790 if (!hud_driver_query_install(pane
, hud
->pipe
, name
)){
791 fprintf(stderr
, "gallium_hud: unknown driver query '%s'\n", name
);
800 fprintf(stderr
, "gallium_hud: syntax error: unexpected ':', "
801 "expected a name\n");
805 num
= parse_string(env
, s
);
808 if (num
&& sscanf(s
, "%u", &i
) == 1) {
809 hud_pane_set_max_value(pane
, i
);
812 fprintf(stderr
, "gallium_hud: syntax error: unexpected '%c' (%i) "
813 "after ':'\n", *env
, *env
);
820 /* parse a separator */
828 y
+= height
+ hud
->font
.glyph_height
* (pane
->num_graphs
+ 2);
830 if (pane
&& pane
->num_graphs
) {
831 LIST_ADDTAIL(&pane
->head
, &hud
->pane_list
);
839 x
+= width
+ hud
->font
.glyph_width
* 7;
841 if (pane
&& pane
->num_graphs
) {
842 LIST_ADDTAIL(&pane
->head
, &hud
->pane_list
);
848 fprintf(stderr
, "gallium_hud: syntax error: unexpected '%c'\n", *env
);
853 if (pane
->num_graphs
) {
854 LIST_ADDTAIL(&pane
->head
, &hud
->pane_list
);
863 print_help(struct pipe_screen
*screen
)
865 int i
, num_queries
, num_cpus
= hud_get_num_cpus();
867 puts("Syntax: GALLIUM_HUD=name1[+name2][...][:value1][,nameI...][;nameJ...]");
869 puts(" Names are identifiers of data sources which will be drawn as graphs");
870 puts(" in panes. Multiple graphs can be drawn in the same pane.");
871 puts(" There can be multiple panes placed in rows and columns.");
873 puts(" '+' separates names which will share a pane.");
874 puts(" ':[value]' specifies the initial maximum value of the Y axis");
875 puts(" for the given pane.");
876 puts(" ',' creates a new pane below the last one.");
877 puts(" ';' creates a new pane at the top of the next column.");
879 puts(" Example: GALLIUM_HUD=\"cpu,fps;primitives-generated\"");
881 puts(" Available names:");
885 for (i
= 0; i
< num_cpus
; i
++)
886 printf(" cpu%i\n", i
);
888 if (has_occlusion_query(screen
))
889 puts(" samples-passed");
890 if (has_streamout(screen
))
891 puts(" primitives-generated");
893 if (has_pipeline_stats_query(screen
)) {
894 puts(" ia-vertices");
895 puts(" ia-primitives");
896 puts(" vs-invocations");
897 puts(" gs-invocations");
898 puts(" gs-primitives");
899 puts(" clipper-invocations");
900 puts(" clipper-primitives-generated");
901 puts(" ps-invocations");
902 puts(" hs-invocations");
903 puts(" ds-invocations");
904 puts(" cs-invocations");
907 if (screen
->get_driver_query_info
){
908 struct pipe_driver_query_info info
;
909 num_queries
= screen
->get_driver_query_info(screen
, 0, NULL
);
911 for (i
= 0; i
< num_queries
; i
++){
912 screen
->get_driver_query_info(screen
, i
, &info
);
913 printf(" %s\n", info
.name
);
921 hud_create(struct pipe_context
*pipe
, struct cso_context
*cso
)
923 struct hud_context
*hud
;
924 struct pipe_sampler_view view_templ
;
926 const char *env
= debug_get_option("GALLIUM_HUD", NULL
);
931 if (strcmp(env
, "help") == 0) {
932 print_help(pipe
->screen
);
936 hud
= CALLOC_STRUCT(hud_context
);
942 hud
->uploader
= u_upload_create(pipe
, 256 * 1024, 16,
943 PIPE_BIND_VERTEX_BUFFER
);
946 if (!util_font_create(pipe
, UTIL_FONT_FIXED_8X13
, &hud
->font
)) {
947 u_upload_destroy(hud
->uploader
);
953 hud
->alpha_blend
.rt
[0].colormask
= PIPE_MASK_RGBA
;
954 hud
->alpha_blend
.rt
[0].blend_enable
= 1;
955 hud
->alpha_blend
.rt
[0].rgb_func
= PIPE_BLEND_ADD
;
956 hud
->alpha_blend
.rt
[0].rgb_src_factor
= PIPE_BLENDFACTOR_SRC_ALPHA
;
957 hud
->alpha_blend
.rt
[0].rgb_dst_factor
= PIPE_BLENDFACTOR_INV_SRC_ALPHA
;
958 hud
->alpha_blend
.rt
[0].alpha_func
= PIPE_BLEND_ADD
;
959 hud
->alpha_blend
.rt
[0].alpha_src_factor
= PIPE_BLENDFACTOR_ZERO
;
960 hud
->alpha_blend
.rt
[0].alpha_dst_factor
= PIPE_BLENDFACTOR_ONE
;
962 /* fragment shader */
964 util_make_fragment_passthrough_shader(pipe
,
966 TGSI_INTERPOLATE_CONSTANT
,
970 /* Read a texture and do .xxxx swizzling. */
971 static const char *fragment_shader_text
= {
973 "DCL IN[0], GENERIC[0], LINEAR\n"
975 "DCL OUT[0], COLOR[0]\n"
978 "TEX TEMP[0], IN[0], SAMP[0], RECT\n"
979 "MOV OUT[0], TEMP[0].xxxx\n"
983 struct tgsi_token tokens
[1000];
984 struct pipe_shader_state state
= {tokens
};
986 if (!tgsi_text_translate(fragment_shader_text
, tokens
, Elements(tokens
))) {
988 pipe_resource_reference(&hud
->font
.texture
, NULL
);
989 u_upload_destroy(hud
->uploader
);
994 hud
->fs_text
= pipe
->create_fs_state(pipe
, &state
);
998 hud
->rasterizer
.half_pixel_center
= 1;
999 hud
->rasterizer
.bottom_edge_rule
= 1;
1000 hud
->rasterizer
.depth_clip
= 1;
1001 hud
->rasterizer
.line_width
= 1;
1002 hud
->rasterizer
.line_last_pixel
= 1;
1006 static const char *vertex_shader_text
= {
1009 "DCL OUT[0], POSITION\n"
1010 "DCL OUT[1], COLOR[0]\n" /* color */
1011 "DCL OUT[2], GENERIC[0]\n" /* texcoord */
1013 * [1] = (2/fb_width, 2/fb_height, xoffset, yoffset)
1014 * [2] = (xscale, yscale, 0, 0) */
1017 "IMM[0] FLT32 { -1, 0, 0, 1 }\n"
1019 /* v = in * (xscale, yscale) + (xoffset, yoffset) */
1020 "MAD TEMP[0].xy, IN[0], CONST[2].xyyy, CONST[1].zwww\n"
1021 /* pos = v * (2 / fb_width, 2 / fb_height) - (1, 1) */
1022 "MAD OUT[0].xy, TEMP[0], CONST[1].xyyy, IMM[0].xxxx\n"
1023 "MOV OUT[0].zw, IMM[0]\n"
1025 "MOV OUT[1], CONST[0]\n"
1026 "MOV OUT[2], IN[1]\n"
1030 struct tgsi_token tokens
[1000];
1031 struct pipe_shader_state state
= {tokens
};
1033 if (!tgsi_text_translate(vertex_shader_text
, tokens
, Elements(tokens
))) {
1035 pipe_resource_reference(&hud
->font
.texture
, NULL
);
1036 u_upload_destroy(hud
->uploader
);
1041 hud
->vs
= pipe
->create_vs_state(pipe
, &state
);
1044 /* vertex elements */
1045 for (i
= 0; i
< 2; i
++) {
1046 hud
->velems
[i
].src_offset
= i
* 2 * sizeof(float);
1047 hud
->velems
[i
].src_format
= PIPE_FORMAT_R32G32_FLOAT
;
1048 hud
->velems
[i
].vertex_buffer_index
= cso_get_aux_vertex_buffer_slot(cso
);
1052 u_sampler_view_default_template(
1053 &view_templ
, hud
->font
.texture
, hud
->font
.texture
->format
);
1054 hud
->font_sampler_view
= pipe
->create_sampler_view(pipe
, hud
->font
.texture
,
1057 /* sampler state (for font drawing) */
1058 hud
->font_sampler_state
.wrap_s
= PIPE_TEX_WRAP_CLAMP_TO_EDGE
;
1059 hud
->font_sampler_state
.wrap_t
= PIPE_TEX_WRAP_CLAMP_TO_EDGE
;
1060 hud
->font_sampler_state
.wrap_r
= PIPE_TEX_WRAP_CLAMP_TO_EDGE
;
1061 hud
->font_sampler_state
.normalized_coords
= 0;
1064 hud
->constbuf
.buffer_size
= sizeof(hud
->constants
);
1065 hud
->constbuf
.user_buffer
= &hud
->constants
;
1067 LIST_INITHEAD(&hud
->pane_list
);
1069 hud_parse_env_var(hud
, env
);
1074 hud_destroy(struct hud_context
*hud
)
1076 struct pipe_context
*pipe
= hud
->pipe
;
1077 struct hud_pane
*pane
, *pane_tmp
;
1078 struct hud_graph
*graph
, *graph_tmp
;
1080 LIST_FOR_EACH_ENTRY_SAFE(pane
, pane_tmp
, &hud
->pane_list
, head
) {
1081 LIST_FOR_EACH_ENTRY_SAFE(graph
, graph_tmp
, &pane
->graph_list
, head
) {
1082 LIST_DEL(&graph
->head
);
1083 hud_graph_destroy(graph
);
1085 LIST_DEL(&pane
->head
);
1089 pipe
->delete_fs_state(pipe
, hud
->fs_color
);
1090 pipe
->delete_fs_state(pipe
, hud
->fs_text
);
1091 pipe
->delete_vs_state(pipe
, hud
->vs
);
1092 pipe_sampler_view_reference(&hud
->font_sampler_view
, NULL
);
1093 pipe_resource_reference(&hud
->font
.texture
, NULL
);
1094 u_upload_destroy(hud
->uploader
);