u_blitter.h revision 233dd4953e3e6cf39f3c7a7cd898339a89d2ff86
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 float attrib[4]); 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; /**< fragment shader, vertex shader */ 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 is called: 130 * - blend state 131 * - depth stencil alpha state 132 * - rasterizer state 133 * - vertex shader 134 * - any other shader??? (XXX) 135 * - fragment shader 136 * - vertex buffers 137 * - vertex elements 138 */ 139 140/** 141 * Clear a specified set of currently bound buffers to specified values. 142 */ 143void util_blitter_clear(struct blitter_context *blitter, 144 unsigned width, unsigned height, 145 unsigned num_cbufs, 146 unsigned clear_buffers, 147 const float *rgba, 148 double depth, unsigned stencil); 149 150void util_blitter_clear_depth_custom(struct blitter_context *blitter, 151 unsigned width, unsigned height, 152 double depth, void *custom_dsa); 153 154/** 155 * Copy a block of pixels from one surface to another. 156 * 157 * You can copy from any color format to any other color format provided 158 * the former can be sampled and the latter can be rendered to. Otherwise, 159 * a software fallback path is taken and both surfaces must be of the same 160 * format. 161 * 162 * The same holds for depth-stencil formats with the exception that stencil 163 * cannot be copied unless you set ignore_stencil to FALSE. In that case, 164 * a software fallback path is taken and both surfaces must be of the same 165 * format. 166 * 167 * Use pipe_screen->is_format_supported to know your options. 168 * 169 * These states must be saved in the blitter in addition to the state objects 170 * already required to be saved: 171 * - framebuffer state 172 * - fragment sampler states 173 * - fragment sampler textures 174 */ 175void util_blitter_copy_texture(struct blitter_context *blitter, 176 struct pipe_resource *dst, 177 unsigned dstlevel, 178 unsigned dstx, unsigned dsty, unsigned dstz, 179 struct pipe_resource *src, 180 unsigned srclevel, 181 const struct pipe_box *srcbox, 182 boolean ignore_stencil); 183 184/** 185 * Clear a region of a (color) surface to a constant value. 186 * 187 * These states must be saved in the blitter in addition to the state objects 188 * already required to be saved: 189 * - framebuffer state 190 */ 191void util_blitter_clear_render_target(struct blitter_context *blitter, 192 struct pipe_surface *dst, 193 const float *rgba, 194 unsigned dstx, unsigned dsty, 195 unsigned width, unsigned height); 196 197/** 198 * Clear a region of a depth-stencil surface, both stencil and depth 199 * or only one of them if this is a combined depth-stencil surface. 200 * 201 * These states must be saved in the blitter in addition to the state objects 202 * already required to be saved: 203 * - framebuffer state 204 */ 205void util_blitter_clear_depth_stencil(struct blitter_context *blitter, 206 struct pipe_surface *dst, 207 unsigned clear_flags, 208 double depth, 209 unsigned stencil, 210 unsigned dstx, unsigned dsty, 211 unsigned width, unsigned height); 212 213void util_blitter_custom_depth_stencil(struct blitter_context *blitter, 214 struct pipe_surface *zsurf, 215 struct pipe_surface *cbsurf, 216 void *dsa_stage, float depth); 217 218/* The functions below should be used to save currently bound constant state 219 * objects inside a driver. The objects are automatically restored at the end 220 * of the util_blitter_{clear, copy_region, fill_region} functions and then 221 * forgotten. 222 * 223 * CSOs not listed here are not affected by util_blitter. */ 224 225static INLINE 226void util_blitter_save_blend(struct blitter_context *blitter, 227 void *state) 228{ 229 blitter->saved_blend_state = state; 230} 231 232static INLINE 233void util_blitter_save_depth_stencil_alpha(struct blitter_context *blitter, 234 void *state) 235{ 236 blitter->saved_dsa_state = state; 237} 238 239static INLINE 240void util_blitter_save_vertex_elements(struct blitter_context *blitter, 241 void *state) 242{ 243 blitter->saved_velem_state = state; 244} 245 246static INLINE 247void util_blitter_save_stencil_ref(struct blitter_context *blitter, 248 const struct pipe_stencil_ref *state) 249{ 250 blitter->saved_stencil_ref = *state; 251} 252 253static INLINE 254void util_blitter_save_rasterizer(struct blitter_context *blitter, 255 void *state) 256{ 257 blitter->saved_rs_state = state; 258} 259 260static INLINE 261void util_blitter_save_fragment_shader(struct blitter_context *blitter, 262 void *fs) 263{ 264 blitter->saved_fs = fs; 265} 266 267static INLINE 268void util_blitter_save_vertex_shader(struct blitter_context *blitter, 269 void *vs) 270{ 271 blitter->saved_vs = vs; 272} 273 274static INLINE 275void util_blitter_save_framebuffer(struct blitter_context *blitter, 276 const struct pipe_framebuffer_state *state) 277{ 278 blitter->saved_fb_state.nr_cbufs = 0; /* It's ~0 now, meaning it's unsaved. */ 279 util_copy_framebuffer_state(&blitter->saved_fb_state, state); 280} 281 282static INLINE 283void util_blitter_save_viewport(struct blitter_context *blitter, 284 struct pipe_viewport_state *state) 285{ 286 blitter->saved_viewport = *state; 287} 288 289static INLINE 290void util_blitter_save_clip(struct blitter_context *blitter, 291 struct pipe_clip_state *state) 292{ 293 blitter->saved_clip = *state; 294} 295 296static INLINE 297void util_blitter_save_fragment_sampler_states( 298 struct blitter_context *blitter, 299 int num_sampler_states, 300 void **sampler_states) 301{ 302 assert(num_sampler_states <= Elements(blitter->saved_sampler_states)); 303 304 blitter->saved_num_sampler_states = num_sampler_states; 305 memcpy(blitter->saved_sampler_states, sampler_states, 306 num_sampler_states * sizeof(void *)); 307} 308 309static INLINE void 310util_blitter_save_fragment_sampler_views(struct blitter_context *blitter, 311 int num_views, 312 struct pipe_sampler_view **views) 313{ 314 unsigned i; 315 assert(num_views <= Elements(blitter->saved_sampler_views)); 316 317 blitter->saved_num_sampler_views = num_views; 318 for (i = 0; i < num_views; i++) 319 pipe_sampler_view_reference(&blitter->saved_sampler_views[i], 320 views[i]); 321} 322 323static INLINE void 324util_blitter_save_vertex_buffers(struct blitter_context *blitter, 325 int num_vertex_buffers, 326 struct pipe_vertex_buffer *vertex_buffers) 327{ 328 assert(num_vertex_buffers <= Elements(blitter->saved_vertex_buffers)); 329 330 blitter->saved_num_vertex_buffers = 0; 331 util_copy_vertex_buffers(blitter->saved_vertex_buffers, 332 (unsigned*)&blitter->saved_num_vertex_buffers, 333 vertex_buffers, 334 num_vertex_buffers); 335} 336 337#ifdef __cplusplus 338} 339#endif 340 341#endif 342