p_state.h revision beb712ee9adf693f02e5d867344817176189d385
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 181struct pipe_shader_state 182{ 183 const struct tgsi_token *tokens; 184}; 185 186 187struct pipe_depth_state 188{ 189 unsigned enabled:1; /**< depth test enabled? */ 190 unsigned writemask:1; /**< allow depth buffer writes? */ 191 unsigned func:3; /**< depth test func (PIPE_FUNC_x) */ 192}; 193 194 195struct pipe_stencil_state 196{ 197 unsigned enabled:1; /**< stencil[0]: stencil enabled, stencil[1]: two-side enabled */ 198 unsigned func:3; /**< PIPE_FUNC_x */ 199 unsigned fail_op:3; /**< PIPE_STENCIL_OP_x */ 200 unsigned zpass_op:3; /**< PIPE_STENCIL_OP_x */ 201 unsigned zfail_op:3; /**< PIPE_STENCIL_OP_x */ 202 ubyte ref_value; 203 ubyte valuemask; 204 ubyte writemask; 205}; 206 207 208struct pipe_alpha_state 209{ 210 unsigned enabled:1; 211 unsigned func:3; /**< PIPE_FUNC_x */ 212 float ref_value; /**< reference value */ 213}; 214 215 216struct pipe_depth_stencil_alpha_state 217{ 218 struct pipe_depth_state depth; 219 struct pipe_stencil_state stencil[2]; /**< [0] = front, [1] = back */ 220 struct pipe_alpha_state alpha; 221}; 222 223 224struct pipe_blend_state 225{ 226 unsigned blend_enable:1; 227 228 unsigned rgb_func:3; /**< PIPE_BLEND_x */ 229 unsigned rgb_src_factor:5; /**< PIPE_BLENDFACTOR_x */ 230 unsigned rgb_dst_factor:5; /**< PIPE_BLENDFACTOR_x */ 231 232 unsigned alpha_func:3; /**< PIPE_BLEND_x */ 233 unsigned alpha_src_factor:5; /**< PIPE_BLENDFACTOR_x */ 234 unsigned alpha_dst_factor:5; /**< PIPE_BLENDFACTOR_x */ 235 236 unsigned logicop_enable:1; 237 unsigned logicop_func:4; /**< PIPE_LOGICOP_x */ 238 239 unsigned colormask:4; /**< bitmask of PIPE_MASK_R/G/B/A */ 240 unsigned dither:1; 241}; 242 243 244struct pipe_blend_color 245{ 246 float color[4]; 247}; 248 249 250struct pipe_framebuffer_state 251{ 252 unsigned width, height; 253 254 /** multiple colorbuffers for multiple render targets */ 255 unsigned nr_cbufs; 256 struct pipe_surface *cbufs[PIPE_MAX_COLOR_BUFS]; 257 258 struct pipe_surface *zsbuf; /**< Z/stencil buffer */ 259}; 260 261 262/** 263 * Texture sampler state. 264 */ 265struct pipe_sampler_state 266{ 267 unsigned wrap_s:3; /**< PIPE_TEX_WRAP_x */ 268 unsigned wrap_t:3; /**< PIPE_TEX_WRAP_x */ 269 unsigned wrap_r:3; /**< PIPE_TEX_WRAP_x */ 270 unsigned min_img_filter:2; /**< PIPE_TEX_FILTER_x */ 271 unsigned min_mip_filter:2; /**< PIPE_TEX_MIPFILTER_x */ 272 unsigned mag_img_filter:2; /**< PIPE_TEX_FILTER_x */ 273 unsigned compare_mode:1; /**< PIPE_TEX_COMPARE_x */ 274 unsigned compare_func:3; /**< PIPE_FUNC_x */ 275 unsigned normalized_coords:1; /**< Are coords normalized to [0,1]? */ 276 unsigned prefilter:4; /**< Wierd sampling state exposed by some api's */ 277 float lod_bias; /**< LOD/lambda bias */ 278 float min_lod, max_lod; /**< LOD clamp range, after bias */ 279 float border_color[4]; 280 float max_anisotropy; 281}; 282 283 284/** 285 * 2D surface. This is basically a view into a memory buffer. 286 * May be a renderbuffer, texture mipmap level, etc. 287 */ 288struct pipe_surface 289{ 290 struct pipe_reference reference; 291 enum pipe_format format; /**< PIPE_FORMAT_x */ 292 unsigned width; /**< logical width in pixels */ 293 unsigned height; /**< logical height in pixels */ 294 unsigned layout; /**< PIPE_SURFACE_LAYOUT_x */ 295 unsigned offset; /**< offset from start of buffer, in bytes */ 296 unsigned usage; /**< PIPE_BUFFER_USAGE_* */ 297 298 unsigned zslice; 299 struct pipe_texture *texture; /**< texture into which this is a view */ 300 unsigned face; 301 unsigned level; 302}; 303 304 305/** 306 * Transfer object. For data transfer to/from a texture. 307 */ 308struct pipe_transfer 309{ 310 unsigned x; /**< x offset from start of texture image */ 311 unsigned y; /**< y offset from start of texture image */ 312 unsigned width; /**< logical width in pixels */ 313 unsigned height; /**< logical height in pixels */ 314 unsigned stride; /**< stride in bytes between rows of blocks */ 315 enum pipe_transfer_usage usage; /**< PIPE_TRANSFER_* */ 316 317 struct pipe_texture *texture; /**< texture to transfer to/from */ 318 unsigned face; 319 unsigned level; 320 unsigned zslice; 321}; 322 323 324/** 325 * Texture object. 326 */ 327struct pipe_texture 328{ 329 struct pipe_reference reference; 330 331 enum pipe_texture_target target; /**< PIPE_TEXTURE_x */ 332 enum pipe_format format; /**< PIPE_FORMAT_x */ 333 334 unsigned width0; 335 unsigned height0; 336 unsigned depth0; 337 338 unsigned last_level:8; /**< Index of last mipmap level present/defined */ 339 340 unsigned nr_samples:8; /**< for multisampled surfaces, nr of samples */ 341 342 unsigned tex_usage; /* PIPE_TEXTURE_USAGE_* */ 343 344 struct pipe_screen *screen; /**< screen that this texture belongs to */ 345}; 346 347 348/** 349 * A vertex buffer. Typically, all the vertex data/attributes for 350 * drawing something will be in one buffer. But it's also possible, for 351 * example, to put colors in one buffer and texcoords in another. 352 */ 353struct pipe_vertex_buffer 354{ 355 unsigned stride; /**< stride to same attrib in next vertex, in bytes */ 356 unsigned max_index; /**< number of vertices in this buffer */ 357 unsigned buffer_offset; /**< offset to start of data in buffer, in bytes */ 358 struct pipe_buffer *buffer; /**< the actual buffer */ 359}; 360 361 362/** 363 * Information to describe a vertex attribute (position, color, etc) 364 */ 365struct pipe_vertex_element 366{ 367 /** Offset of this attribute, in bytes, from the start of the vertex */ 368 unsigned src_offset; 369 370 /** Which vertex_buffer (as given to pipe->set_vertex_buffer()) does 371 * this attribute live in? 372 */ 373 unsigned vertex_buffer_index:8; 374 unsigned nr_components:8; 375 376 enum pipe_format src_format; /**< PIPE_FORMAT_* */ 377}; 378 379 380/* Reference counting helper functions */ 381static INLINE void 382pipe_buffer_reference(struct pipe_buffer **ptr, struct pipe_buffer *buf) 383{ 384 struct pipe_buffer *old_buf = *ptr; 385 386 if (pipe_reference(&(*ptr)->reference, &buf->reference)) 387 old_buf->screen->buffer_destroy(old_buf); 388 *ptr = buf; 389} 390 391static INLINE void 392pipe_surface_reference(struct pipe_surface **ptr, struct pipe_surface *surf) 393{ 394 struct pipe_surface *old_surf = *ptr; 395 396 if (pipe_reference(&(*ptr)->reference, &surf->reference)) 397 old_surf->texture->screen->tex_surface_destroy(old_surf); 398 *ptr = surf; 399} 400 401static INLINE void 402pipe_texture_reference(struct pipe_texture **ptr, struct pipe_texture *tex) 403{ 404 struct pipe_texture *old_tex = *ptr; 405 406 if (pipe_reference(&(*ptr)->reference, &tex->reference)) 407 old_tex->screen->texture_destroy(old_tex); 408 *ptr = tex; 409} 410 411 412#ifdef __cplusplus 413} 414#endif 415 416#endif 417