p_state.h revision 88999de8b70d1e170f5bbcadd07132d382c560cf
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_SHADER_INPUTS 16 64#define PIPE_MAX_SHADER_OUTPUTS 16 65#define PIPE_MAX_TEXTURE_LEVELS 16 66 67 68/* fwd decls */ 69struct pipe_surface; 70 71 72/** 73 * The driver will certainly subclass this to include actual memory 74 * management information. 75 */ 76struct pipe_buffer 77{ 78 struct pipe_reference reference; 79 struct pipe_screen *screen; 80 unsigned alignment; 81 unsigned usage; 82 unsigned size; 83}; 84 85 86/** 87 * Primitive (point/line/tri) rasterization info 88 */ 89struct pipe_rasterizer_state 90{ 91 unsigned flatshade:1; 92 unsigned light_twoside:1; 93 unsigned front_winding:2; /**< PIPE_WINDING_x */ 94 unsigned cull_mode:2; /**< PIPE_WINDING_x */ 95 unsigned fill_cw:2; /**< PIPE_POLYGON_MODE_x */ 96 unsigned fill_ccw:2; /**< PIPE_POLYGON_MODE_x */ 97 unsigned offset_cw:1; 98 unsigned offset_ccw:1; 99 unsigned scissor:1; 100 unsigned poly_smooth:1; 101 unsigned poly_stipple_enable:1; 102 unsigned point_smooth:1; 103 unsigned point_sprite:1; 104 unsigned point_size_per_vertex:1; /**< size computed in vertex shader */ 105 unsigned multisample:1; /* XXX maybe more ms state in future */ 106 unsigned line_smooth:1; 107 unsigned line_stipple_enable:1; 108 unsigned line_stipple_factor:8; /**< [1..256] actually */ 109 unsigned line_stipple_pattern:16; 110 unsigned line_last_pixel:1; 111 112 /** 113 * Vertex coordinates are pre-transformed to screen space. Skip 114 * the vertex shader, clipping and viewport processing. Note that 115 * a vertex shader is still needed though, to indicate the mapping 116 * from vertex elements to fragment shader input semantics. 117 */ 118 unsigned bypass_vs_clip_and_viewport:1; 119 120 unsigned flatshade_first:1; /**< take color attribute from the first vertex of a primitive */ 121 unsigned gl_rasterization_rules:1; /**< enable tweaks for GL rasterization? */ 122 123 float line_width; 124 float point_size; /**< used when no per-vertex size */ 125 float point_size_min; /* XXX - temporary, will go away */ 126 float point_size_max; /* XXX - temporary, will go away */ 127 float offset_units; 128 float offset_scale; 129 ubyte sprite_coord_mode[PIPE_MAX_SHADER_OUTPUTS]; /**< PIPE_SPRITE_COORD_ */ 130}; 131 132 133struct pipe_poly_stipple 134{ 135 unsigned stipple[32]; 136}; 137 138 139struct pipe_viewport_state 140{ 141 float scale[4]; 142 float translate[4]; 143}; 144 145 146struct pipe_scissor_state 147{ 148 unsigned minx:16; 149 unsigned miny:16; 150 unsigned maxx:16; 151 unsigned maxy:16; 152}; 153 154 155struct pipe_clip_state 156{ 157 float ucp[PIPE_MAX_CLIP_PLANES][4]; 158 unsigned nr; 159}; 160 161 162/** 163 * Constants for vertex/fragment shaders 164 */ 165struct pipe_constant_buffer 166{ 167 struct pipe_buffer *buffer; 168}; 169 170 171struct pipe_shader_state 172{ 173 const struct tgsi_token *tokens; 174}; 175 176 177struct pipe_depth_state 178{ 179 unsigned enabled:1; /**< depth test enabled? */ 180 unsigned writemask:1; /**< allow depth buffer writes? */ 181 unsigned func:3; /**< depth test func (PIPE_FUNC_x) */ 182 unsigned occlusion_count:1; /**< do occlusion counting? */ 183}; 184 185 186struct pipe_stencil_state 187{ 188 unsigned enabled:1; /**< stencil[0]: stencil enabled, stencil[1]: two-side enabled */ 189 unsigned func:3; /**< PIPE_FUNC_x */ 190 unsigned fail_op:3; /**< PIPE_STENCIL_OP_x */ 191 unsigned zpass_op:3; /**< PIPE_STENCIL_OP_x */ 192 unsigned zfail_op:3; /**< PIPE_STENCIL_OP_x */ 193 ubyte ref_value; 194 ubyte valuemask; 195 ubyte writemask; 196}; 197 198 199struct pipe_alpha_state 200{ 201 unsigned enabled:1; 202 unsigned func:3; /**< PIPE_FUNC_x */ 203 float ref_value; /**< reference value */ 204}; 205 206 207struct pipe_depth_stencil_alpha_state 208{ 209 struct pipe_depth_state depth; 210 struct pipe_stencil_state stencil[2]; /**< [0] = front, [1] = back */ 211 struct pipe_alpha_state alpha; 212}; 213 214 215struct pipe_blend_state 216{ 217 unsigned blend_enable:1; 218 219 unsigned rgb_func:3; /**< PIPE_BLEND_x */ 220 unsigned rgb_src_factor:5; /**< PIPE_BLENDFACTOR_x */ 221 unsigned rgb_dst_factor:5; /**< PIPE_BLENDFACTOR_x */ 222 223 unsigned alpha_func:3; /**< PIPE_BLEND_x */ 224 unsigned alpha_src_factor:5; /**< PIPE_BLENDFACTOR_x */ 225 unsigned alpha_dst_factor:5; /**< PIPE_BLENDFACTOR_x */ 226 227 unsigned logicop_enable:1; 228 unsigned logicop_func:4; /**< PIPE_LOGICOP_x */ 229 230 unsigned colormask:4; /**< bitmask of PIPE_MASK_R/G/B/A */ 231 unsigned dither:1; 232}; 233 234 235struct pipe_blend_color 236{ 237 float color[4]; 238}; 239 240 241struct pipe_framebuffer_state 242{ 243 unsigned width, height; 244 245 /** multiple colorbuffers 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 prefilter:4; /**< Wierd sampling state exposed by some api's */ 268 float shadow_ambient; /**< shadow test fail color/intensity */ 269 float lod_bias; /**< LOD/lambda bias */ 270 float min_lod, max_lod; /**< LOD clamp range, after bias */ 271 float border_color[4]; 272 float max_anisotropy; 273}; 274 275 276/** 277 * 2D surface. This is basically a view into a memory buffer. 278 * May be a renderbuffer, texture mipmap level, etc. 279 */ 280struct pipe_surface 281{ 282 struct pipe_reference reference; 283 enum pipe_format format; /**< PIPE_FORMAT_x */ 284 unsigned width; /**< logical width in pixels */ 285 unsigned height; /**< logical height in pixels */ 286 unsigned layout; /**< PIPE_SURFACE_LAYOUT_x */ 287 unsigned offset; /**< offset from start of buffer, in bytes */ 288 unsigned usage; /**< PIPE_BUFFER_USAGE_* */ 289 290 struct pipe_texture *texture; /**< texture into which this is a view */ 291 unsigned face; 292 unsigned level; 293 unsigned zslice; 294}; 295 296 297/** 298 * Transfer object. For data transfer to/from a texture. 299 */ 300struct pipe_transfer 301{ 302 enum pipe_format format; /**< PIPE_FORMAT_x */ 303 unsigned x; /**< x offset from start of texture image */ 304 unsigned y; /**< y offset from start of texture image */ 305 unsigned width; /**< logical width in pixels */ 306 unsigned height; /**< logical height in pixels */ 307 struct pipe_format_block block; 308 unsigned nblocksx; /**< allocated width in blocks */ 309 unsigned nblocksy; /**< allocated height in blocks */ 310 unsigned stride; /**< stride in bytes between rows of blocks */ 311 unsigned usage; /**< PIPE_TRANSFER_* */ 312 313 struct pipe_texture *texture; /**< texture to transfer to/from */ 314 unsigned face; 315 unsigned level; 316 unsigned zslice; 317}; 318 319 320/** 321 * Texture object. 322 */ 323struct pipe_texture 324{ 325 struct pipe_reference reference; 326 327 enum pipe_texture_target target; /**< PIPE_TEXTURE_x */ 328 enum pipe_format format; /**< PIPE_FORMAT_x */ 329 330 unsigned width[PIPE_MAX_TEXTURE_LEVELS]; 331 unsigned height[PIPE_MAX_TEXTURE_LEVELS]; 332 unsigned depth[PIPE_MAX_TEXTURE_LEVELS]; 333 334 struct pipe_format_block block; 335 unsigned nblocksx[PIPE_MAX_TEXTURE_LEVELS]; /**< allocated width in blocks */ 336 unsigned nblocksy[PIPE_MAX_TEXTURE_LEVELS]; /**< allocated height in blocks */ 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((struct pipe_reference **)ptr, &buf->reference)) 387 old_buf->screen->buffer_destroy(old_buf); 388} 389 390static INLINE void 391pipe_surface_reference(struct pipe_surface **ptr, struct pipe_surface *surf) 392{ 393 struct pipe_surface *old_surf = *ptr; 394 395 if (pipe_reference((struct pipe_reference **)ptr, &surf->reference)) 396 old_surf->texture->screen->tex_surface_destroy(old_surf); 397} 398 399static INLINE void 400pipe_texture_reference(struct pipe_texture **ptr, struct pipe_texture *tex) 401{ 402 struct pipe_texture *old_tex = *ptr; 403 404 if (pipe_reference((struct pipe_reference **)ptr, &tex->reference)) 405 old_tex->screen->texture_destroy(old_tex); 406} 407 408 409#ifdef __cplusplus 410} 411#endif 412 413#endif 414