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 */
51 int saved_num_sampler_states
;
52 void *saved_sampler_states
[32];
54 int saved_num_textures
;
55 struct pipe_texture
*saved_textures
[32]; /* is 32 enough? */
59 * Create a blitter context.
61 struct blitter_context
*util_blitter_create(struct pipe_context
*pipe
);
64 * Destroy a blitter context.
66 void util_blitter_destroy(struct blitter_context
*blitter
);
69 * These CSOs must be saved before any of the following functions is called:
71 * - depth stencil alpha state
78 * Clear a specified set of currently bound buffers to specified values.
80 void util_blitter_clear(struct blitter_context
*blitter
,
81 unsigned width
, unsigned height
,
83 unsigned clear_buffers
,
85 double depth
, unsigned stencil
);
88 * Copy a block of pixels from one surface to another.
90 * You can copy from any color format to any other color format provided
91 * the former can be sampled and the latter can be rendered to. Otherwise,
92 * a software fallback path is taken and both surfaces must be of the same
95 * The same holds for depth-stencil formats with the exception that stencil
96 * cannot be copied unless you set ignore_stencil to FALSE. In that case,
97 * a software fallback path is taken and both surfaces must be of the same
100 * Use pipe_screen->is_format_supported to know your options.
102 * These states must be saved in the blitter in addition to the state objects
103 * already required to be saved:
104 * - framebuffer state
105 * - fragment sampler states
106 * - fragment sampler textures
108 void util_blitter_copy(struct blitter_context
*blitter
,
109 struct pipe_surface
*dst
,
110 unsigned dstx
, unsigned dsty
,
111 struct pipe_surface
*src
,
112 unsigned srcx
, unsigned srcy
,
113 unsigned width
, unsigned height
,
114 boolean ignore_stencil
);
117 * Fill a region of a surface with a constant value.
119 * If the surface cannot be rendered to or it's a depth-stencil format,
120 * a software fallback path is taken.
122 * These states must be saved in the blitter in addition to the state objects
123 * already required to be saved:
124 * - framebuffer state
126 void util_blitter_fill(struct blitter_context
*blitter
,
127 struct pipe_surface
*dst
,
128 unsigned dstx
, unsigned dsty
,
129 unsigned width
, unsigned height
,
133 * Copy all pixels from one surface to another.
135 * The rules are the same as in util_blitter_copy with the addition that
136 * surfaces must have the same size.
139 void util_blitter_copy_surface(struct blitter_context
*blitter
,
140 struct pipe_surface
*dst
,
141 struct pipe_surface
*src
,
142 boolean ignore_stencil
)
144 assert(dst
->width
== src
->width
&& dst
->height
== src
->height
);
146 util_blitter_copy(blitter
, dst
, 0, 0, src
, 0, 0, src
->width
, src
->height
,
151 /* The functions below should be used to save currently bound constant state
152 * objects inside a driver. The objects are automatically restored at the end
153 * of the util_blitter_{clear, fill, copy, copy_surface} functions and then
156 * CSOs not listed here are not affected by util_blitter. */
159 void util_blitter_save_blend(struct blitter_context
*blitter
,
162 blitter
->saved_blend_state
= state
;
166 void util_blitter_save_depth_stencil_alpha(struct blitter_context
*blitter
,
169 blitter
->saved_dsa_state
= state
;
173 void util_blitter_save_rasterizer(struct blitter_context
*blitter
,
176 blitter
->saved_rs_state
= state
;
180 void util_blitter_save_fragment_shader(struct blitter_context
*blitter
,
183 blitter
->saved_fs
= fs
;
187 void util_blitter_save_vertex_shader(struct blitter_context
*blitter
,
190 blitter
->saved_vs
= vs
;
194 void util_blitter_save_framebuffer(struct blitter_context
*blitter
,
195 struct pipe_framebuffer_state
*state
)
197 blitter
->saved_fb_state
= *state
;
201 void util_blitter_save_fragment_sampler_states(
202 struct blitter_context
*blitter
,
203 int num_sampler_states
,
204 void **sampler_states
)
206 assert(num_sampler_states
<= Elements(blitter
->saved_sampler_states
));
208 blitter
->saved_num_sampler_states
= num_sampler_states
;
209 memcpy(blitter
->saved_sampler_states
, sampler_states
,
210 num_sampler_states
* sizeof(void *));
214 void util_blitter_save_fragment_sampler_textures(
215 struct blitter_context
*blitter
,
217 struct pipe_texture
**textures
)
219 assert(num_textures
<= Elements(blitter
->saved_textures
));
221 blitter
->saved_num_textures
= num_textures
;
222 memcpy(blitter
->saved_textures
, textures
,
223 num_textures
* sizeof(struct pipe_texture
*));