p_state.h revision aac2cccccfd701ae8d7ce0813c28c64498d4a076
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#include "p_screen.h" 47 48 49#ifdef __cplusplus 50extern "C" { 51#endif 52 53 54/** 55 * Implementation limits 56 */ 57#define PIPE_MAX_ATTRIBS 32 58#define PIPE_MAX_CLIP_PLANES 6 59#define PIPE_MAX_COLOR_BUFS 8 60#define PIPE_MAX_CONSTANT_BUFFERS 32 61#define PIPE_MAX_SAMPLERS 16 62#define PIPE_MAX_VERTEX_SAMPLERS 16 63#define PIPE_MAX_SHADER_INPUTS 16 64#define PIPE_MAX_SHADER_OUTPUTS 16 65#define PIPE_MAX_TEXTURE_LEVELS 16 66 67 68struct pipe_reference 69{ 70 int32_t count; /* atomic */ 71}; 72 73 74 75/** 76 * Primitive (point/line/tri) rasterization info 77 */ 78struct pipe_rasterizer_state 79{ 80 unsigned flatshade:1; 81 unsigned light_twoside:1; 82 unsigned front_winding:2; /**< PIPE_WINDING_x */ 83 unsigned cull_mode:2; /**< PIPE_WINDING_x */ 84 unsigned fill_cw:2; /**< PIPE_POLYGON_MODE_x */ 85 unsigned fill_ccw:2; /**< PIPE_POLYGON_MODE_x */ 86 unsigned offset_cw:1; 87 unsigned offset_ccw:1; 88 unsigned scissor:1; 89 unsigned poly_smooth:1; 90 unsigned poly_stipple_enable:1; 91 unsigned point_smooth:1; 92 unsigned sprite_coord_enable:PIPE_MAX_SHADER_OUTPUTS; 93 unsigned sprite_coord_mode:1; /**< PIPE_SPRITE_COORD_ */ 94 unsigned point_quad_rasterization:1; /** points rasterized as quads or points */ 95 unsigned point_size_per_vertex:1; /**< size computed in vertex shader */ 96 unsigned multisample:1; /* XXX maybe more ms state in future */ 97 unsigned line_smooth:1; 98 unsigned line_stipple_enable:1; 99 unsigned line_stipple_factor:8; /**< [1..256] actually */ 100 unsigned line_stipple_pattern:16; 101 unsigned line_last_pixel:1; 102 103 /** 104 * Use the first vertex of a primitive as the provoking vertex for 105 * flat shading. 106 */ 107 unsigned flatshade_first:1; 108 109 /** 110 * When true, triangle rasterization uses (0.5, 0.5) pixel centers 111 * for determining pixel ownership. 112 * 113 * When false, triangle rasterization uses (0,0) pixel centers for 114 * determining pixel ownership. 115 * 116 * Triangle rasterization always uses a 'top,left' rule for pixel 117 * ownership, this just alters which point we consider the pixel 118 * center for that test. 119 */ 120 unsigned gl_rasterization_rules:1; 121 122 float line_width; 123 float point_size; /**< used when no per-vertex size */ 124 float offset_units; 125 float offset_scale; 126}; 127 128 129struct pipe_poly_stipple 130{ 131 unsigned stipple[32]; 132}; 133 134 135struct pipe_viewport_state 136{ 137 float scale[4]; 138 float translate[4]; 139}; 140 141 142struct pipe_scissor_state 143{ 144 unsigned minx:16; 145 unsigned miny:16; 146 unsigned maxx:16; 147 unsigned maxy:16; 148}; 149 150 151struct pipe_clip_state 152{ 153 float ucp[PIPE_MAX_CLIP_PLANES][4]; 154 unsigned nr; 155}; 156 157 158struct pipe_shader_state 159{ 160 const struct tgsi_token *tokens; 161}; 162 163 164struct pipe_depth_state 165{ 166 unsigned enabled:1; /**< depth test enabled? */ 167 unsigned writemask:1; /**< allow depth buffer writes? */ 168 unsigned func:3; /**< depth test func (PIPE_FUNC_x) */ 169}; 170 171 172struct pipe_stencil_state 173{ 174 unsigned enabled:1; /**< stencil[0]: stencil enabled, stencil[1]: two-side enabled */ 175 unsigned func:3; /**< PIPE_FUNC_x */ 176 unsigned fail_op:3; /**< PIPE_STENCIL_OP_x */ 177 unsigned zpass_op:3; /**< PIPE_STENCIL_OP_x */ 178 unsigned zfail_op:3; /**< PIPE_STENCIL_OP_x */ 179 unsigned valuemask:8; 180 unsigned writemask:8; 181}; 182 183 184struct pipe_alpha_state 185{ 186 unsigned enabled:1; 187 unsigned func:3; /**< PIPE_FUNC_x */ 188 float ref_value; /**< reference value */ 189}; 190 191 192struct pipe_depth_stencil_alpha_state 193{ 194 struct pipe_depth_state depth; 195 struct pipe_stencil_state stencil[2]; /**< [0] = front, [1] = back */ 196 struct pipe_alpha_state alpha; 197}; 198 199 200struct pipe_rt_blend_state 201{ 202 unsigned blend_enable:1; 203 204 unsigned rgb_func:3; /**< PIPE_BLEND_x */ 205 unsigned rgb_src_factor:5; /**< PIPE_BLENDFACTOR_x */ 206 unsigned rgb_dst_factor:5; /**< PIPE_BLENDFACTOR_x */ 207 208 unsigned alpha_func:3; /**< PIPE_BLEND_x */ 209 unsigned alpha_src_factor:5; /**< PIPE_BLENDFACTOR_x */ 210 unsigned alpha_dst_factor:5; /**< PIPE_BLENDFACTOR_x */ 211 212 unsigned colormask:4; /**< bitmask of PIPE_MASK_R/G/B/A */ 213}; 214 215struct pipe_blend_state 216{ 217 unsigned independent_blend_enable:1; 218 unsigned logicop_enable:1; 219 unsigned logicop_func:4; /**< PIPE_LOGICOP_x */ 220 unsigned dither:1; 221 unsigned alpha_to_coverage:1; 222 unsigned alpha_to_one:1; 223 struct pipe_rt_blend_state rt[PIPE_MAX_COLOR_BUFS]; 224}; 225 226 227struct pipe_blend_color 228{ 229 float color[4]; 230}; 231 232struct pipe_stencil_ref 233{ 234 ubyte ref_value[2]; 235}; 236 237struct pipe_framebuffer_state 238{ 239 unsigned width, height; 240 241 /** multiple color buffers for multiple render targets */ 242 unsigned nr_cbufs; 243 struct pipe_surface *cbufs[PIPE_MAX_COLOR_BUFS]; 244 245 struct pipe_surface *zsbuf; /**< Z/stencil buffer */ 246}; 247 248 249/** 250 * Texture sampler state. 251 */ 252struct pipe_sampler_state 253{ 254 unsigned wrap_s:3; /**< PIPE_TEX_WRAP_x */ 255 unsigned wrap_t:3; /**< PIPE_TEX_WRAP_x */ 256 unsigned wrap_r:3; /**< PIPE_TEX_WRAP_x */ 257 unsigned min_img_filter:2; /**< PIPE_TEX_FILTER_x */ 258 unsigned min_mip_filter:2; /**< PIPE_TEX_MIPFILTER_x */ 259 unsigned mag_img_filter:2; /**< PIPE_TEX_FILTER_x */ 260 unsigned compare_mode:1; /**< PIPE_TEX_COMPARE_x */ 261 unsigned compare_func:3; /**< PIPE_FUNC_x */ 262 unsigned normalized_coords:1; /**< Are coords normalized to [0,1]? */ 263 unsigned max_anisotropy:6; 264 float lod_bias; /**< LOD/lambda bias */ 265 float min_lod, max_lod; /**< LOD clamp range, after bias */ 266 float border_color[4]; 267}; 268 269 270/** 271 * 2D surface. This is basically a view into a memory buffer. 272 * May be a renderbuffer, texture mipmap level, etc. 273 */ 274struct pipe_surface 275{ 276 struct pipe_reference reference; 277 struct pipe_resource *texture; /**< resource into which this is a view */ 278 enum pipe_format format; 279 280 unsigned width; /**< logical width in pixels */ 281 unsigned height; /**< logical height in pixels */ 282 283 unsigned layout; /**< PIPE_SURFACE_LAYOUT_x */ 284 unsigned offset; /**< offset from start of buffer, in bytes */ 285 unsigned usage; /**< bitmask of PIPE_BIND_x */ 286 287 unsigned zslice; 288 unsigned face; 289 unsigned level; 290}; 291 292 293/** 294 * A view into a texture that can be bound to a shader stage. 295 */ 296struct pipe_sampler_view 297{ 298 struct pipe_reference reference; 299 enum pipe_format format; /**< typed PIPE_FORMAT_x */ 300 struct pipe_resource *texture; /**< texture into which this is a view */ 301 struct pipe_context *context; /**< context this view belongs to */ 302 unsigned first_level:8; /**< first mipmap level */ 303 unsigned last_level:8; /**< last mipmap level */ 304 unsigned swizzle_r:3; /**< PIPE_SWIZZLE_x for red component */ 305 unsigned swizzle_g:3; /**< PIPE_SWIZZLE_x for green component */ 306 unsigned swizzle_b:3; /**< PIPE_SWIZZLE_x for blue component */ 307 unsigned swizzle_a:3; /**< PIPE_SWIZZLE_x for alpha component */ 308}; 309 310 311/** 312 * Subregion of 1D/2D/3D image resource. 313 */ 314struct pipe_box 315{ 316 unsigned x; 317 unsigned y; 318 unsigned z; 319 unsigned width; 320 unsigned height; 321 unsigned depth; 322}; 323 324 325/** 326 * A memory object/resource such as a vertex buffer or texture. 327 */ 328struct pipe_resource 329{ 330 struct pipe_reference reference; 331 struct pipe_screen *screen; /**< screen that this texture belongs to */ 332 enum pipe_texture_target target; /**< PIPE_TEXTURE_x */ 333 enum pipe_format format; /**< PIPE_FORMAT_x */ 334 335 unsigned width0; 336 unsigned height0; 337 unsigned depth0; 338 339 unsigned last_level:8; /**< Index of last mipmap level present/defined */ 340 unsigned nr_samples:8; /**< for multisampled surfaces, nr of samples */ 341 unsigned usage:8; /**< PIPE_USAGE_x (not a bitmask) */ 342 343 unsigned bind; /**< bitmask of PIPE_BIND_x */ 344 unsigned flags; /**< bitmask of PIPE_RESOURCE_FLAG_x */ 345}; 346 347 348/** 349 * Extra indexing info for (cube) texture resources. 350 */ 351struct pipe_subresource 352{ 353 unsigned face:16; 354 unsigned level:16; 355}; 356 357 358/** 359 * Transfer object. For data transfer to/from a resource. 360 */ 361struct pipe_transfer 362{ 363 struct pipe_resource *resource; /**< resource to transfer to/from */ 364 struct pipe_subresource sr; 365 enum pipe_transfer_usage usage; 366 struct pipe_box box; 367 unsigned stride; 368 unsigned slice_stride; 369 void *data; 370}; 371 372 373 374/** 375 * A vertex buffer. Typically, all the vertex data/attributes for 376 * drawing something will be in one buffer. But it's also possible, for 377 * example, to put colors in one buffer and texcoords in another. 378 */ 379struct pipe_vertex_buffer 380{ 381 unsigned stride; /**< stride to same attrib in next vertex, in bytes */ 382 unsigned max_index; /**< number of vertices in this buffer */ 383 unsigned buffer_offset; /**< offset to start of data in buffer, in bytes */ 384 struct pipe_resource *buffer; /**< the actual buffer */ 385}; 386 387 388/** 389 * Information to describe a vertex attribute (position, color, etc) 390 */ 391struct pipe_vertex_element 392{ 393 /** Offset of this attribute, in bytes, from the start of the vertex */ 394 unsigned src_offset; 395 396 /** Instance data rate divisor. 0 means this is per-vertex data, 397 * n means per-instance data used for n consecutive instances (n > 0). 398 */ 399 unsigned instance_divisor; 400 401 /** Which vertex_buffer (as given to pipe->set_vertex_buffer()) does 402 * this attribute live in? 403 */ 404 unsigned vertex_buffer_index:8; 405 406 enum pipe_format src_format; 407}; 408 409 410#ifdef __cplusplus 411} 412#endif 413 414#endif 415