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