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 to the COLOR0
64 * 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 float attrib
[4]);
82 /* Private members, really. */
83 struct pipe_context
*pipe
; /**< pipe context */
85 void *saved_blend_state
; /**< blend state */
86 void *saved_dsa_state
; /**< depth stencil alpha state */
87 void *saved_velem_state
; /**< vertex elements state */
88 void *saved_rs_state
; /**< rasterizer state */
89 void *saved_fs
, *saved_vs
; /**< fragment shader, vertex shader */
91 struct pipe_framebuffer_state saved_fb_state
; /**< framebuffer state */
92 struct pipe_stencil_ref saved_stencil_ref
; /**< stencil ref */
93 struct pipe_viewport_state saved_viewport
;
94 struct pipe_clip_state saved_clip
;
96 int saved_num_sampler_states
;
97 void *saved_sampler_states
[PIPE_MAX_SAMPLERS
];
99 int saved_num_sampler_views
;
100 struct pipe_sampler_view
*saved_sampler_views
[PIPE_MAX_SAMPLERS
];
102 int saved_num_vertex_buffers
;
103 struct pipe_vertex_buffer saved_vertex_buffers
[PIPE_MAX_ATTRIBS
];
107 * Create a blitter context.
109 struct blitter_context
*util_blitter_create(struct pipe_context
*pipe
);
112 * Destroy a blitter context.
114 void util_blitter_destroy(struct blitter_context
*blitter
);
117 * Return the pipe context associated with a blitter context.
120 struct pipe_context
*util_blitter_get_pipe(struct blitter_context
*blitter
)
122 return blitter
->pipe
;
126 * These CSOs must be saved before any of the following functions is called:
128 * - depth stencil alpha state
135 * Clear a specified set of currently bound buffers to specified values.
137 void util_blitter_clear(struct blitter_context
*blitter
,
138 unsigned width
, unsigned height
,
140 unsigned clear_buffers
,
142 double depth
, unsigned stencil
);
145 * Copy a block of pixels from one surface to another.
147 * You can copy from any color format to any other color format provided
148 * the former can be sampled and the latter can be rendered to. Otherwise,
149 * a software fallback path is taken and both surfaces must be of the same
152 * The same holds for depth-stencil formats with the exception that stencil
153 * cannot be copied unless you set ignore_stencil to FALSE. In that case,
154 * a software fallback path is taken and both surfaces must be of the same
157 * Use pipe_screen->is_format_supported to know your options.
159 * These states must be saved in the blitter in addition to the state objects
160 * already required to be saved:
161 * - framebuffer state
162 * - fragment sampler states
163 * - fragment sampler textures
165 void util_blitter_copy_region(struct blitter_context
*blitter
,
166 struct pipe_resource
*dst
,
167 struct pipe_subresource subdst
,
168 unsigned dstx
, unsigned dsty
, unsigned dstz
,
169 struct pipe_resource
*src
,
170 struct pipe_subresource subsrc
,
171 unsigned srcx
, unsigned srcy
, unsigned srcz
,
172 unsigned width
, unsigned height
,
173 boolean ignore_stencil
);
176 * Clear a region of a (color) surface to a constant value.
178 * These states must be saved in the blitter in addition to the state objects
179 * already required to be saved:
180 * - framebuffer state
182 void util_blitter_clear_render_target(struct blitter_context
*blitter
,
183 struct pipe_surface
*dst
,
185 unsigned dstx
, unsigned dsty
,
186 unsigned width
, unsigned height
);
189 * Clear a region of a depth-stencil surface, both stencil and depth
190 * or only one of them if this is a combined depth-stencil surface.
192 * These states must be saved in the blitter in addition to the state objects
193 * already required to be saved:
194 * - framebuffer state
196 void util_blitter_clear_depth_stencil(struct blitter_context
*blitter
,
197 struct pipe_surface
*dst
,
198 unsigned clear_flags
,
201 unsigned dstx
, unsigned dsty
,
202 unsigned width
, unsigned height
);
204 void util_blitter_flush_depth_stencil(struct blitter_context
*blitter
,
205 struct pipe_surface
*dstsurf
);
207 void util_blitter_custom_depth_stencil(struct blitter_context
*blitter
,
208 struct pipe_surface
*zsurf
,
209 struct pipe_surface
*cbsurf
,
210 void *dsa_stage
, float depth
);
212 /* The functions below should be used to save currently bound constant state
213 * objects inside a driver. The objects are automatically restored at the end
214 * of the util_blitter_{clear, copy_region, fill_region} functions and then
217 * CSOs not listed here are not affected by util_blitter. */
220 void util_blitter_save_blend(struct blitter_context
*blitter
,
223 blitter
->saved_blend_state
= state
;
227 void util_blitter_save_depth_stencil_alpha(struct blitter_context
*blitter
,
230 blitter
->saved_dsa_state
= state
;
234 void util_blitter_save_vertex_elements(struct blitter_context
*blitter
,
237 blitter
->saved_velem_state
= state
;
241 void util_blitter_save_stencil_ref(struct blitter_context
*blitter
,
242 const struct pipe_stencil_ref
*state
)
244 blitter
->saved_stencil_ref
= *state
;
248 void util_blitter_save_rasterizer(struct blitter_context
*blitter
,
251 blitter
->saved_rs_state
= state
;
255 void util_blitter_save_fragment_shader(struct blitter_context
*blitter
,
258 blitter
->saved_fs
= fs
;
262 void util_blitter_save_vertex_shader(struct blitter_context
*blitter
,
265 blitter
->saved_vs
= vs
;
269 void util_blitter_save_framebuffer(struct blitter_context
*blitter
,
270 const struct pipe_framebuffer_state
*state
)
272 blitter
->saved_fb_state
.nr_cbufs
= 0; /* It's ~0 now, meaning it's unsaved. */
273 util_copy_framebuffer_state(&blitter
->saved_fb_state
, state
);
277 void util_blitter_save_viewport(struct blitter_context
*blitter
,
278 struct pipe_viewport_state
*state
)
280 blitter
->saved_viewport
= *state
;
284 void util_blitter_save_clip(struct blitter_context
*blitter
,
285 struct pipe_clip_state
*state
)
287 blitter
->saved_clip
= *state
;
291 void util_blitter_save_fragment_sampler_states(
292 struct blitter_context
*blitter
,
293 int num_sampler_states
,
294 void **sampler_states
)
296 assert(num_sampler_states
<= Elements(blitter
->saved_sampler_states
));
298 blitter
->saved_num_sampler_states
= num_sampler_states
;
299 memcpy(blitter
->saved_sampler_states
, sampler_states
,
300 num_sampler_states
* sizeof(void *));
304 util_blitter_save_fragment_sampler_views(struct blitter_context
*blitter
,
306 struct pipe_sampler_view
**views
)
309 assert(num_views
<= Elements(blitter
->saved_sampler_views
));
311 blitter
->saved_num_sampler_views
= num_views
;
312 for (i
= 0; i
< num_views
; i
++)
313 pipe_sampler_view_reference(&blitter
->saved_sampler_views
[i
],
318 util_blitter_save_vertex_buffers(struct blitter_context
*blitter
,
319 int num_vertex_buffers
,
320 struct pipe_vertex_buffer
*vertex_buffers
)
323 assert(num_vertex_buffers
<= Elements(blitter
->saved_vertex_buffers
));
325 blitter
->saved_num_vertex_buffers
= num_vertex_buffers
;
327 for (i
= 0; i
< num_vertex_buffers
; i
++) {
328 if (vertex_buffers
[i
].buffer
) {
329 pipe_resource_reference(&blitter
->saved_vertex_buffers
[i
].buffer
,
330 vertex_buffers
[i
].buffer
);
334 memcpy(blitter
->saved_vertex_buffers
,
336 num_vertex_buffers
* sizeof(struct pipe_vertex_buffer
));