1 /**************************************************************************
3 * Copyright 2009 Marek Olšák <maraeo@gmail.com>
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:
13 * The above copyright notice and this permission notice (including the
14 * next paragraph) shall be included in all copies or substantial portions
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 TUNGSTEN GRAPHICS 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.
25 **************************************************************************/
30 #include "util/u_framebuffer.h"
31 #include "util/u_inlines.h"
32 #include "util/u_memory.h"
34 #include "pipe/p_state.h"
43 enum blitter_attrib_type
{
44 UTIL_BLITTER_ATTRIB_NONE
,
45 UTIL_BLITTER_ATTRIB_COLOR
,
46 UTIL_BLITTER_ATTRIB_TEXCOORD
49 struct blitter_context
54 * \param x1 An X coordinate of the top-left corner.
55 * \param y1 A Y coordinate of the top-left corner.
56 * \param x2 An X coordinate of the bottom-right corner.
57 * \param y2 A Y coordinate of the bottom-right corner.
58 * \param depth A depth which the rectangle is rendered at.
60 * \param type Semantics of the attributes "attrib".
61 * If type is UTIL_BLITTER_ATTRIB_NONE, ignore them.
62 * If type is UTIL_BLITTER_ATTRIB_COLOR, the attributes
63 * make up a constant RGBA color, and should go
64 * to the GENERIC0 varying slot of a fragment shader.
65 * If type is UTIL_BLITTER_ATTRIB_TEXCOORD, {a1, a2} and
66 * {a3, a4} specify top-left and bottom-right texture
67 * coordinates of the rectangle, respectively, and should go
68 * to the GENERIC0 varying slot of a fragment shader.
70 * \param attrib See type.
72 * \note A driver may optionally override this callback to implement
73 * a specialized hardware path for drawing a rectangle, e.g. using
74 * a rectangular point sprite.
76 void (*draw_rectangle
)(struct blitter_context
*blitter
,
77 unsigned x1
, unsigned y1
, unsigned x2
, unsigned y2
,
79 enum blitter_attrib_type type
,
80 const union pipe_color_union
*color
);
82 /* Whether the blitter is running. */
85 /* Private members, really. */
86 struct pipe_context
*pipe
; /**< pipe context */
88 void *saved_blend_state
; /**< blend state */
89 void *saved_dsa_state
; /**< depth stencil alpha state */
90 void *saved_velem_state
; /**< vertex elements state */
91 void *saved_rs_state
; /**< rasterizer state */
92 void *saved_fs
, *saved_vs
, *saved_gs
; /**< shaders */
94 struct pipe_framebuffer_state saved_fb_state
; /**< framebuffer state */
95 struct pipe_stencil_ref saved_stencil_ref
; /**< stencil ref */
96 struct pipe_viewport_state saved_viewport
;
97 struct pipe_clip_state saved_clip
;
99 int saved_num_sampler_states
;
100 void *saved_sampler_states
[PIPE_MAX_SAMPLERS
];
102 int saved_num_sampler_views
;
103 struct pipe_sampler_view
*saved_sampler_views
[PIPE_MAX_SAMPLERS
];
105 int saved_num_vertex_buffers
;
106 struct pipe_vertex_buffer saved_vertex_buffers
[PIPE_MAX_ATTRIBS
];
110 * Create a blitter context.
112 struct blitter_context
*util_blitter_create(struct pipe_context
*pipe
);
115 * Destroy a blitter context.
117 void util_blitter_destroy(struct blitter_context
*blitter
);
120 * Return the pipe context associated with a blitter context.
123 struct pipe_context
*util_blitter_get_pipe(struct blitter_context
*blitter
)
125 return blitter
->pipe
;
129 * These states must be saved before any of the following functions are called:
133 * - geometry shader (if supported)
138 * Clear a specified set of currently bound buffers to specified values.
140 * These states must be saved in the blitter in addition to the state objects
141 * already required to be saved:
143 * - depth stencil alpha state
146 void util_blitter_clear(struct blitter_context
*blitter
,
147 unsigned width
, unsigned height
,
149 unsigned clear_buffers
,
150 const union pipe_color_union
*color
,
151 double depth
, unsigned stencil
);
153 void util_blitter_clear_depth_custom(struct blitter_context
*blitter
,
154 unsigned width
, unsigned height
,
155 double depth
, void *custom_dsa
);
158 * Copy a block of pixels from one surface to another.
160 * You can copy from any color format to any other color format provided
161 * the former can be sampled from and the latter can be rendered to. Otherwise,
162 * a software fallback path is taken and both surfaces must be of the same
165 * The same holds for depth-stencil formats with the exception that stencil
166 * cannot be copied unless you set ignore_stencil to FALSE. In that case,
167 * a software fallback path is taken and both surfaces must be of the same
169 * XXX implement hw-accel stencil copy using shader stencil export.
171 * Use pipe_screen->is_format_supported to know your options.
173 * These states must be saved in the blitter in addition to the state objects
174 * already required to be saved:
176 * - depth stencil alpha state
178 * - fragment sampler states
179 * - fragment sampler textures
180 * - framebuffer state
182 void util_blitter_copy_texture(struct blitter_context
*blitter
,
183 struct pipe_resource
*dst
,
185 unsigned dstx
, unsigned dsty
, unsigned dstz
,
186 struct pipe_resource
*src
,
188 const struct pipe_box
*srcbox
,
189 boolean ignore_stencil
);
192 * Clear a region of a (color) surface to a constant value.
194 * These states must be saved in the blitter in addition to the state objects
195 * already required to be saved:
197 * - depth stencil alpha state
199 * - framebuffer state
201 void util_blitter_clear_render_target(struct blitter_context
*blitter
,
202 struct pipe_surface
*dst
,
203 const union pipe_color_union
*color
,
204 unsigned dstx
, unsigned dsty
,
205 unsigned width
, unsigned height
);
208 * Clear a region of a depth-stencil surface, both stencil and depth
209 * or only one of them if this is a combined depth-stencil surface.
211 * These states must be saved in the blitter in addition to the state objects
212 * already required to be saved:
214 * - depth stencil alpha state
216 * - framebuffer state
218 void util_blitter_clear_depth_stencil(struct blitter_context
*blitter
,
219 struct pipe_surface
*dst
,
220 unsigned clear_flags
,
223 unsigned dstx
, unsigned dsty
,
224 unsigned width
, unsigned height
);
226 void util_blitter_custom_depth_stencil(struct blitter_context
*blitter
,
227 struct pipe_surface
*zsurf
,
228 struct pipe_surface
*cbsurf
,
229 void *dsa_stage
, float depth
);
231 /* The functions below should be used to save currently bound constant state
232 * objects inside a driver. The objects are automatically restored at the end
233 * of the util_blitter_{clear, copy_region, fill_region} functions and then
236 * States not listed here are not affected by util_blitter. */
239 void util_blitter_save_blend(struct blitter_context
*blitter
,
242 blitter
->saved_blend_state
= state
;
246 void util_blitter_save_depth_stencil_alpha(struct blitter_context
*blitter
,
249 blitter
->saved_dsa_state
= state
;
253 void util_blitter_save_vertex_elements(struct blitter_context
*blitter
,
256 blitter
->saved_velem_state
= state
;
260 void util_blitter_save_stencil_ref(struct blitter_context
*blitter
,
261 const struct pipe_stencil_ref
*state
)
263 blitter
->saved_stencil_ref
= *state
;
267 void util_blitter_save_rasterizer(struct blitter_context
*blitter
,
270 blitter
->saved_rs_state
= state
;
274 void util_blitter_save_fragment_shader(struct blitter_context
*blitter
,
277 blitter
->saved_fs
= fs
;
281 void util_blitter_save_vertex_shader(struct blitter_context
*blitter
,
284 blitter
->saved_vs
= vs
;
288 void util_blitter_save_geometry_shader(struct blitter_context
*blitter
,
291 blitter
->saved_gs
= gs
;
295 void util_blitter_save_framebuffer(struct blitter_context
*blitter
,
296 const struct pipe_framebuffer_state
*state
)
298 blitter
->saved_fb_state
.nr_cbufs
= 0; /* It's ~0 now, meaning it's unsaved. */
299 util_copy_framebuffer_state(&blitter
->saved_fb_state
, state
);
303 void util_blitter_save_viewport(struct blitter_context
*blitter
,
304 struct pipe_viewport_state
*state
)
306 blitter
->saved_viewport
= *state
;
310 void util_blitter_save_clip(struct blitter_context
*blitter
,
311 struct pipe_clip_state
*state
)
313 blitter
->saved_clip
= *state
;
317 void util_blitter_save_fragment_sampler_states(
318 struct blitter_context
*blitter
,
319 int num_sampler_states
,
320 void **sampler_states
)
322 assert(num_sampler_states
<= Elements(blitter
->saved_sampler_states
));
324 blitter
->saved_num_sampler_states
= num_sampler_states
;
325 memcpy(blitter
->saved_sampler_states
, sampler_states
,
326 num_sampler_states
* sizeof(void *));
330 util_blitter_save_fragment_sampler_views(struct blitter_context
*blitter
,
332 struct pipe_sampler_view
**views
)
335 assert(num_views
<= Elements(blitter
->saved_sampler_views
));
337 blitter
->saved_num_sampler_views
= num_views
;
338 for (i
= 0; i
< num_views
; i
++)
339 pipe_sampler_view_reference(&blitter
->saved_sampler_views
[i
],
344 util_blitter_save_vertex_buffers(struct blitter_context
*blitter
,
345 int num_vertex_buffers
,
346 struct pipe_vertex_buffer
*vertex_buffers
)
348 assert(num_vertex_buffers
<= Elements(blitter
->saved_vertex_buffers
));
350 blitter
->saved_num_vertex_buffers
= 0;
351 util_copy_vertex_buffers(blitter
->saved_vertex_buffers
,
352 (unsigned*)&blitter
->saved_num_vertex_buffers
,