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