p_context.h revision 9a966b93c03aecac8eb72e6133aa9a2f2c7673f3
1/************************************************************************** 2 * 3 * Copyright 2007 Tungsten Graphics, Inc., Cedar Park, Texas. 4 * All Rights Reserved. 5 * 6 * Permission is hereby granted, free of charge, to any person obtaining a 7 * copy of this software and associated documentation files (the 8 * "Software"), to deal in the Software without restriction, including 9 * without limitation the rights to use, copy, modify, merge, publish, 10 * distribute, sub license, and/or sell copies of the Software, and to 11 * permit persons to whom the Software is furnished to do so, subject to 12 * the following conditions: 13 * 14 * The above copyright notice and this permission notice (including the 15 * next paragraph) shall be included in all copies or substantial portions 16 * of the Software. 17 * 18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS 19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 20 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. 21 * IN NO EVENT SHALL TUNGSTEN GRAPHICS AND/OR ITS SUPPLIERS BE LIABLE FOR 22 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, 23 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 24 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 25 * 26 **************************************************************************/ 27 28#ifndef PIPE_CONTEXT_H 29#define PIPE_CONTEXT_H 30 31#include "p_state.h" 32 33 34#ifdef __cplusplus 35extern "C" { 36#endif 37 38 39struct pipe_screen; 40struct pipe_fence_handle; 41struct pipe_state_cache; 42struct pipe_query; 43struct pipe_winsys; 44 45/** 46 * Gallium rendering context. Basically: 47 * - state setting functions 48 * - VBO drawing functions 49 * - surface functions 50 */ 51struct pipe_context { 52 struct pipe_winsys *winsys; 53 struct pipe_screen *screen; 54 55 void *priv; /**< context private data (for DRI for example) */ 56 void *draw; /**< private, for draw module (temporary?) */ 57 58 void (*destroy)( struct pipe_context * ); 59 60 /** 61 * VBO drawing 62 */ 63 /*@{*/ 64 void (*draw_arrays)( struct pipe_context *pipe, 65 unsigned mode, unsigned start, unsigned count); 66 67 void (*draw_elements)( struct pipe_context *pipe, 68 struct pipe_resource *indexBuffer, 69 unsigned indexSize, 70 int indexBias, 71 unsigned mode, unsigned start, unsigned count); 72 73 void (*draw_arrays_instanced)(struct pipe_context *pipe, 74 unsigned mode, 75 unsigned start, 76 unsigned count, 77 unsigned startInstance, 78 unsigned instanceCount); 79 80 void (*draw_elements_instanced)(struct pipe_context *pipe, 81 struct pipe_resource *indexBuffer, 82 unsigned indexSize, 83 int indexBias, 84 unsigned mode, 85 unsigned start, 86 unsigned count, 87 unsigned startInstance, 88 unsigned instanceCount); 89 90 /* XXX: this is (probably) a temporary entrypoint, as the range 91 * information should be available from the vertex_buffer state. 92 * Using this to quickly evaluate a specialized path in the draw 93 * module. 94 */ 95 void (*draw_range_elements)( struct pipe_context *pipe, 96 struct pipe_resource *indexBuffer, 97 unsigned indexSize, 98 int indexBias, 99 unsigned minIndex, 100 unsigned maxIndex, 101 unsigned mode, 102 unsigned start, 103 unsigned count); 104 /*@}*/ 105 106 /** 107 * Predicate subsequent rendering on occlusion query result 108 * \param query the query predicate, or NULL if no predicate 109 * \param mode one of PIPE_RENDER_COND_x 110 */ 111 void (*render_condition)( struct pipe_context *pipe, 112 struct pipe_query *query, 113 uint mode ); 114 115 /** 116 * Query objects 117 */ 118 /*@{*/ 119 struct pipe_query *(*create_query)( struct pipe_context *pipe, 120 unsigned query_type ); 121 122 void (*destroy_query)(struct pipe_context *pipe, 123 struct pipe_query *q); 124 125 void (*begin_query)(struct pipe_context *pipe, struct pipe_query *q); 126 void (*end_query)(struct pipe_context *pipe, struct pipe_query *q); 127 128 /** 129 * Get results of a query. 130 * \param wait if true, this query will block until the result is ready 131 * \return TRUE if results are ready, FALSE otherwise 132 */ 133 boolean (*get_query_result)(struct pipe_context *pipe, 134 struct pipe_query *q, 135 boolean wait, 136 uint64_t *result); 137 /*@}*/ 138 139 /** 140 * State functions (create/bind/destroy state objects) 141 */ 142 /*@{*/ 143 void * (*create_blend_state)(struct pipe_context *, 144 const struct pipe_blend_state *); 145 void (*bind_blend_state)(struct pipe_context *, void *); 146 void (*delete_blend_state)(struct pipe_context *, void *); 147 148 void * (*create_sampler_state)(struct pipe_context *, 149 const struct pipe_sampler_state *); 150 void (*bind_fragment_sampler_states)(struct pipe_context *, 151 unsigned num_samplers, 152 void **samplers); 153 void (*bind_vertex_sampler_states)(struct pipe_context *, 154 unsigned num_samplers, 155 void **samplers); 156 void (*delete_sampler_state)(struct pipe_context *, void *); 157 158 void * (*create_rasterizer_state)(struct pipe_context *, 159 const struct pipe_rasterizer_state *); 160 void (*bind_rasterizer_state)(struct pipe_context *, void *); 161 void (*delete_rasterizer_state)(struct pipe_context *, void *); 162 163 void * (*create_depth_stencil_alpha_state)(struct pipe_context *, 164 const struct pipe_depth_stencil_alpha_state *); 165 void (*bind_depth_stencil_alpha_state)(struct pipe_context *, void *); 166 void (*delete_depth_stencil_alpha_state)(struct pipe_context *, void *); 167 168 void * (*create_fs_state)(struct pipe_context *, 169 const struct pipe_shader_state *); 170 void (*bind_fs_state)(struct pipe_context *, void *); 171 void (*delete_fs_state)(struct pipe_context *, void *); 172 173 void * (*create_vs_state)(struct pipe_context *, 174 const struct pipe_shader_state *); 175 void (*bind_vs_state)(struct pipe_context *, void *); 176 void (*delete_vs_state)(struct pipe_context *, void *); 177 178 void * (*create_gs_state)(struct pipe_context *, 179 const struct pipe_shader_state *); 180 void (*bind_gs_state)(struct pipe_context *, void *); 181 void (*delete_gs_state)(struct pipe_context *, void *); 182 183 void * (*create_vertex_elements_state)(struct pipe_context *, 184 unsigned num_elements, 185 const struct pipe_vertex_element *); 186 void (*bind_vertex_elements_state)(struct pipe_context *, void *); 187 void (*delete_vertex_elements_state)(struct pipe_context *, void *); 188 189 /*@}*/ 190 191 /** 192 * Parameter-like state (or properties) 193 */ 194 /*@{*/ 195 void (*set_blend_color)( struct pipe_context *, 196 const struct pipe_blend_color * ); 197 198 void (*set_stencil_ref)( struct pipe_context *, 199 const struct pipe_stencil_ref * ); 200 201 void (*set_sample_mask)( struct pipe_context *, 202 unsigned sample_mask ); 203 204 void (*set_clip_state)( struct pipe_context *, 205 const struct pipe_clip_state * ); 206 207 void (*set_constant_buffer)( struct pipe_context *, 208 uint shader, uint index, 209 struct pipe_resource *buf ); 210 211 void (*set_framebuffer_state)( struct pipe_context *, 212 const struct pipe_framebuffer_state * ); 213 214 void (*set_polygon_stipple)( struct pipe_context *, 215 const struct pipe_poly_stipple * ); 216 217 void (*set_scissor_state)( struct pipe_context *, 218 const struct pipe_scissor_state * ); 219 220 void (*set_viewport_state)( struct pipe_context *, 221 const struct pipe_viewport_state * ); 222 223 void (*set_fragment_sampler_views)(struct pipe_context *, 224 unsigned num_views, 225 struct pipe_sampler_view **); 226 227 void (*set_vertex_sampler_views)(struct pipe_context *, 228 unsigned num_views, 229 struct pipe_sampler_view **); 230 231 void (*set_vertex_buffers)( struct pipe_context *, 232 unsigned num_buffers, 233 const struct pipe_vertex_buffer * ); 234 235 /*@}*/ 236 237 238 /** 239 * Resource functions for blit-like functionality 240 * 241 * The pipe driver is allowed to set these functions to NULL, and in that 242 * case, they will not be available. 243 * If a driver supports multisampling, resource_resolve must be available. 244 */ 245 /*@{*/ 246 247 /** 248 * Copy a block of pixels from one resource to another. 249 * The resource must be of the same format. 250 * Resources with nr_samples > 1 are not allowed. 251 */ 252 void (*resource_copy_region)(struct pipe_context *pipe, 253 struct pipe_resource *dst, 254 struct pipe_subresource subdst, 255 unsigned dstx, unsigned dsty, unsigned dstz, 256 struct pipe_resource *src, 257 struct pipe_subresource subsrc, 258 unsigned srcx, unsigned srcy, unsigned srcz, 259 unsigned width, unsigned height); 260 261 /** 262 * Fill a region of a resource with a constant value. 263 * Resources with nr_samples > 1 are not allowed. 264 */ 265 void (*resource_fill_region)(struct pipe_context *pipe, 266 struct pipe_resource *dst, 267 struct pipe_subresource subdst, 268 unsigned dstx, unsigned dsty, unsigned dstz, 269 unsigned width, unsigned height, 270 unsigned value); 271 272 /** 273 * Resolve a multisampled resource into a non-multisampled one. 274 * Source and destination must have the same size and same format. 275 */ 276 void (*resource_resolve)(struct pipe_context *pipe, 277 struct pipe_resource *dst, 278 struct pipe_subresource subdst, 279 struct pipe_resource *src, 280 struct pipe_subresource subsrc); 281 282 /*@}*/ 283 284 /** 285 * Clear the specified set of currently bound buffers to specified values. 286 * The entire buffers are cleared (no scissor, no colormask, etc). 287 * 288 * \param buffers bitfield of PIPE_CLEAR_* values. 289 * \param rgba pointer to an array of one float for each of r, g, b, a. 290 * \param depth depth clear value in [0,1]. 291 * \param stencil stencil clear value 292 */ 293 void (*clear)(struct pipe_context *pipe, 294 unsigned buffers, 295 const float *rgba, 296 double depth, 297 unsigned stencil); 298 299 /** Flush rendering 300 * \param flags bitmask of PIPE_FLUSH_x tokens) 301 */ 302 void (*flush)( struct pipe_context *pipe, 303 unsigned flags, 304 struct pipe_fence_handle **fence ); 305 306 /** 307 * Check whether a texture is referenced by an unflushed hw command. 308 * The state-tracker uses this function to avoid unnecessary flushes. 309 * It is safe (but wasteful) to always return 310 * PIPE_REFERENCED_FOR_READ | PIPE_REFERENCED_FOR_WRITE. 311 * \param pipe context whose unflushed hw commands will be checked. 312 * \param texture texture to check. 313 * \param face cubemap face. Use 0 for non-cubemap texture. 314 * \param level mipmap level. 315 * \return mask of PIPE_REFERENCED_FOR_READ/WRITE or PIPE_UNREFERENCED 316 */ 317 unsigned int (*is_resource_referenced)(struct pipe_context *pipe, 318 struct pipe_resource *texture, 319 unsigned face, unsigned level); 320 321 /** 322 * Create a view on a texture to be used by a shader stage. 323 */ 324 struct pipe_sampler_view * (*create_sampler_view)(struct pipe_context *ctx, 325 struct pipe_resource *texture, 326 const struct pipe_sampler_view *templat); 327 328 void (*sampler_view_destroy)(struct pipe_context *ctx, 329 struct pipe_sampler_view *view); 330 331 332 /** 333 * Get a transfer object for transferring data to/from a texture. 334 * 335 * Transfers are (by default) context-private and allow uploads to be 336 * interleaved with 337 */ 338 struct pipe_transfer *(*get_transfer)(struct pipe_context *, 339 struct pipe_resource *resource, 340 struct pipe_subresource, 341 unsigned usage, /* a combination of PIPE_TRANSFER_x */ 342 const struct pipe_box *); 343 344 void (*transfer_destroy)(struct pipe_context *, 345 struct pipe_transfer *); 346 347 void *(*transfer_map)( struct pipe_context *, 348 struct pipe_transfer *transfer ); 349 350 /* If transfer was created with WRITE|FLUSH_EXPLICIT, only the 351 * regions specified with this call are guaranteed to be written to 352 * the resource. 353 */ 354 void (*transfer_flush_region)( struct pipe_context *, 355 struct pipe_transfer *transfer, 356 const struct pipe_box *); 357 358 void (*transfer_unmap)( struct pipe_context *, 359 struct pipe_transfer *transfer ); 360 361 362 /* One-shot transfer operation with data supplied in a user 363 * pointer. XXX: strides?? 364 */ 365 void (*transfer_inline_write)( struct pipe_context *, 366 struct pipe_resource *, 367 struct pipe_subresource, 368 unsigned usage, /* a combination of PIPE_TRANSFER_x */ 369 const struct pipe_box *, 370 const void *data, 371 unsigned stride, 372 unsigned slice_stride); 373 374}; 375 376 377#ifdef __cplusplus 378} 379#endif 380 381#endif /* PIPE_CONTEXT_H */ 382