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