u_blitter.h revision 4e28e6f6c777841b9ffe7a7ad1e865e2595f70f9
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 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. 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#include "util/u_memory.h" 33 34#include "pipe/p_state.h" 35 36 37#ifdef __cplusplus 38extern "C" { 39#endif 40 41struct pipe_context; 42 43enum blitter_attrib_type { 44 UTIL_BLITTER_ATTRIB_NONE, 45 UTIL_BLITTER_ATTRIB_COLOR, 46 UTIL_BLITTER_ATTRIB_TEXCOORD 47}; 48 49struct blitter_context 50{ 51 /** 52 * Draw a rectangle. 53 * 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. 59 * 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. 69 * 70 * \param attrib See type. 71 * 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. 75 */ 76 void (*draw_rectangle)(struct blitter_context *blitter, 77 unsigned x1, unsigned y1, unsigned x2, unsigned y2, 78 float depth, 79 enum blitter_attrib_type type, 80 const union pipe_color_union *color); 81 82 /* Whether the blitter is running. */ 83 boolean running; 84 85 /* Private members, really. */ 86 struct pipe_context *pipe; /**< pipe context */ 87 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 */ 93 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; 98 99 int saved_num_sampler_states; 100 void *saved_sampler_states[PIPE_MAX_SAMPLERS]; 101 102 int saved_num_sampler_views; 103 struct pipe_sampler_view *saved_sampler_views[PIPE_MAX_SAMPLERS]; 104 105 int saved_num_vertex_buffers; 106 struct pipe_vertex_buffer saved_vertex_buffers[PIPE_MAX_ATTRIBS]; 107}; 108 109/** 110 * Create a blitter context. 111 */ 112struct blitter_context *util_blitter_create(struct pipe_context *pipe); 113 114/** 115 * Destroy a blitter context. 116 */ 117void util_blitter_destroy(struct blitter_context *blitter); 118 119/** 120 * Return the pipe context associated with a blitter context. 121 */ 122static INLINE 123struct pipe_context *util_blitter_get_pipe(struct blitter_context *blitter) 124{ 125 return blitter->pipe; 126} 127 128/* 129 * These states must be saved before any of the following functions are called: 130 * - vertex buffers 131 * - vertex elements 132 * - vertex shader 133 * - geometry shader (if supported) 134 * - rasterizer state 135 */ 136 137/** 138 * Clear a specified set of currently bound buffers to specified values. 139 * 140 * These states must be saved in the blitter in addition to the state objects 141 * already required to be saved: 142 * - fragment shader 143 * - depth stencil alpha state 144 * - blend state 145 */ 146void util_blitter_clear(struct blitter_context *blitter, 147 unsigned width, unsigned height, 148 unsigned num_cbufs, 149 unsigned clear_buffers, 150 enum pipe_format cbuf_format, 151 const union pipe_color_union *color, 152 double depth, unsigned stencil); 153 154void util_blitter_clear_depth_custom(struct blitter_context *blitter, 155 unsigned width, unsigned height, 156 double depth, void *custom_dsa); 157 158/** 159 * Copy a block of pixels from one surface to another. 160 * 161 * You can copy from any color format to any other color format provided 162 * the former can be sampled from and the latter can be rendered to. Otherwise, 163 * a software fallback path is taken and both surfaces must be of the same 164 * format. 165 * 166 * The same holds for depth-stencil formats with the exception that stencil 167 * cannot be copied unless you set ignore_stencil to FALSE. In that case, 168 * a software fallback path is taken and both surfaces must be of the same 169 * format. 170 * XXX implement hw-accel stencil copy using shader stencil export. 171 * 172 * Use pipe_screen->is_format_supported to know your options. 173 * 174 * These states must be saved in the blitter in addition to the state objects 175 * already required to be saved: 176 * - fragment shader 177 * - depth stencil alpha state 178 * - blend state 179 * - fragment sampler states 180 * - fragment sampler textures 181 * - framebuffer state 182 */ 183void util_blitter_copy_texture(struct blitter_context *blitter, 184 struct pipe_resource *dst, 185 unsigned dstlevel, 186 unsigned dstx, unsigned dsty, unsigned dstz, 187 struct pipe_resource *src, 188 unsigned srclevel, 189 const struct pipe_box *srcbox, 190 boolean ignore_stencil); 191 192/** 193 * Clear a region of a (color) surface to a constant value. 194 * 195 * These states must be saved in the blitter in addition to the state objects 196 * already required to be saved: 197 * - fragment shader 198 * - depth stencil alpha state 199 * - blend state 200 * - framebuffer state 201 */ 202void util_blitter_clear_render_target(struct blitter_context *blitter, 203 struct pipe_surface *dst, 204 const union pipe_color_union *color, 205 unsigned dstx, unsigned dsty, 206 unsigned width, unsigned height); 207 208/** 209 * Clear a region of a depth-stencil surface, both stencil and depth 210 * or only one of them if this is a combined depth-stencil surface. 211 * 212 * These states must be saved in the blitter in addition to the state objects 213 * already required to be saved: 214 * - fragment shader 215 * - depth stencil alpha state 216 * - blend state 217 * - framebuffer state 218 */ 219void util_blitter_clear_depth_stencil(struct blitter_context *blitter, 220 struct pipe_surface *dst, 221 unsigned clear_flags, 222 double depth, 223 unsigned stencil, 224 unsigned dstx, unsigned dsty, 225 unsigned width, unsigned height); 226 227void util_blitter_custom_depth_stencil(struct blitter_context *blitter, 228 struct pipe_surface *zsurf, 229 struct pipe_surface *cbsurf, 230 void *dsa_stage, float depth); 231 232/* The functions below should be used to save currently bound constant state 233 * objects inside a driver. The objects are automatically restored at the end 234 * of the util_blitter_{clear, copy_region, fill_region} functions and then 235 * forgotten. 236 * 237 * States not listed here are not affected by util_blitter. */ 238 239static INLINE 240void util_blitter_save_blend(struct blitter_context *blitter, 241 void *state) 242{ 243 blitter->saved_blend_state = state; 244} 245 246static INLINE 247void util_blitter_save_depth_stencil_alpha(struct blitter_context *blitter, 248 void *state) 249{ 250 blitter->saved_dsa_state = state; 251} 252 253static INLINE 254void util_blitter_save_vertex_elements(struct blitter_context *blitter, 255 void *state) 256{ 257 blitter->saved_velem_state = state; 258} 259 260static INLINE 261void util_blitter_save_stencil_ref(struct blitter_context *blitter, 262 const struct pipe_stencil_ref *state) 263{ 264 blitter->saved_stencil_ref = *state; 265} 266 267static INLINE 268void util_blitter_save_rasterizer(struct blitter_context *blitter, 269 void *state) 270{ 271 blitter->saved_rs_state = state; 272} 273 274static INLINE 275void util_blitter_save_fragment_shader(struct blitter_context *blitter, 276 void *fs) 277{ 278 blitter->saved_fs = fs; 279} 280 281static INLINE 282void util_blitter_save_vertex_shader(struct blitter_context *blitter, 283 void *vs) 284{ 285 blitter->saved_vs = vs; 286} 287 288static INLINE 289void util_blitter_save_geometry_shader(struct blitter_context *blitter, 290 void *gs) 291{ 292 blitter->saved_gs = gs; 293} 294 295static INLINE 296void util_blitter_save_framebuffer(struct blitter_context *blitter, 297 const struct pipe_framebuffer_state *state) 298{ 299 blitter->saved_fb_state.nr_cbufs = 0; /* It's ~0 now, meaning it's unsaved. */ 300 util_copy_framebuffer_state(&blitter->saved_fb_state, state); 301} 302 303static INLINE 304void util_blitter_save_viewport(struct blitter_context *blitter, 305 struct pipe_viewport_state *state) 306{ 307 blitter->saved_viewport = *state; 308} 309 310static INLINE 311void util_blitter_save_clip(struct blitter_context *blitter, 312 struct pipe_clip_state *state) 313{ 314 blitter->saved_clip = *state; 315} 316 317static INLINE 318void util_blitter_save_fragment_sampler_states( 319 struct blitter_context *blitter, 320 int num_sampler_states, 321 void **sampler_states) 322{ 323 assert(num_sampler_states <= Elements(blitter->saved_sampler_states)); 324 325 blitter->saved_num_sampler_states = num_sampler_states; 326 memcpy(blitter->saved_sampler_states, sampler_states, 327 num_sampler_states * sizeof(void *)); 328} 329 330static INLINE void 331util_blitter_save_fragment_sampler_views(struct blitter_context *blitter, 332 int num_views, 333 struct pipe_sampler_view **views) 334{ 335 unsigned i; 336 assert(num_views <= Elements(blitter->saved_sampler_views)); 337 338 blitter->saved_num_sampler_views = num_views; 339 for (i = 0; i < num_views; i++) 340 pipe_sampler_view_reference(&blitter->saved_sampler_views[i], 341 views[i]); 342} 343 344static INLINE void 345util_blitter_save_vertex_buffers(struct blitter_context *blitter, 346 int num_vertex_buffers, 347 struct pipe_vertex_buffer *vertex_buffers) 348{ 349 assert(num_vertex_buffers <= Elements(blitter->saved_vertex_buffers)); 350 351 blitter->saved_num_vertex_buffers = 0; 352 util_copy_vertex_buffers(blitter->saved_vertex_buffers, 353 (unsigned*)&blitter->saved_num_vertex_buffers, 354 vertex_buffers, 355 num_vertex_buffers); 356} 357 358#ifdef __cplusplus 359} 360#endif 361 362#endif 363