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_memory.h"
32 #include "pipe/p_state.h"
41 struct blitter_context
43 /* Private members, really. */
44 void *saved_blend_state
; /**< blend state */
45 void *saved_dsa_state
; /**< depth stencil alpha state */
46 void *saved_rs_state
; /**< rasterizer state */
47 void *saved_fs
, *saved_vs
; /**< fragment shader, vertex shader */
49 struct pipe_framebuffer_state saved_fb_state
; /**< framebuffer state */
50 struct pipe_stencil_ref saved_stencil_ref
; /**< stencil ref */
52 int saved_num_sampler_states
;
53 void *saved_sampler_states
[32];
55 int saved_num_textures
;
56 struct pipe_texture
*saved_textures
[32]; /* is 32 enough? */
60 * Create a blitter context.
62 struct blitter_context
*util_blitter_create(struct pipe_context
*pipe
);
65 * Destroy a blitter context.
67 void util_blitter_destroy(struct blitter_context
*blitter
);
70 * These CSOs must be saved before any of the following functions is called:
72 * - depth stencil alpha state
79 * Clear a specified set of currently bound buffers to specified values.
81 void util_blitter_clear(struct blitter_context
*blitter
,
82 unsigned width
, unsigned height
,
84 unsigned clear_buffers
,
86 double depth
, unsigned stencil
);
89 * Copy a block of pixels from one surface to another.
91 * You can copy from any color format to any other color format provided
92 * the former can be sampled and the latter can be rendered to. Otherwise,
93 * a software fallback path is taken and both surfaces must be of the same
96 * The same holds for depth-stencil formats with the exception that stencil
97 * cannot be copied unless you set ignore_stencil to FALSE. In that case,
98 * a software fallback path is taken and both surfaces must be of the same
101 * Use pipe_screen->is_format_supported to know your options.
103 * These states must be saved in the blitter in addition to the state objects
104 * already required to be saved:
105 * - framebuffer state
106 * - fragment sampler states
107 * - fragment sampler textures
109 void util_blitter_copy(struct blitter_context
*blitter
,
110 struct pipe_surface
*dst
,
111 unsigned dstx
, unsigned dsty
,
112 struct pipe_surface
*src
,
113 unsigned srcx
, unsigned srcy
,
114 unsigned width
, unsigned height
,
115 boolean ignore_stencil
);
118 * Fill a region of a surface with a constant value.
120 * If the surface cannot be rendered to or it's a depth-stencil format,
121 * a software fallback path is taken.
123 * These states must be saved in the blitter in addition to the state objects
124 * already required to be saved:
125 * - framebuffer state
127 void util_blitter_fill(struct blitter_context
*blitter
,
128 struct pipe_surface
*dst
,
129 unsigned dstx
, unsigned dsty
,
130 unsigned width
, unsigned height
,
134 * Copy all pixels from one surface to another.
136 * The rules are the same as in util_blitter_copy with the addition that
137 * surfaces must have the same size.
140 void util_blitter_copy_surface(struct blitter_context
*blitter
,
141 struct pipe_surface
*dst
,
142 struct pipe_surface
*src
,
143 boolean ignore_stencil
)
145 assert(dst
->width
== src
->width
&& dst
->height
== src
->height
);
147 util_blitter_copy(blitter
, dst
, 0, 0, src
, 0, 0, src
->width
, src
->height
,
152 /* The functions below should be used to save currently bound constant state
153 * objects inside a driver. The objects are automatically restored at the end
154 * of the util_blitter_{clear, fill, copy, copy_surface} functions and then
157 * CSOs not listed here are not affected by util_blitter. */
160 void util_blitter_save_blend(struct blitter_context
*blitter
,
163 blitter
->saved_blend_state
= state
;
167 void util_blitter_save_depth_stencil_alpha(struct blitter_context
*blitter
,
170 blitter
->saved_dsa_state
= state
;
174 void util_blitter_save_stencil_ref(struct blitter_context
*blitter
,
175 const struct pipe_stencil_ref
*state
)
177 blitter
->saved_stencil_ref
= *state
;
181 void util_blitter_save_rasterizer(struct blitter_context
*blitter
,
184 blitter
->saved_rs_state
= state
;
188 void util_blitter_save_fragment_shader(struct blitter_context
*blitter
,
191 blitter
->saved_fs
= fs
;
195 void util_blitter_save_vertex_shader(struct blitter_context
*blitter
,
198 blitter
->saved_vs
= vs
;
202 void util_blitter_save_framebuffer(struct blitter_context
*blitter
,
203 struct pipe_framebuffer_state
*state
)
205 blitter
->saved_fb_state
= *state
;
209 void util_blitter_save_fragment_sampler_states(
210 struct blitter_context
*blitter
,
211 int num_sampler_states
,
212 void **sampler_states
)
214 assert(num_sampler_states
<= Elements(blitter
->saved_sampler_states
));
216 blitter
->saved_num_sampler_states
= num_sampler_states
;
217 memcpy(blitter
->saved_sampler_states
, sampler_states
,
218 num_sampler_states
* sizeof(void *));
222 void util_blitter_save_fragment_sampler_textures(
223 struct blitter_context
*blitter
,
225 struct pipe_texture
**textures
)
227 assert(num_textures
<= Elements(blitter
->saved_textures
));
229 blitter
->saved_num_textures
= num_textures
;
230 memcpy(blitter
->saved_textures
, textures
,
231 num_textures
* sizeof(struct pipe_texture
*));