util: add a resource wrapper to get resource samples
[mesa.git] / src / gallium / auxiliary / util / u_blitter.h
1 /**************************************************************************
2 *
3 * Copyright 2009 Marek Olšák <maraeo@gmail.com>
4 *
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the
7 * "Software"), to deal in the Software without restriction, including
8 * without limitation the rights to use, copy, modify, merge, publish,
9 * distribute, sub license, and/or sell copies of the Software, and to
10 * permit persons to whom the Software is furnished to do so, subject to
11 * the following conditions:
12 *
13 * The above copyright notice and this permission notice (including the
14 * next paragraph) shall be included in all copies or substantial portions
15 * of the Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
20 * IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS BE LIABLE FOR
21 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
22 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
23 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
24 *
25 **************************************************************************/
26
27 #ifndef U_BLITTER_H
28 #define U_BLITTER_H
29
30 #include "util/u_framebuffer.h"
31 #include "util/u_inlines.h"
32
33 #include "pipe/p_state.h"
34
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38
39 struct pipe_context;
40
41 enum blitter_attrib_type {
42 UTIL_BLITTER_ATTRIB_NONE,
43 UTIL_BLITTER_ATTRIB_COLOR,
44 UTIL_BLITTER_ATTRIB_TEXCOORD_XY,
45 UTIL_BLITTER_ATTRIB_TEXCOORD_XYZW,
46 };
47
48 union blitter_attrib {
49 float color[4];
50
51 struct {
52 float x1, y1, x2, y2, z, w;
53 } texcoord;
54 };
55
56 struct blitter_context;
57
58 typedef void *(*blitter_get_vs_func)(struct blitter_context *blitter);
59
60 struct blitter_context
61 {
62 /**
63 * Draw a rectangle.
64 *
65 * \param get_vs Callback for obtaining the vertex shader for the draw call.
66 * It might invoke the shader compiler. The driver is
67 * responsible for setting the vertex shader, and the callback
68 * allows the driver to query the vertex shader CSO if it
69 * wants to use the default one.
70 * \param x1 An X coordinate of the top-left corner.
71 * \param y1 A Y coordinate of the top-left corner.
72 * \param x2 An X coordinate of the bottom-right corner.
73 * \param y2 A Y coordinate of the bottom-right corner.
74 * \param depth A depth which the rectangle is rendered at.
75 *
76 * \param type Semantics of the attributes "attrib".
77 * If type is UTIL_BLITTER_ATTRIB_NONE, ignore them.
78 * If type is UTIL_BLITTER_ATTRIB_COLOR, the attributes
79 * make up a constant RGBA color, and should go
80 * to the GENERIC0 varying slot of a fragment shader.
81 * If type is UTIL_BLITTER_ATTRIB_TEXCOORD, {a1, a2} and
82 * {a3, a4} specify top-left and bottom-right texture
83 * coordinates of the rectangle, respectively, and should go
84 * to the GENERIC0 varying slot of a fragment shader.
85 *
86 * \param attrib See type.
87 *
88 * \note A driver may optionally override this callback to implement
89 * a specialized hardware path for drawing a rectangle, e.g. using
90 * a rectangular point sprite.
91 */
92 void (*draw_rectangle)(struct blitter_context *blitter,
93 void *vertex_elements_cso,
94 blitter_get_vs_func get_vs,
95 int x1, int y1, int x2, int y2,
96 float depth, unsigned num_instances,
97 enum blitter_attrib_type type,
98 const union blitter_attrib *attrib);
99
100 /* Whether the blitter is running. */
101 bool running;
102
103 bool use_index_buffer;
104
105 /* Private members, really. */
106 struct pipe_context *pipe; /**< pipe context */
107
108 void *saved_blend_state; /**< blend state */
109 void *saved_dsa_state; /**< depth stencil alpha state */
110 void *saved_velem_state; /**< vertex elements state */
111 void *saved_rs_state; /**< rasterizer state */
112 void *saved_fs, *saved_vs, *saved_gs, *saved_tcs, *saved_tes; /**< shaders */
113
114 struct pipe_framebuffer_state saved_fb_state; /**< framebuffer state */
115 struct pipe_stencil_ref saved_stencil_ref; /**< stencil ref */
116 struct pipe_viewport_state saved_viewport;
117 struct pipe_scissor_state saved_scissor;
118 bool skip_viewport_restore;
119 bool is_sample_mask_saved;
120 unsigned saved_sample_mask;
121
122 unsigned saved_num_sampler_states;
123 void *saved_sampler_states[PIPE_MAX_SAMPLERS];
124
125 unsigned saved_num_sampler_views;
126 struct pipe_sampler_view *saved_sampler_views[PIPE_MAX_SAMPLERS];
127
128 unsigned cb_slot;
129 struct pipe_constant_buffer saved_fs_constant_buffer;
130
131 unsigned vb_slot;
132 struct pipe_vertex_buffer saved_vertex_buffer;
133
134 unsigned saved_num_so_targets;
135 struct pipe_stream_output_target *saved_so_targets[PIPE_MAX_SO_BUFFERS];
136
137 struct pipe_query *saved_render_cond_query;
138 uint saved_render_cond_mode;
139 bool saved_render_cond_cond;
140
141 boolean saved_window_rectangles_include;
142 unsigned saved_num_window_rectangles;
143 struct pipe_scissor_state saved_window_rectangles[PIPE_MAX_WINDOW_RECTANGLES];
144 };
145
146 /**
147 * Create a blitter context.
148 */
149 struct blitter_context *util_blitter_create(struct pipe_context *pipe);
150
151 /**
152 * Destroy a blitter context.
153 */
154 void util_blitter_destroy(struct blitter_context *blitter);
155
156 void util_blitter_cache_all_shaders(struct blitter_context *blitter);
157 void *util_blitter_get_noop_blend_state(struct blitter_context *blitter);
158 void *util_blitter_get_noop_dsa_state(struct blitter_context *blitter);
159 void *util_blitter_get_discard_rasterizer_state(struct blitter_context *blitter);
160
161
162 /**
163 * Return the pipe context associated with a blitter context.
164 */
165 static inline
166 struct pipe_context *util_blitter_get_pipe(struct blitter_context *blitter)
167 {
168 return blitter->pipe;
169 }
170
171 /**
172 * Override PIPE_CAP_TEXTURE_MULTISAMPLE as reported by the driver.
173 */
174 void util_blitter_set_texture_multisample(struct blitter_context *blitter,
175 bool supported);
176
177 /* The default function to draw a rectangle. This can only be used
178 * inside of the draw_rectangle callback if the driver overrides it. */
179 void util_blitter_draw_rectangle(struct blitter_context *blitter,
180 void *vertex_elements_cso,
181 blitter_get_vs_func get_vs,
182 int x1, int y1, int x2, int y2,
183 float depth, unsigned num_instances,
184 enum blitter_attrib_type type,
185 const union blitter_attrib *attrib);
186
187
188 /*
189 * These states must be saved before any of the following functions are called:
190 * - vertex buffers
191 * - vertex elements
192 * - vertex shader
193 * - geometry shader (if supported)
194 * - stream output targets (if supported)
195 * - rasterizer state
196 */
197
198 /**
199 * Clear a specified set of currently bound buffers to specified values.
200 *
201 * These states must be saved in the blitter in addition to the state objects
202 * already required to be saved:
203 * - fragment shader
204 * - depth stencil alpha state
205 * - blend state
206 */
207 void util_blitter_clear(struct blitter_context *blitter,
208 unsigned width, unsigned height, unsigned num_layers,
209 unsigned clear_buffers,
210 const union pipe_color_union *color,
211 double depth, unsigned stencil,
212 bool msaa);
213
214 /**
215 * Check if the blitter (with the help of the driver) can blit between
216 * the two resources.
217 */
218 bool util_blitter_is_copy_supported(struct blitter_context *blitter,
219 const struct pipe_resource *dst,
220 const struct pipe_resource *src);
221
222 bool util_blitter_is_blit_supported(struct blitter_context *blitter,
223 const struct pipe_blit_info *info);
224
225 /**
226 * Copy a block of pixels from one surface to another.
227 *
228 * These states must be saved in the blitter in addition to the state objects
229 * already required to be saved:
230 * - fragment shader
231 * - depth stencil alpha state
232 * - blend state
233 * - fragment sampler states
234 * - fragment sampler textures
235 * - framebuffer state
236 * - sample mask
237 */
238 void util_blitter_copy_texture(struct blitter_context *blitter,
239 struct pipe_resource *dst,
240 unsigned dst_level,
241 unsigned dstx, unsigned dsty, unsigned dstz,
242 struct pipe_resource *src,
243 unsigned src_level,
244 const struct pipe_box *srcbox);
245
246 /**
247 * This is a generic implementation of pipe->blit, which accepts
248 * sampler/surface views instead of resources.
249 *
250 * The layer and mipmap level are specified by the views.
251 *
252 * Drivers can use this to change resource properties (like format, width,
253 * height) by changing how the views interpret them, instead of changing
254 * pipe_resource directly. This is used to blit resources of formats which
255 * are not renderable.
256 *
257 * src_width0 and src_height0 are sampler_view-private properties that
258 * override pipe_resource. The blitter uses them for computation of texture
259 * coordinates. The dst dimensions are supplied through pipe_surface::width
260 * and height.
261 *
262 * The mask is a combination of the PIPE_MASK_* flags.
263 * Set to PIPE_MASK_RGBAZS if unsure.
264 */
265 void util_blitter_blit_generic(struct blitter_context *blitter,
266 struct pipe_surface *dst,
267 const struct pipe_box *dstbox,
268 struct pipe_sampler_view *src,
269 const struct pipe_box *srcbox,
270 unsigned src_width0, unsigned src_height0,
271 unsigned mask, unsigned filter,
272 const struct pipe_scissor_state *scissor,
273 bool alpha_blend);
274
275 void util_blitter_blit(struct blitter_context *blitter,
276 const struct pipe_blit_info *info);
277
278 void util_blitter_generate_mipmap(struct blitter_context *blitter,
279 struct pipe_resource *tex,
280 enum pipe_format format,
281 unsigned base_level, unsigned last_level,
282 unsigned first_layer, unsigned last_layer);
283
284 /**
285 * Helper function to initialize a view for copy_texture_view.
286 * The parameters must match copy_texture_view.
287 */
288 void util_blitter_default_dst_texture(struct pipe_surface *dst_templ,
289 struct pipe_resource *dst,
290 unsigned dstlevel,
291 unsigned dstz);
292
293 /**
294 * Helper function to initialize a view for copy_texture_view.
295 * The parameters must match copy_texture_view.
296 */
297 void util_blitter_default_src_texture(struct blitter_context *blitter,
298 struct pipe_sampler_view *src_templ,
299 struct pipe_resource *src,
300 unsigned srclevel);
301
302 /**
303 * Copy data from one buffer to another using the Stream Output functionality.
304 * 4-byte alignment is required, otherwise software fallback is used.
305 */
306 void util_blitter_copy_buffer(struct blitter_context *blitter,
307 struct pipe_resource *dst,
308 unsigned dstx,
309 struct pipe_resource *src,
310 unsigned srcx,
311 unsigned size);
312
313 /**
314 * Clear the contents of a buffer using the Stream Output functionality.
315 * 4-byte alignment is required.
316 *
317 * "num_channels" can be 1, 2, 3, or 4, and specifies if the clear value is
318 * R, RG, RGB, or RGBA.
319 *
320 * For each element, only "num_channels" components of "clear_value" are
321 * copied to the buffer, then the offset is incremented by num_channels*4.
322 */
323 void util_blitter_clear_buffer(struct blitter_context *blitter,
324 struct pipe_resource *dst,
325 unsigned offset, unsigned size,
326 unsigned num_channels,
327 const union pipe_color_union *clear_value);
328
329 /**
330 * Clear a region of a (color) surface to a constant value.
331 *
332 * These states must be saved in the blitter in addition to the state objects
333 * already required to be saved:
334 * - fragment shader
335 * - depth stencil alpha state
336 * - blend state
337 * - framebuffer state
338 */
339 void util_blitter_clear_render_target(struct blitter_context *blitter,
340 struct pipe_surface *dst,
341 const union pipe_color_union *color,
342 unsigned dstx, unsigned dsty,
343 unsigned width, unsigned height);
344
345 /**
346 * Clear a region of a depth-stencil surface, both stencil and depth
347 * or only one of them if this is a combined depth-stencil surface.
348 *
349 * These states must be saved in the blitter in addition to the state objects
350 * already required to be saved:
351 * - fragment shader
352 * - depth stencil alpha state
353 * - blend state
354 * - framebuffer state
355 */
356 void util_blitter_clear_depth_stencil(struct blitter_context *blitter,
357 struct pipe_surface *dst,
358 unsigned clear_flags,
359 double depth,
360 unsigned stencil,
361 unsigned dstx, unsigned dsty,
362 unsigned width, unsigned height);
363
364 /* The following functions are customized variants of the clear functions.
365 * Some drivers use them internally to do things like MSAA resolve
366 * and resource decompression. It usually consists of rendering a full-screen
367 * quad with a special blend or DSA state.
368 */
369
370 /* Used by r300g for depth decompression. */
371 void util_blitter_custom_clear_depth(struct blitter_context *blitter,
372 unsigned width, unsigned height,
373 double depth, void *custom_dsa);
374
375 /* Used by r600g for depth decompression. */
376 void util_blitter_custom_depth_stencil(struct blitter_context *blitter,
377 struct pipe_surface *zsurf,
378 struct pipe_surface *cbsurf,
379 unsigned sample_mask,
380 void *dsa_stage, float depth);
381
382 /* Used by r600g for color decompression. */
383 void util_blitter_custom_color(struct blitter_context *blitter,
384 struct pipe_surface *dstsurf,
385 void *custom_blend);
386
387 /* Used by r600g for MSAA color resolve. */
388 void util_blitter_custom_resolve_color(struct blitter_context *blitter,
389 struct pipe_resource *dst,
390 unsigned dst_level,
391 unsigned dst_layer,
392 struct pipe_resource *src,
393 unsigned src_layer,
394 unsigned sampled_mask,
395 void *custom_blend,
396 enum pipe_format format);
397
398 /* Used by vc4 for 8/16-bit linear-to-tiled blits */
399 void util_blitter_custom_shader(struct blitter_context *blitter,
400 struct pipe_surface *dstsurf,
401 void *custom_vs, void *custom_fs);
402
403 /* The functions below should be used to save currently bound constant state
404 * objects inside a driver. The objects are automatically restored at the end
405 * of the util_blitter_{clear, copy_region, fill_region} functions and then
406 * forgotten.
407 *
408 * States not listed here are not affected by util_blitter. */
409
410 static inline void
411 util_blitter_save_blend(struct blitter_context *blitter, void *state)
412 {
413 blitter->saved_blend_state = state;
414 }
415
416 static inline void
417 util_blitter_save_depth_stencil_alpha(struct blitter_context *blitter,
418 void *state)
419 {
420 blitter->saved_dsa_state = state;
421 }
422
423 static inline void
424 util_blitter_save_vertex_elements(struct blitter_context *blitter, void *state)
425 {
426 blitter->saved_velem_state = state;
427 }
428
429 static inline void
430 util_blitter_save_stencil_ref(struct blitter_context *blitter,
431 const struct pipe_stencil_ref *state)
432 {
433 blitter->saved_stencil_ref = *state;
434 }
435
436 static inline void
437 util_blitter_save_rasterizer(struct blitter_context *blitter, void *state)
438 {
439 blitter->saved_rs_state = state;
440 }
441
442 static inline void
443 util_blitter_save_fragment_shader(struct blitter_context *blitter, void *fs)
444 {
445 blitter->saved_fs = fs;
446 }
447
448 static inline void
449 util_blitter_save_vertex_shader(struct blitter_context *blitter, void *vs)
450 {
451 blitter->saved_vs = vs;
452 }
453
454 static inline void
455 util_blitter_save_geometry_shader(struct blitter_context *blitter, void *gs)
456 {
457 blitter->saved_gs = gs;
458 }
459
460 static inline void
461 util_blitter_save_tessctrl_shader(struct blitter_context *blitter,
462 void *sh)
463 {
464 blitter->saved_tcs = sh;
465 }
466
467 static inline void
468 util_blitter_save_tesseval_shader(struct blitter_context *blitter,
469 void *sh)
470 {
471 blitter->saved_tes = sh;
472 }
473
474 static inline void
475 util_blitter_save_framebuffer(struct blitter_context *blitter,
476 const struct pipe_framebuffer_state *state)
477 {
478 blitter->saved_fb_state.nr_cbufs = 0; /* It's ~0 now, meaning it's unsaved. */
479 util_copy_framebuffer_state(&blitter->saved_fb_state, state);
480 }
481
482 static inline void
483 util_blitter_save_viewport(struct blitter_context *blitter,
484 struct pipe_viewport_state *state)
485 {
486 blitter->saved_viewport = *state;
487 }
488
489 static inline void
490 util_blitter_save_scissor(struct blitter_context *blitter,
491 struct pipe_scissor_state *state)
492 {
493 blitter->saved_scissor = *state;
494 }
495
496 static inline void
497 util_blitter_save_fragment_sampler_states(
498 struct blitter_context *blitter,
499 unsigned num_sampler_states,
500 void **sampler_states)
501 {
502 assert(num_sampler_states <= ARRAY_SIZE(blitter->saved_sampler_states));
503
504 blitter->saved_num_sampler_states = num_sampler_states;
505 memcpy(blitter->saved_sampler_states, sampler_states,
506 num_sampler_states * sizeof(void *));
507 }
508
509 static inline void
510 util_blitter_save_fragment_sampler_views(struct blitter_context *blitter,
511 unsigned num_views,
512 struct pipe_sampler_view **views)
513 {
514 unsigned i;
515 assert(num_views <= ARRAY_SIZE(blitter->saved_sampler_views));
516
517 blitter->saved_num_sampler_views = num_views;
518 for (i = 0; i < num_views; i++)
519 pipe_sampler_view_reference(&blitter->saved_sampler_views[i],
520 views[i]);
521 }
522
523 static inline void
524 util_blitter_save_fragment_constant_buffer_slot(
525 struct blitter_context *blitter,
526 struct pipe_constant_buffer *constant_buffers)
527 {
528 pipe_resource_reference(&blitter->saved_fs_constant_buffer.buffer,
529 constant_buffers[blitter->cb_slot].buffer);
530 memcpy(&blitter->saved_fs_constant_buffer, &constant_buffers[blitter->cb_slot],
531 sizeof(struct pipe_constant_buffer));
532 }
533
534 static inline void
535 util_blitter_save_vertex_buffer_slot(struct blitter_context *blitter,
536 struct pipe_vertex_buffer *vertex_buffers)
537 {
538 pipe_vertex_buffer_reference(&blitter->saved_vertex_buffer,
539 &vertex_buffers[blitter->vb_slot]);
540 }
541
542 static inline void
543 util_blitter_save_so_targets(struct blitter_context *blitter,
544 unsigned num_targets,
545 struct pipe_stream_output_target **targets)
546 {
547 unsigned i;
548 assert(num_targets <= ARRAY_SIZE(blitter->saved_so_targets));
549
550 blitter->saved_num_so_targets = num_targets;
551 for (i = 0; i < num_targets; i++)
552 pipe_so_target_reference(&blitter->saved_so_targets[i],
553 targets[i]);
554 }
555
556 static inline void
557 util_blitter_save_sample_mask(struct blitter_context *blitter,
558 unsigned sample_mask)
559 {
560 blitter->is_sample_mask_saved = true;
561 blitter->saved_sample_mask = sample_mask;
562 }
563
564 static inline void
565 util_blitter_save_render_condition(struct blitter_context *blitter,
566 struct pipe_query *query,
567 bool condition,
568 enum pipe_render_cond_flag mode)
569 {
570 blitter->saved_render_cond_query = query;
571 blitter->saved_render_cond_mode = mode;
572 blitter->saved_render_cond_cond = condition;
573 }
574
575 static inline void
576 util_blitter_save_window_rectangles(struct blitter_context *blitter,
577 boolean include,
578 unsigned num_rectangles,
579 const struct pipe_scissor_state *rects)
580 {
581 blitter->saved_window_rectangles_include = include;
582 blitter->saved_num_window_rectangles = num_rectangles;
583 if (num_rectangles > 0) {
584 assert(num_rectangles < ARRAY_SIZE(blitter->saved_window_rectangles));
585 memcpy(blitter->saved_window_rectangles, rects,
586 sizeof(*rects) * num_rectangles);
587 }
588 }
589
590 void util_blitter_common_clear_setup(struct blitter_context *blitter,
591 unsigned width, unsigned height,
592 unsigned clear_buffers,
593 void *custom_blend, void *custom_dsa);
594
595 void util_blitter_set_running_flag(struct blitter_context *blitter);
596 void util_blitter_unset_running_flag(struct blitter_context *blitter);
597
598 void util_blitter_restore_vertex_states(struct blitter_context *blitter);
599 void util_blitter_restore_fragment_states(struct blitter_context *blitter);
600 void util_blitter_restore_render_cond(struct blitter_context *blitter);
601 void util_blitter_restore_fb_state(struct blitter_context *blitter);
602 void util_blitter_restore_textures(struct blitter_context *blitter);
603 void util_blitter_restore_constant_buffer_state(struct blitter_context *blitter);
604
605 /* These are supported combinations of blits from ZS to color and vice versa.
606 * The blitter will do the packing/unpacking of depth and stencil
607 * in the fragment shader.
608 */
609 static inline enum pipe_format
610 util_blitter_get_color_format_for_zs(enum pipe_format format)
611 {
612 switch (format) {
613 case PIPE_FORMAT_Z16_UNORM:
614 return PIPE_FORMAT_R16_UNORM;
615
616 case PIPE_FORMAT_Z32_FLOAT:
617 return PIPE_FORMAT_R32_FLOAT;
618
619 case PIPE_FORMAT_Z24_UNORM_S8_UINT:
620 case PIPE_FORMAT_Z24X8_UNORM:
621 case PIPE_FORMAT_S8_UINT_Z24_UNORM:
622 case PIPE_FORMAT_X8Z24_UNORM:
623 return PIPE_FORMAT_R32_UINT;
624
625 case PIPE_FORMAT_Z32_FLOAT_S8X24_UINT:
626 return PIPE_FORMAT_R32G32_UINT;
627
628 case PIPE_FORMAT_Z32_UNORM:
629 default:
630 assert(0);
631 }
632 return PIPE_FORMAT_NONE;
633 }
634
635 #ifdef __cplusplus
636 }
637 #endif
638
639 #endif