p_state.h revision bdbe77f9c6f06cfaa155f27c2ade3c523d7fbea7
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 6 58#define PIPE_MAX_COLOR_BUFS 8 59#define PIPE_MAX_CONSTANT_BUFFERS 32 60#define PIPE_MAX_SAMPLERS 16 61#define PIPE_MAX_VERTEX_SAMPLERS 16 62#define PIPE_MAX_GEOMETRY_SAMPLERS 16 63#define PIPE_MAX_SHADER_INPUTS 32 64#define PIPE_MAX_SHADER_OUTPUTS 32 65#define PIPE_MAX_SHADER_RESOURCES 32 66#define PIPE_MAX_TEXTURE_LEVELS 16 67#define PIPE_MAX_SO_BUFFERS 4 68 69 70struct pipe_reference 71{ 72 int32_t count; /* atomic */ 73}; 74 75 76 77/** 78 * Primitive (point/line/tri) rasterization info 79 */ 80struct pipe_rasterizer_state 81{ 82 unsigned flatshade:1; 83 unsigned light_twoside:1; 84 unsigned front_ccw:1; 85 unsigned cull_face:2; /**< PIPE_FACE_x */ 86 unsigned fill_front:2; /**< PIPE_POLYGON_MODE_x */ 87 unsigned fill_back:2; /**< PIPE_POLYGON_MODE_x */ 88 unsigned offset_point:1; 89 unsigned offset_line:1; 90 unsigned offset_tri:1; 91 unsigned scissor:1; 92 unsigned poly_smooth:1; 93 unsigned poly_stipple_enable:1; 94 unsigned point_smooth:1; 95 unsigned sprite_coord_enable:PIPE_MAX_SHADER_OUTPUTS; 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_stipple_factor:8; /**< [1..256] actually */ 103 unsigned line_stipple_pattern:16; 104 unsigned line_last_pixel:1; 105 106 /** 107 * Use the first vertex of a primitive as the provoking vertex for 108 * flat shading. 109 */ 110 unsigned flatshade_first:1; 111 112 /** 113 * When true, triangle rasterization uses (0.5, 0.5) pixel centers 114 * for determining pixel ownership. 115 * 116 * When false, triangle rasterization uses (0,0) pixel centers for 117 * determining pixel ownership. 118 * 119 * Triangle rasterization always uses a 'top,left' rule for pixel 120 * ownership, this just alters which point we consider the pixel 121 * center for that test. 122 */ 123 unsigned gl_rasterization_rules:1; 124 125 float line_width; 126 float point_size; /**< used when no per-vertex size */ 127 float offset_units; 128 float offset_scale; 129}; 130 131 132struct pipe_poly_stipple 133{ 134 unsigned stipple[32]; 135}; 136 137 138struct pipe_viewport_state 139{ 140 float scale[4]; 141 float translate[4]; 142}; 143 144 145struct pipe_scissor_state 146{ 147 unsigned minx:16; 148 unsigned miny:16; 149 unsigned maxx:16; 150 unsigned maxy:16; 151}; 152 153 154struct pipe_clip_state 155{ 156 float ucp[PIPE_MAX_CLIP_PLANES][4]; 157 unsigned nr; 158 unsigned depth_clamp:1; 159}; 160 161 162struct pipe_shader_state 163{ 164 const struct tgsi_token *tokens; 165}; 166 167 168struct pipe_depth_state 169{ 170 unsigned enabled:1; /**< depth test enabled? */ 171 unsigned writemask:1; /**< allow depth buffer writes? */ 172 unsigned func:3; /**< depth test func (PIPE_FUNC_x) */ 173}; 174 175 176struct pipe_stencil_state 177{ 178 unsigned enabled:1; /**< stencil[0]: stencil enabled, stencil[1]: two-side enabled */ 179 unsigned func:3; /**< PIPE_FUNC_x */ 180 unsigned fail_op:3; /**< PIPE_STENCIL_OP_x */ 181 unsigned zpass_op:3; /**< PIPE_STENCIL_OP_x */ 182 unsigned zfail_op:3; /**< PIPE_STENCIL_OP_x */ 183 unsigned valuemask:8; 184 unsigned writemask:8; 185}; 186 187 188struct pipe_alpha_state 189{ 190 unsigned enabled:1; 191 unsigned func:3; /**< PIPE_FUNC_x */ 192 float ref_value; /**< reference value */ 193}; 194 195 196struct pipe_depth_stencil_alpha_state 197{ 198 struct pipe_depth_state depth; 199 struct pipe_stencil_state stencil[2]; /**< [0] = front, [1] = back */ 200 struct pipe_alpha_state alpha; 201}; 202 203 204struct pipe_rt_blend_state 205{ 206 unsigned blend_enable:1; 207 208 unsigned rgb_func:3; /**< PIPE_BLEND_x */ 209 unsigned rgb_src_factor:5; /**< PIPE_BLENDFACTOR_x */ 210 unsigned rgb_dst_factor:5; /**< PIPE_BLENDFACTOR_x */ 211 212 unsigned alpha_func:3; /**< PIPE_BLEND_x */ 213 unsigned alpha_src_factor:5; /**< PIPE_BLENDFACTOR_x */ 214 unsigned alpha_dst_factor:5; /**< PIPE_BLENDFACTOR_x */ 215 216 unsigned colormask:4; /**< bitmask of PIPE_MASK_R/G/B/A */ 217}; 218 219struct pipe_blend_state 220{ 221 unsigned independent_blend_enable:1; 222 unsigned logicop_enable:1; 223 unsigned logicop_func:4; /**< PIPE_LOGICOP_x */ 224 unsigned dither:1; 225 unsigned alpha_to_coverage:1; 226 unsigned alpha_to_one:1; 227 struct pipe_rt_blend_state rt[PIPE_MAX_COLOR_BUFS]; 228}; 229 230 231struct pipe_blend_color 232{ 233 float color[4]; 234}; 235 236struct pipe_stencil_ref 237{ 238 ubyte ref_value[2]; 239}; 240 241struct pipe_framebuffer_state 242{ 243 unsigned width, height; 244 245 /** multiple color buffers for multiple render targets */ 246 unsigned nr_cbufs; 247 struct pipe_surface *cbufs[PIPE_MAX_COLOR_BUFS]; 248 249 struct pipe_surface *zsbuf; /**< Z/stencil buffer */ 250}; 251 252 253/** 254 * Texture sampler state. 255 */ 256struct pipe_sampler_state 257{ 258 unsigned wrap_s:3; /**< PIPE_TEX_WRAP_x */ 259 unsigned wrap_t:3; /**< PIPE_TEX_WRAP_x */ 260 unsigned wrap_r:3; /**< PIPE_TEX_WRAP_x */ 261 unsigned min_img_filter:2; /**< PIPE_TEX_FILTER_x */ 262 unsigned min_mip_filter:2; /**< PIPE_TEX_MIPFILTER_x */ 263 unsigned mag_img_filter:2; /**< PIPE_TEX_FILTER_x */ 264 unsigned compare_mode:1; /**< PIPE_TEX_COMPARE_x */ 265 unsigned compare_func:3; /**< PIPE_FUNC_x */ 266 unsigned normalized_coords:1; /**< Are coords normalized to [0,1]? */ 267 unsigned max_anisotropy:6; 268 float lod_bias; /**< LOD/lambda bias */ 269 float min_lod, max_lod; /**< LOD clamp range, after bias */ 270 float border_color[4]; 271}; 272 273 274/** 275 * A view into a texture that can be bound to a color render target / 276 * depth stencil attachment point. 277 */ 278struct pipe_surface 279{ 280 struct pipe_reference reference; 281 struct pipe_resource *texture; /**< resource into which this is a view */ 282 struct pipe_context *context; /**< context this view belongs to */ 283 enum pipe_format format; 284 285 /* XXX width/height should be removed */ 286 unsigned width; /**< logical width in pixels */ 287 unsigned height; /**< logical height in pixels */ 288 289 unsigned usage; /**< bitmask of PIPE_BIND_x */ 290 291 union { 292 struct { 293 unsigned level; 294 unsigned first_layer:16; 295 unsigned last_layer:16; 296 } tex; 297 struct { 298 unsigned first_element; 299 unsigned last_element; 300 } buf; 301 } u; 302}; 303 304 305/** 306 * A view into a texture that can be bound to a shader stage. 307 */ 308struct pipe_sampler_view 309{ 310 struct pipe_reference reference; 311 enum pipe_format format; /**< typed PIPE_FORMAT_x */ 312 struct pipe_resource *texture; /**< texture into which this is a view */ 313 struct pipe_context *context; /**< context this view belongs to */ 314 union { 315 struct { 316 unsigned first_layer:16; /**< first layer to use for array textures */ 317 unsigned last_layer:16; /**< last layer to use for array textures */ 318 unsigned first_level:8; /**< first mipmap level to use */ 319 unsigned last_level:8; /**< last mipmap level to use */ 320 } tex; 321 struct { 322 unsigned first_element; 323 unsigned last_element; 324 } buf; 325 } u; 326 unsigned swizzle_r:3; /**< PIPE_SWIZZLE_x for red component */ 327 unsigned swizzle_g:3; /**< PIPE_SWIZZLE_x for green component */ 328 unsigned swizzle_b:3; /**< PIPE_SWIZZLE_x for blue component */ 329 unsigned swizzle_a:3; /**< PIPE_SWIZZLE_x for alpha component */ 330}; 331 332 333/** 334 * Subregion of 1D/2D/3D image resource. 335 */ 336struct pipe_box 337{ 338 unsigned x; 339 unsigned y; 340 unsigned z; 341 unsigned width; 342 unsigned height; 343 unsigned depth; 344}; 345 346 347/** 348 * A memory object/resource such as a vertex buffer or texture. 349 */ 350struct pipe_resource 351{ 352 struct pipe_reference reference; 353 struct pipe_screen *screen; /**< screen that this texture belongs to */ 354 enum pipe_texture_target target; /**< PIPE_TEXTURE_x */ 355 enum pipe_format format; /**< PIPE_FORMAT_x */ 356 357 unsigned width0; 358 unsigned height0; 359 unsigned depth0; 360 unsigned array_size; 361 362 unsigned last_level:8; /**< Index of last mipmap level present/defined */ 363 unsigned nr_samples:8; /**< for multisampled surfaces, nr of samples */ 364 unsigned usage:8; /**< PIPE_USAGE_x (not a bitmask) */ 365 366 unsigned bind; /**< bitmask of PIPE_BIND_x */ 367 unsigned flags; /**< bitmask of PIPE_RESOURCE_FLAG_x */ 368}; 369 370struct pipe_stream_output_state 371{ 372 /**< number of the output buffer to insert each element into */ 373 int output_buffer[PIPE_MAX_SHADER_OUTPUTS]; 374 /**< which register to grab each output from */ 375 int register_index[PIPE_MAX_SHADER_OUTPUTS]; 376 /**< TGSI_WRITEMASK signifying which components to output */ 377 ubyte register_mask[PIPE_MAX_SHADER_OUTPUTS]; 378 /**< number of outputs */ 379 int num_outputs; 380 381 /**< stride for an entire vertex, only used if all output_buffers 382 * are 0 */ 383 unsigned stride; 384}; 385 386 387/** 388 * Transfer object. For data transfer to/from a resource. 389 */ 390struct pipe_transfer 391{ 392 struct pipe_resource *resource; /**< resource to transfer to/from */ 393 unsigned level; 394 enum pipe_transfer_usage usage; 395 struct pipe_box box; 396 unsigned stride; 397 unsigned layer_stride; 398 void *data; 399}; 400 401 402 403/** 404 * A vertex buffer. Typically, all the vertex data/attributes for 405 * drawing something will be in one buffer. But it's also possible, for 406 * example, to put colors in one buffer and texcoords in another. 407 */ 408struct pipe_vertex_buffer 409{ 410 unsigned stride; /**< stride to same attrib in next vertex, in bytes */ 411 unsigned max_index; /**< number of vertices in this buffer */ 412 unsigned buffer_offset; /**< offset to start of data in buffer, in bytes */ 413 struct pipe_resource *buffer; /**< the actual buffer */ 414}; 415 416 417/** 418 * Information to describe a vertex attribute (position, color, etc) 419 */ 420struct pipe_vertex_element 421{ 422 /** Offset of this attribute, in bytes, from the start of the vertex */ 423 unsigned src_offset; 424 425 /** Instance data rate divisor. 0 means this is per-vertex data, 426 * n means per-instance data used for n consecutive instances (n > 0). 427 */ 428 unsigned instance_divisor; 429 430 /** Which vertex_buffer (as given to pipe->set_vertex_buffer()) does 431 * this attribute live in? 432 */ 433 unsigned vertex_buffer_index; 434 435 enum pipe_format src_format; 436}; 437 438 439/** 440 * An index buffer. When an index buffer is bound, all indices to vertices 441 * will be looked up in the buffer. 442 */ 443struct pipe_index_buffer 444{ 445 unsigned index_size; /**< size of an index, in bytes */ 446 unsigned offset; /**< offset to start of data in buffer, in bytes */ 447 struct pipe_resource *buffer; /**< the actual buffer */ 448}; 449 450 451/** 452 * Information to describe a draw_vbo call. 453 */ 454struct pipe_draw_info 455{ 456 boolean indexed; /**< use index buffer */ 457 458 unsigned mode; /**< the mode of the primitive */ 459 unsigned start; /**< the index of the first vertex */ 460 unsigned count; /**< number of vertices */ 461 462 unsigned start_instance; /**< first instance id */ 463 unsigned instance_count; /**< number of instances */ 464 465 /** 466 * For indexed drawing, these fields apply after index lookup. 467 */ 468 int index_bias; /**< a bias to be added to each index */ 469 unsigned min_index; /**< the min index */ 470 unsigned max_index; /**< the max index */ 471 472 /** 473 * Primitive restart enable/index (only applies to indexed drawing) 474 */ 475 boolean primitive_restart; 476 unsigned restart_index; 477}; 478 479 480#ifdef __cplusplus 481} 482#endif 483 484#endif 485