6d25ba57671daaed373d0483a1cbf7c6d0333c42
[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
160
161 /**
162 * Return the pipe context associated with a blitter context.
163 */
164 static inline
165 struct pipe_context *util_blitter_get_pipe(struct blitter_context *blitter)
166 {
167 return blitter->pipe;
168 }
169
170 /**
171 * Override PIPE_CAP_TEXTURE_MULTISAMPLE as reported by the driver.
172 */
173 void util_blitter_set_texture_multisample(struct blitter_context *blitter,
174 bool supported);
175
176 /* The default function to draw a rectangle. This can only be used
177 * inside of the draw_rectangle callback if the driver overrides it. */
178 void util_blitter_draw_rectangle(struct blitter_context *blitter,
179 void *vertex_elements_cso,
180 blitter_get_vs_func get_vs,
181 int x1, int y1, int x2, int y2,
182 float depth, unsigned num_instances,
183 enum blitter_attrib_type type,
184 const union blitter_attrib *attrib);
185
186
187 /*
188 * These states must be saved before any of the following functions are called:
189 * - vertex buffers
190 * - vertex elements
191 * - vertex shader
192 * - geometry shader (if supported)
193 * - stream output targets (if supported)
194 * - rasterizer state
195 */
196
197 /**
198 * Clear a specified set of currently bound buffers to specified values.
199 *
200 * These states must be saved in the blitter in addition to the state objects
201 * already required to be saved:
202 * - fragment shader
203 * - depth stencil alpha state
204 * - blend state
205 */
206 void util_blitter_clear(struct blitter_context *blitter,
207 unsigned width, unsigned height, unsigned num_layers,
208 unsigned clear_buffers,
209 const union pipe_color_union *color,
210 double depth, unsigned stencil,
211 bool msaa);
212
213 /**
214 * Check if the blitter (with the help of the driver) can blit between
215 * the two resources.
216 */
217 bool util_blitter_is_copy_supported(struct blitter_context *blitter,
218 const struct pipe_resource *dst,
219 const struct pipe_resource *src);
220
221 bool util_blitter_is_blit_supported(struct blitter_context *blitter,
222 const struct pipe_blit_info *info);
223
224 /**
225 * Copy a block of pixels from one surface to another.
226 *
227 * These states must be saved in the blitter in addition to the state objects
228 * already required to be saved:
229 * - fragment shader
230 * - depth stencil alpha state
231 * - blend state
232 * - fragment sampler states
233 * - fragment sampler textures
234 * - framebuffer state
235 * - sample mask
236 */
237 void util_blitter_copy_texture(struct blitter_context *blitter,
238 struct pipe_resource *dst,
239 unsigned dst_level,
240 unsigned dstx, unsigned dsty, unsigned dstz,
241 struct pipe_resource *src,
242 unsigned src_level,
243 const struct pipe_box *srcbox);
244
245 /**
246 * This is a generic implementation of pipe->blit, which accepts
247 * sampler/surface views instead of resources.
248 *
249 * The layer and mipmap level are specified by the views.
250 *
251 * Drivers can use this to change resource properties (like format, width,
252 * height) by changing how the views interpret them, instead of changing
253 * pipe_resource directly. This is used to blit resources of formats which
254 * are not renderable.
255 *
256 * src_width0 and src_height0 are sampler_view-private properties that
257 * override pipe_resource. The blitter uses them for computation of texture
258 * coordinates. The dst dimensions are supplied through pipe_surface::width
259 * and height.
260 *
261 * The mask is a combination of the PIPE_MASK_* flags.
262 * Set to PIPE_MASK_RGBAZS if unsure.
263 */
264 void util_blitter_blit_generic(struct blitter_context *blitter,
265 struct pipe_surface *dst,
266 const struct pipe_box *dstbox,
267 struct pipe_sampler_view *src,
268 const struct pipe_box *srcbox,
269 unsigned src_width0, unsigned src_height0,
270 unsigned mask, unsigned filter,
271 const struct pipe_scissor_state *scissor,
272 bool alpha_blend);
273
274 void util_blitter_blit(struct blitter_context *blitter,
275 const struct pipe_blit_info *info);
276
277 void util_blitter_generate_mipmap(struct blitter_context *blitter,
278 struct pipe_resource *tex,
279 enum pipe_format format,
280 unsigned base_level, unsigned last_level,
281 unsigned first_layer, unsigned last_layer);
282
283 /**
284 * Helper function to initialize a view for copy_texture_view.
285 * The parameters must match copy_texture_view.
286 */
287 void util_blitter_default_dst_texture(struct pipe_surface *dst_templ,
288 struct pipe_resource *dst,
289 unsigned dstlevel,
290 unsigned dstz);
291
292 /**
293 * Helper function to initialize a view for copy_texture_view.
294 * The parameters must match copy_texture_view.
295 */
296 void util_blitter_default_src_texture(struct blitter_context *blitter,
297 struct pipe_sampler_view *src_templ,
298 struct pipe_resource *src,
299 unsigned srclevel);
300
301 /**
302 * Copy data from one buffer to another using the Stream Output functionality.
303 * 4-byte alignment is required, otherwise software fallback is used.
304 */
305 void util_blitter_copy_buffer(struct blitter_context *blitter,
306 struct pipe_resource *dst,
307 unsigned dstx,
308 struct pipe_resource *src,
309 unsigned srcx,
310 unsigned size);
311
312 /**
313 * Clear the contents of a buffer using the Stream Output functionality.
314 * 4-byte alignment is required.
315 *
316 * "num_channels" can be 1, 2, 3, or 4, and specifies if the clear value is
317 * R, RG, RGB, or RGBA.
318 *
319 * For each element, only "num_channels" components of "clear_value" are
320 * copied to the buffer, then the offset is incremented by num_channels*4.
321 */
322 void util_blitter_clear_buffer(struct blitter_context *blitter,
323 struct pipe_resource *dst,
324 unsigned offset, unsigned size,
325 unsigned num_channels,
326 const union pipe_color_union *clear_value);
327
328 /**
329 * Clear a region of a (color) surface to a constant value.
330 *
331 * These states must be saved in the blitter in addition to the state objects
332 * already required to be saved:
333 * - fragment shader
334 * - depth stencil alpha state
335 * - blend state
336 * - framebuffer state
337 */
338 void util_blitter_clear_render_target(struct blitter_context *blitter,
339 struct pipe_surface *dst,
340 const union pipe_color_union *color,
341 unsigned dstx, unsigned dsty,
342 unsigned width, unsigned height);
343
344 /**
345 * Clear a region of a depth-stencil surface, both stencil and depth
346 * or only one of them if this is a combined depth-stencil surface.
347 *
348 * These states must be saved in the blitter in addition to the state objects
349 * already required to be saved:
350 * - fragment shader
351 * - depth stencil alpha state
352 * - blend state
353 * - framebuffer state
354 */
355 void util_blitter_clear_depth_stencil(struct blitter_context *blitter,
356 struct pipe_surface *dst,
357 unsigned clear_flags,
358 double depth,
359 unsigned stencil,
360 unsigned dstx, unsigned dsty,
361 unsigned width, unsigned height);
362
363 /* The following functions are customized variants of the clear functions.
364 * Some drivers use them internally to do things like MSAA resolve
365 * and resource decompression. It usually consists of rendering a full-screen
366 * quad with a special blend or DSA state.
367 */
368
369 /* Used by r300g for depth decompression. */
370 void util_blitter_custom_clear_depth(struct blitter_context *blitter,
371 unsigned width, unsigned height,
372 double depth, void *custom_dsa);
373
374 /* Used by r600g for depth decompression. */
375 void util_blitter_custom_depth_stencil(struct blitter_context *blitter,
376 struct pipe_surface *zsurf,
377 struct pipe_surface *cbsurf,
378 unsigned sample_mask,
379 void *dsa_stage, float depth);
380
381 /* Used by r600g for color decompression. */
382 void util_blitter_custom_color(struct blitter_context *blitter,
383 struct pipe_surface *dstsurf,
384 void *custom_blend);
385
386 /* Used by r600g for MSAA color resolve. */
387 void util_blitter_custom_resolve_color(struct blitter_context *blitter,
388 struct pipe_resource *dst,
389 unsigned dst_level,
390 unsigned dst_layer,
391 struct pipe_resource *src,
392 unsigned src_layer,
393 unsigned sampled_mask,
394 void *custom_blend,
395 enum pipe_format format);
396
397 /* Used by vc4 for 8/16-bit linear-to-tiled blits */
398 void util_blitter_custom_shader(struct blitter_context *blitter,
399 struct pipe_surface *dstsurf,
400 void *custom_vs, void *custom_fs);
401
402 /* The functions below should be used to save currently bound constant state
403 * objects inside a driver. The objects are automatically restored at the end
404 * of the util_blitter_{clear, copy_region, fill_region} functions and then
405 * forgotten.
406 *
407 * States not listed here are not affected by util_blitter. */
408
409 static inline void
410 util_blitter_save_blend(struct blitter_context *blitter, void *state)
411 {
412 blitter->saved_blend_state = state;
413 }
414
415 static inline void
416 util_blitter_save_depth_stencil_alpha(struct blitter_context *blitter,
417 void *state)
418 {
419 blitter->saved_dsa_state = state;
420 }
421
422 static inline void
423 util_blitter_save_vertex_elements(struct blitter_context *blitter, void *state)
424 {
425 blitter->saved_velem_state = state;
426 }
427
428 static inline void
429 util_blitter_save_stencil_ref(struct blitter_context *blitter,
430 const struct pipe_stencil_ref *state)
431 {
432 blitter->saved_stencil_ref = *state;
433 }
434
435 static inline void
436 util_blitter_save_rasterizer(struct blitter_context *blitter, void *state)
437 {
438 blitter->saved_rs_state = state;
439 }
440
441 static inline void
442 util_blitter_save_fragment_shader(struct blitter_context *blitter, void *fs)
443 {
444 blitter->saved_fs = fs;
445 }
446
447 static inline void
448 util_blitter_save_vertex_shader(struct blitter_context *blitter, void *vs)
449 {
450 blitter->saved_vs = vs;
451 }
452
453 static inline void
454 util_blitter_save_geometry_shader(struct blitter_context *blitter, void *gs)
455 {
456 blitter->saved_gs = gs;
457 }
458
459 static inline void
460 util_blitter_save_tessctrl_shader(struct blitter_context *blitter,
461 void *sh)
462 {
463 blitter->saved_tcs = sh;
464 }
465
466 static inline void
467 util_blitter_save_tesseval_shader(struct blitter_context *blitter,
468 void *sh)
469 {
470 blitter->saved_tes = sh;
471 }
472
473 static inline void
474 util_blitter_save_framebuffer(struct blitter_context *blitter,
475 const struct pipe_framebuffer_state *state)
476 {
477 blitter->saved_fb_state.nr_cbufs = 0; /* It's ~0 now, meaning it's unsaved. */
478 util_copy_framebuffer_state(&blitter->saved_fb_state, state);
479 }
480
481 static inline void
482 util_blitter_save_viewport(struct blitter_context *blitter,
483 struct pipe_viewport_state *state)
484 {
485 blitter->saved_viewport = *state;
486 }
487
488 static inline void
489 util_blitter_save_scissor(struct blitter_context *blitter,
490 struct pipe_scissor_state *state)
491 {
492 blitter->saved_scissor = *state;
493 }
494
495 static inline void
496 util_blitter_save_fragment_sampler_states(
497 struct blitter_context *blitter,
498 unsigned num_sampler_states,
499 void **sampler_states)
500 {
501 assert(num_sampler_states <= ARRAY_SIZE(blitter->saved_sampler_states));
502
503 blitter->saved_num_sampler_states = num_sampler_states;
504 memcpy(blitter->saved_sampler_states, sampler_states,
505 num_sampler_states * sizeof(void *));
506 }
507
508 static inline void
509 util_blitter_save_fragment_sampler_views(struct blitter_context *blitter,
510 unsigned num_views,
511 struct pipe_sampler_view **views)
512 {
513 unsigned i;
514 assert(num_views <= ARRAY_SIZE(blitter->saved_sampler_views));
515
516 blitter->saved_num_sampler_views = num_views;
517 for (i = 0; i < num_views; i++)
518 pipe_sampler_view_reference(&blitter->saved_sampler_views[i],
519 views[i]);
520 }
521
522 static inline void
523 util_blitter_save_fragment_constant_buffer_slot(
524 struct blitter_context *blitter,
525 struct pipe_constant_buffer *constant_buffers)
526 {
527 pipe_resource_reference(&blitter->saved_fs_constant_buffer.buffer,
528 constant_buffers[blitter->cb_slot].buffer);
529 memcpy(&blitter->saved_fs_constant_buffer, &constant_buffers[blitter->cb_slot],
530 sizeof(struct pipe_constant_buffer));
531 }
532
533 static inline void
534 util_blitter_save_vertex_buffer_slot(struct blitter_context *blitter,
535 struct pipe_vertex_buffer *vertex_buffers)
536 {
537 pipe_vertex_buffer_reference(&blitter->saved_vertex_buffer,
538 &vertex_buffers[blitter->vb_slot]);
539 }
540
541 static inline void
542 util_blitter_save_so_targets(struct blitter_context *blitter,
543 unsigned num_targets,
544 struct pipe_stream_output_target **targets)
545 {
546 unsigned i;
547 assert(num_targets <= ARRAY_SIZE(blitter->saved_so_targets));
548
549 blitter->saved_num_so_targets = num_targets;
550 for (i = 0; i < num_targets; i++)
551 pipe_so_target_reference(&blitter->saved_so_targets[i],
552 targets[i]);
553 }
554
555 static inline void
556 util_blitter_save_sample_mask(struct blitter_context *blitter,
557 unsigned sample_mask)
558 {
559 blitter->is_sample_mask_saved = true;
560 blitter->saved_sample_mask = sample_mask;
561 }
562
563 static inline void
564 util_blitter_save_render_condition(struct blitter_context *blitter,
565 struct pipe_query *query,
566 bool condition,
567 enum pipe_render_cond_flag mode)
568 {
569 blitter->saved_render_cond_query = query;
570 blitter->saved_render_cond_mode = mode;
571 blitter->saved_render_cond_cond = condition;
572 }
573
574 static inline void
575 util_blitter_save_window_rectangles(struct blitter_context *blitter,
576 boolean include,
577 unsigned num_rectangles,
578 const struct pipe_scissor_state *rects)
579 {
580 blitter->saved_window_rectangles_include = include;
581 blitter->saved_num_window_rectangles = num_rectangles;
582 if (num_rectangles > 0) {
583 assert(num_rectangles < ARRAY_SIZE(blitter->saved_window_rectangles));
584 memcpy(blitter->saved_window_rectangles, rects,
585 sizeof(*rects) * num_rectangles);
586 }
587 }
588
589 void util_blitter_common_clear_setup(struct blitter_context *blitter,
590 unsigned width, unsigned height,
591 unsigned clear_buffers,
592 void *custom_blend, void *custom_dsa);
593
594 void util_blitter_set_running_flag(struct blitter_context *blitter);
595 void util_blitter_unset_running_flag(struct blitter_context *blitter);
596
597 void util_blitter_restore_vertex_states(struct blitter_context *blitter);
598 void util_blitter_restore_fragment_states(struct blitter_context *blitter);
599 void util_blitter_restore_render_cond(struct blitter_context *blitter);
600 void util_blitter_restore_fb_state(struct blitter_context *blitter);
601 void util_blitter_restore_textures(struct blitter_context *blitter);
602 void util_blitter_restore_constant_buffer_state(struct blitter_context *blitter);
603
604 /* These are supported combinations of blits from ZS to color and vice versa.
605 * The blitter will do the packing/unpacking of depth and stencil
606 * in the fragment shader.
607 */
608 static inline enum pipe_format
609 util_blitter_get_color_format_for_zs(enum pipe_format format)
610 {
611 switch (format) {
612 case PIPE_FORMAT_Z16_UNORM:
613 return PIPE_FORMAT_R16_UNORM;
614
615 case PIPE_FORMAT_Z32_FLOAT:
616 return PIPE_FORMAT_R32_FLOAT;
617
618 case PIPE_FORMAT_Z24_UNORM_S8_UINT:
619 case PIPE_FORMAT_Z24X8_UNORM:
620 case PIPE_FORMAT_S8_UINT_Z24_UNORM:
621 case PIPE_FORMAT_X8Z24_UNORM:
622 return PIPE_FORMAT_R32_UINT;
623
624 case PIPE_FORMAT_Z32_FLOAT_S8X24_UINT:
625 return PIPE_FORMAT_R32G32_UINT;
626
627 case PIPE_FORMAT_Z32_UNORM:
628 default:
629 assert(0);
630 }
631 return PIPE_FORMAT_NONE;
632 }
633
634 #ifdef __cplusplus
635 }
636 #endif
637
638 #endif