1 /************************************************************************** 2 * 3 * Copyright 2007 VMware, Inc. 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 VMWARE 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 29 /** 30 * @file 31 * 32 * Abstract graphics pipe state objects. 33 * 34 * Basic notes: 35 * 1. Want compact representations, so we use bitfields. 36 * 2. Put bitfields before other (GLfloat) fields. 37 */ 38 39 40 #ifndef PIPE_STATE_H 41 #define PIPE_STATE_H 42 43 #include "p_compiler.h" 44 #include "p_defines.h" 45 #include "p_format.h" 46 47 48 #ifdef __cplusplus 49 extern "C" { 50 #endif 51 52 53 /** 54 * Implementation limits 55 */ 56 #define PIPE_MAX_ATTRIBS 32 57 #define PIPE_MAX_CLIP_PLANES 8 58 #define PIPE_MAX_COLOR_BUFS 8 59 #define PIPE_MAX_CONSTANT_BUFFERS 32 60 #define PIPE_MAX_SAMPLERS 16 61 #define PIPE_MAX_SHADER_INPUTS 80 /* 32 GENERIC + 32 PATCH + 16 others */ 62 #define PIPE_MAX_SHADER_OUTPUTS 80 /* 32 GENERIC + 32 PATCH + 16 others */ 63 #define PIPE_MAX_SHADER_SAMPLER_VIEWS 32 64 #define PIPE_MAX_SHADER_BUFFERS 32 65 #define PIPE_MAX_SHADER_IMAGES 32 66 #define PIPE_MAX_TEXTURE_LEVELS 16 67 #define PIPE_MAX_SO_BUFFERS 4 68 #define PIPE_MAX_SO_OUTPUTS 64 69 #define PIPE_MAX_VIEWPORTS 16 70 #define PIPE_MAX_CLIP_OR_CULL_DISTANCE_COUNT 8 71 #define PIPE_MAX_CLIP_OR_CULL_DISTANCE_ELEMENT_COUNT 2 72 #define PIPE_MAX_HW_ATOMIC_BUFFERS 32 73 74 struct pipe_reference 75 { 76 int32_t count; /* atomic */ 77 }; 78 79 80 81 /** 82 * Primitive (point/line/tri) rasterization info 83 */ 84 struct pipe_rasterizer_state 85 { 86 unsigned flatshade:1; 87 unsigned light_twoside:1; 88 unsigned clamp_vertex_color:1; 89 unsigned clamp_fragment_color:1; 90 unsigned front_ccw:1; 91 unsigned cull_face:2; /**< PIPE_FACE_x */ 92 unsigned fill_front:2; /**< PIPE_POLYGON_MODE_x */ 93 unsigned fill_back:2; /**< PIPE_POLYGON_MODE_x */ 94 unsigned offset_point:1; 95 unsigned offset_line:1; 96 unsigned offset_tri:1; 97 unsigned scissor:1; 98 unsigned poly_smooth:1; 99 unsigned poly_stipple_enable:1; 100 unsigned point_smooth:1; 101 unsigned sprite_coord_mode:1; /**< PIPE_SPRITE_COORD_ */ 102 unsigned point_quad_rasterization:1; /** points rasterized as quads or points */ 103 unsigned point_tri_clip:1; /** large points clipped as tris or points */ 104 unsigned point_size_per_vertex:1; /**< size computed in vertex shader */ 105 unsigned multisample:1; /* XXX maybe more ms state in future */ 106 unsigned force_persample_interp:1; 107 unsigned line_smooth:1; 108 unsigned line_stipple_enable:1; 109 unsigned line_last_pixel:1; 110 111 /** 112 * Use the first vertex of a primitive as the provoking vertex for 113 * flat shading. 114 */ 115 unsigned flatshade_first:1; 116 117 unsigned half_pixel_center:1; 118 unsigned bottom_edge_rule:1; 119 120 /** 121 * When true, rasterization is disabled and no pixels are written. 122 * This only makes sense with the Stream Out functionality. 123 */ 124 unsigned rasterizer_discard:1; 125 126 /** 127 * When false, depth clipping is disabled and the depth value will be 128 * clamped later at the per-pixel level before depth testing. 129 * This depends on PIPE_CAP_DEPTH_CLIP_DISABLE. 130 */ 131 unsigned depth_clip:1; 132 133 /** 134 * When true clip space in the z axis goes from [0..1] (D3D). When false 135 * [-1, 1] (GL). 136 * 137 * NOTE: D3D will always use depth clamping. 138 */ 139 unsigned clip_halfz:1; 140 141 /** 142 * Enable bits for clipping half-spaces. 143 * This applies to both user clip planes and shader clip distances. 144 * Note that if the bound shader exports any clip distances, these 145 * replace all user clip planes, and clip half-spaces enabled here 146 * but not written by the shader count as disabled. 147 */ 148 unsigned clip_plane_enable:PIPE_MAX_CLIP_PLANES; 149 150 unsigned line_stipple_factor:8; /**< [1..256] actually */ 151 unsigned line_stipple_pattern:16; 152 153 uint32_t sprite_coord_enable; /* referring to 32 TEXCOORD/GENERIC inputs */ 154 155 float line_width; 156 float point_size; /**< used when no per-vertex size */ 157 float offset_units; 158 float offset_scale; 159 float offset_clamp; 160 }; 161 162 163 struct pipe_poly_stipple 164 { 165 unsigned stipple[32]; 166 }; 167 168 169 struct pipe_viewport_state 170 { 171 float scale[3]; 172 float translate[3]; 173 }; 174 175 176 struct pipe_scissor_state 177 { 178 unsigned minx:16; 179 unsigned miny:16; 180 unsigned maxx:16; 181 unsigned maxy:16; 182 }; 183 184 185 struct pipe_clip_state 186 { 187 float ucp[PIPE_MAX_CLIP_PLANES][4]; 188 }; 189 190 191 /** 192 * Stream output for vertex transform feedback. 193 */ 194 struct pipe_stream_output_info 195 { 196 unsigned num_outputs; 197 /** stride for an entire vertex for each buffer in dwords */ 198 unsigned stride[PIPE_MAX_SO_BUFFERS]; 199 200 /** 201 * Array of stream outputs, in the order they are to be written in. 202 * Selected components are tightly packed into the output buffer. 203 */ 204 struct { 205 unsigned register_index:8; /**< 0 to PIPE_MAX_SHADER_OUTPUTS */ 206 unsigned start_component:2; /** 0 to 3 */ 207 unsigned num_components:3; /** 1 to 4 */ 208 unsigned output_buffer:3; /**< 0 to PIPE_MAX_SO_BUFFERS */ 209 unsigned dst_offset:16; /**< offset into the buffer in dwords */ 210 unsigned stream:2; 211 unsigned need_temp:1; 212 } output[PIPE_MAX_SO_OUTPUTS]; 213 }; 214 215 216 struct pipe_shader_state 217 { 218 const struct tgsi_token *tokens; 219 struct pipe_stream_output_info stream_output; 220 }; 221 222 223 struct pipe_depth_state 224 { 225 unsigned enabled:1; /**< depth test enabled? */ 226 unsigned writemask:1; /**< allow depth buffer writes? */ 227 unsigned func:3; /**< depth test func (PIPE_FUNC_x) */ 228 }; 229 230 231 struct pipe_stencil_state 232 { 233 unsigned enabled:1; /**< stencil[0]: stencil enabled, stencil[1]: two-side enabled */ 234 unsigned func:3; /**< PIPE_FUNC_x */ 235 unsigned fail_op:3; /**< PIPE_STENCIL_OP_x */ 236 unsigned zpass_op:3; /**< PIPE_STENCIL_OP_x */ 237 unsigned zfail_op:3; /**< PIPE_STENCIL_OP_x */ 238 unsigned valuemask:8; 239 unsigned writemask:8; 240 }; 241 242 243 struct pipe_alpha_state 244 { 245 unsigned enabled:1; 246 unsigned func:3; /**< PIPE_FUNC_x */ 247 float ref_value; /**< reference value */ 248 }; 249 250 251 struct pipe_depth_stencil_alpha_state 252 { 253 struct pipe_depth_state depth; 254 struct pipe_stencil_state stencil[2]; /**< [0] = front, [1] = back */ 255 struct pipe_alpha_state alpha; 256 }; 257 258 259 struct pipe_rt_blend_state 260 { 261 unsigned blend_enable:1; 262 263 unsigned rgb_func:3; /**< PIPE_BLEND_x */ 264 unsigned rgb_src_factor:5; /**< PIPE_BLENDFACTOR_x */ 265 unsigned rgb_dst_factor:5; /**< PIPE_BLENDFACTOR_x */ 266 267 unsigned alpha_func:3; /**< PIPE_BLEND_x */ 268 unsigned alpha_src_factor:5; /**< PIPE_BLENDFACTOR_x */ 269 unsigned alpha_dst_factor:5; /**< PIPE_BLENDFACTOR_x */ 270 271 unsigned colormask:4; /**< bitmask of PIPE_MASK_R/G/B/A */ 272 }; 273 274 struct pipe_blend_state 275 { 276 unsigned independent_blend_enable:1; 277 unsigned logicop_enable:1; 278 unsigned logicop_func:4; /**< PIPE_LOGICOP_x */ 279 unsigned dither:1; 280 unsigned alpha_to_coverage:1; 281 unsigned alpha_to_one:1; 282 struct pipe_rt_blend_state rt[PIPE_MAX_COLOR_BUFS]; 283 }; 284 285 286 struct pipe_blend_color 287 { 288 float color[4]; 289 }; 290 291 struct pipe_stencil_ref 292 { 293 ubyte ref_value[2]; 294 }; 295 296 struct pipe_framebuffer_state 297 { 298 unsigned width, height; 299 300 /** multiple color buffers for multiple render targets */ 301 unsigned nr_cbufs; 302 struct pipe_surface *cbufs[PIPE_MAX_COLOR_BUFS]; 303 304 struct pipe_surface *zsbuf; /**< Z/stencil buffer */ 305 }; 306 307 308 /** 309 * Texture sampler state. 310 */ 311 struct pipe_sampler_state 312 { 313 unsigned wrap_s:3; /**< PIPE_TEX_WRAP_x */ 314 unsigned wrap_t:3; /**< PIPE_TEX_WRAP_x */ 315 unsigned wrap_r:3; /**< PIPE_TEX_WRAP_x */ 316 unsigned min_img_filter:2; /**< PIPE_TEX_FILTER_x */ 317 unsigned min_mip_filter:2; /**< PIPE_TEX_MIPFILTER_x */ 318 unsigned mag_img_filter:2; /**< PIPE_TEX_FILTER_x */ 319 unsigned compare_mode:1; /**< PIPE_TEX_COMPARE_x */ 320 unsigned compare_func:3; /**< PIPE_FUNC_x */ 321 unsigned normalized_coords:1; /**< Are coords normalized to [0,1]? */ 322 unsigned max_anisotropy:6; 323 unsigned seamless_cube_map:1; 324 float lod_bias; /**< LOD/lambda bias */ 325 float min_lod, max_lod; /**< LOD clamp range, after bias */ 326 union pipe_color_union border_color; 327 }; 328 329 330 /** 331 * A view into a texture that can be bound to a color render target / 332 * depth stencil attachment point. 333 */ 334 struct pipe_surface 335 { 336 struct pipe_reference reference; 337 struct pipe_resource *texture; /**< resource into which this is a view */ 338 struct pipe_context *context; /**< context this surface belongs to */ 339 enum pipe_format format; 340 341 /* XXX width/height should be removed */ 342 unsigned width; /**< logical width in pixels */ 343 unsigned height; /**< logical height in pixels */ 344 345 unsigned writable:1; /**< writable shader resource */ 346 347 union { 348 struct { 349 unsigned level; 350 unsigned first_layer:16; 351 unsigned last_layer:16; 352 } tex; 353 struct { 354 unsigned first_element; 355 unsigned last_element; 356 } buf; 357 } u; 358 }; 359 360 361 /** 362 * A view into a texture that can be bound to a shader stage. 363 */ 364 struct pipe_sampler_view 365 { 366 struct pipe_reference reference; 367 enum pipe_format format; /**< typed PIPE_FORMAT_x */ 368 struct pipe_resource *texture; /**< texture into which this is a view */ 369 struct pipe_context *context; /**< context this view belongs to */ 370 union { 371 struct { 372 unsigned first_layer:16; /**< first layer to use for array textures */ 373 unsigned last_layer:16; /**< last layer to use for array textures */ 374 unsigned first_level:8; /**< first mipmap level to use */ 375 unsigned last_level:8; /**< last mipmap level to use */ 376 } tex; 377 struct { 378 unsigned first_element; 379 unsigned last_element; 380 } buf; 381 } u; 382 unsigned swizzle_r:3; /**< PIPE_SWIZZLE_x for red component */ 383 unsigned swizzle_g:3; /**< PIPE_SWIZZLE_x for green component */ 384 unsigned swizzle_b:3; /**< PIPE_SWIZZLE_x for blue component */ 385 unsigned swizzle_a:3; /**< PIPE_SWIZZLE_x for alpha component */ 386 }; 387 388 389 /** 390 * Subregion of 1D/2D/3D image resource. 391 */ 392 struct pipe_box 393 { 394 int x; 395 int y; 396 int z; 397 int width; 398 int height; 399 int depth; 400 }; 401 402 403 /** 404 * A memory object/resource such as a vertex buffer or texture. 405 */ 406 struct pipe_resource 407 { 408 struct pipe_reference reference; 409 struct pipe_screen *screen; /**< screen that this texture belongs to */ 410 enum pipe_texture_target target; /**< PIPE_TEXTURE_x */ 411 enum pipe_format format; /**< PIPE_FORMAT_x */ 412 413 unsigned width0; 414 unsigned height0; 415 unsigned depth0; 416 unsigned array_size; 417 418 unsigned last_level:8; /**< Index of last mipmap level present/defined */ 419 unsigned nr_samples:8; /**< for multisampled surfaces, nr of samples */ 420 unsigned usage:8; /**< PIPE_USAGE_x (not a bitmask) */ 421 422 unsigned bind; /**< bitmask of PIPE_BIND_x */ 423 unsigned flags; /**< bitmask of PIPE_RESOURCE_FLAG_x */ 424 }; 425 426 427 /** 428 * Transfer object. For data transfer to/from a resource. 429 */ 430 struct pipe_transfer 431 { 432 struct pipe_resource *resource; /**< resource to transfer to/from */ 433 unsigned level; /**< texture mipmap level */ 434 enum pipe_transfer_usage usage; 435 struct pipe_box box; /**< region of the resource to access */ 436 unsigned stride; /**< row stride in bytes */ 437 unsigned layer_stride; /**< image/layer stride in bytes */ 438 }; 439 440 441 442 /** 443 * A vertex buffer. Typically, all the vertex data/attributes for 444 * drawing something will be in one buffer. But it's also possible, for 445 * example, to put colors in one buffer and texcoords in another. 446 */ 447 struct pipe_vertex_buffer 448 { 449 unsigned stride; /**< stride to same attrib in next vertex, in bytes */ 450 unsigned buffer_offset; /**< offset to start of data in buffer, in bytes */ 451 struct pipe_resource *buffer; /**< the actual buffer */ 452 const void *user_buffer; /**< pointer to a user buffer if buffer == NULL */ 453 }; 454 455 456 /** 457 * A constant buffer. A subrange of an existing buffer can be set 458 * as a constant buffer. 459 */ 460 struct pipe_constant_buffer { 461 struct pipe_resource *buffer; /**< the actual buffer */ 462 unsigned buffer_offset; /**< offset to start of data in buffer, in bytes */ 463 unsigned buffer_size; /**< how much data can be read in shader */ 464 const void *user_buffer; /**< pointer to a user buffer if buffer == NULL */ 465 }; 466 467 468 /** 469 * A stream output target. The structure specifies the range vertices can 470 * be written to. 471 * 472 * In addition to that, the structure should internally maintain the offset 473 * into the buffer, which should be incremented everytime something is written 474 * (appended) to it. The internal offset is buffer_offset + how many bytes 475 * have been written. The internal offset can be stored on the device 476 * and the CPU actually doesn't have to query it. 477 * 478 * Note that the buffer_size variable is actually specifying the available 479 * space in the buffer, not the size of the attached buffer. 480 * In other words in majority of cases buffer_size would simply be 481 * 'buffer->width0 - buffer_offset', so buffer_size refers to the size 482 * of the buffer left, after accounting for buffer offset, for stream output 483 * to write to. 484 * 485 * Use PIPE_QUERY_SO_STATISTICS to know how many primitives have 486 * actually been written. 487 */ 488 struct pipe_stream_output_target 489 { 490 struct pipe_reference reference; 491 struct pipe_resource *buffer; /**< the output buffer */ 492 struct pipe_context *context; /**< context this SO target belongs to */ 493 494 unsigned buffer_offset; /**< offset where data should be written, in bytes */ 495 unsigned buffer_size; /**< how much data is allowed to be written */ 496 }; 497 498 499 /** 500 * Information to describe a vertex attribute (position, color, etc) 501 */ 502 struct pipe_vertex_element 503 { 504 /** Offset of this attribute, in bytes, from the start of the vertex */ 505 unsigned src_offset; 506 507 /** Instance data rate divisor. 0 means this is per-vertex data, 508 * n means per-instance data used for n consecutive instances (n > 0). 509 */ 510 unsigned instance_divisor; 511 512 /** Which vertex_buffer (as given to pipe->set_vertex_buffer()) does 513 * this attribute live in? 514 */ 515 unsigned vertex_buffer_index; 516 517 enum pipe_format src_format; 518 }; 519 520 521 /** 522 * An index buffer. When an index buffer is bound, all indices to vertices 523 * will be looked up in the buffer. 524 */ 525 struct pipe_index_buffer 526 { 527 unsigned index_size; /**< size of an index, in bytes */ 528 unsigned offset; /**< offset to start of data in buffer, in bytes */ 529 struct pipe_resource *buffer; /**< the actual buffer */ 530 const void *user_buffer; /**< pointer to a user buffer if buffer == NULL */ 531 }; 532 533 struct pipe_draw_indirect_info 534 { 535 unsigned offset; /**< must be 4 byte aligned */ 536 unsigned stride; /**< must be 4 byte aligned */ 537 unsigned draw_count; /**< number of indirect draws */ 538 unsigned indirect_draw_count_offset; /**< must be 4 byte aligned */ 539 540 /* Indirect draw parameters resource is laid out as follows: 541 * 542 * if using indexed drawing: 543 * struct { 544 * uint32_t count; 545 * uint32_t instance_count; 546 * uint32_t start; 547 * int32_t index_bias; 548 * uint32_t start_instance; 549 * }; 550 * otherwise: 551 * struct { 552 * uint32_t count; 553 * uint32_t instance_count; 554 * uint32_t start; 555 * uint32_t start_instance; 556 * }; 557 */ 558 struct pipe_resource *buffer; 559 560 /* Indirect draw count resource: If not NULL, contains a 32-bit value which 561 * is to be used as the real draw_count. 562 */ 563 struct pipe_resource *indirect_draw_count; 564 }; 565 566 /** 567 * Information to describe a draw_vbo call. 568 */ 569 struct pipe_draw_info 570 { 571 boolean indexed; /**< use index buffer */ 572 ubyte vertices_per_patch; /**< the number of vertices per patch */ 573 574 unsigned mode; /**< the mode of the primitive */ 575 unsigned start; /**< the index of the first vertex */ 576 unsigned count; /**< number of vertices */ 577 578 unsigned start_instance; /**< first instance id */ 579 unsigned instance_count; /**< number of instances */ 580 581 unsigned drawid; /**< id of this draw in a multidraw */ 582 /** 583 * For indexed drawing, these fields apply after index lookup. 584 */ 585 int index_bias; /**< a bias to be added to each index */ 586 unsigned min_index; /**< the min index */ 587 unsigned max_index; /**< the max index */ 588 589 /** 590 * Primitive restart enable/index (only applies to indexed drawing) 591 */ 592 boolean primitive_restart; 593 unsigned restart_index; 594 595 struct pipe_draw_indirect_info indirect; 596 /** 597 * Stream output target. If not NULL, it's used to provide the 'count' 598 * parameter based on the number vertices captured by the stream output 599 * stage. (or generally, based on the number of bytes captured) 600 * 601 * Only 'mode', 'start_instance', and 'instance_count' are taken into 602 * account, all the other variables from pipe_draw_info are ignored. 603 * 604 * 'start' is implicitly 0 and 'count' is set as discussed above. 605 * The draw command is non-indexed. 606 * 607 * Note that this only provides the count. The vertex buffers must 608 * be set via set_vertex_buffers manually. 609 */ 610 struct pipe_stream_output_target *count_from_stream_output; 611 }; 612 613 614 /** 615 * Information to describe a blit call. 616 */ 617 struct pipe_blit_info 618 { 619 struct { 620 struct pipe_resource *resource; 621 unsigned level; 622 struct pipe_box box; /**< negative width, height only legal for src */ 623 /* For pipe_surface-like format casting: */ 624 enum pipe_format format; /**< must be supported for sampling (src) 625 or rendering (dst), ZS is always supported */ 626 } dst, src; 627 628 unsigned mask; /**< bitmask of PIPE_MASK_R/G/B/A/Z/S */ 629 unsigned filter; /**< PIPE_TEX_FILTER_* */ 630 631 boolean scissor_enable; 632 struct pipe_scissor_state scissor; 633 634 boolean render_condition_enable; /**< whether the blit should honor the 635 current render condition */ 636 boolean alpha_blend; /* dst.rgb = src.rgb * src.a + dst.rgb * (1 - src.a) */ 637 }; 638 639 640 /** 641 * Structure used as a header for serialized LLVM programs. 642 */ 643 struct pipe_llvm_program_header 644 { 645 uint32_t num_bytes; /**< Number of bytes in the LLVM bytecode program. */ 646 }; 647 648 struct pipe_compute_state 649 { 650 const void *prog; /**< Compute program to be executed. */ 651 unsigned req_local_mem; /**< Required size of the LOCAL resource. */ 652 unsigned req_private_mem; /**< Required size of the PRIVATE resource. */ 653 unsigned req_input_mem; /**< Required size of the INPUT resource. */ 654 }; 655 656 #ifdef __cplusplus 657 } 658 #endif 659 660 #endif 661