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