p_state.h revision 80567f9c9f84d9df1cdb2d91a3c0814888cc5d08
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 * Abstract graphics pipe state objects. 31 * 32 * Basic notes: 33 * 1. Want compact representations, so we use bitfields. 34 * 2. Put bitfields before other (GLfloat) fields. 35 */ 36 37 38#ifndef PIPE_STATE_H 39#define PIPE_STATE_H 40 41#include "p_compiler.h" 42#include "p_defines.h" 43#include "p_format.h" 44 45 46#ifdef __cplusplus 47extern "C" { 48#endif 49 50 51/** 52 * Implementation limits 53 */ 54#define PIPE_MAX_SAMPLERS 8 55#define PIPE_MAX_CLIP_PLANES 6 56#define PIPE_MAX_CONSTANT 32 57#define PIPE_ATTRIB_MAX 32 58#define PIPE_MAX_COLOR_BUFS 8 59#define PIPE_MAX_TEXTURE_LEVELS 16 60#define PIPE_MAX_FEEDBACK_ATTRIBS 16 61#define PIPE_MAX_SHADER_INPUTS 16 62#define PIPE_MAX_SHADER_OUTPUTS 16 63 64 65/* fwd decls */ 66struct pipe_screen; 67struct pipe_surface; 68struct pipe_winsys; 69 70 71 72/** 73 * The driver will certainly subclass this to include actual memory 74 * management information. 75 */ 76struct pipe_buffer 77{ 78 unsigned alignment; 79 unsigned usage; 80 unsigned size; 81 82 /** Reference count */ 83 unsigned refcount; 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 unsigned bypass_clipping:1; 113 unsigned bypass_vs:1; /**< vertices are already fully transformed */ 114 unsigned origin_lower_left:1; /**< Is (0,0) the lower-left corner? */ 115 116 float line_width; 117 float point_size; /**< used when no per-vertex size */ 118 float offset_units; 119 float offset_scale; 120 ubyte sprite_coord_mode[PIPE_MAX_SHADER_OUTPUTS]; /**< PIPE_SPRITE_COORD_ */ 121}; 122 123 124struct pipe_poly_stipple 125{ 126 unsigned stipple[32]; 127}; 128 129 130struct pipe_viewport_state 131{ 132 float scale[4]; 133 float translate[4]; 134}; 135 136 137struct pipe_scissor_state 138{ 139 unsigned minx:16; 140 unsigned miny:16; 141 unsigned maxx:16; 142 unsigned maxy:16; 143}; 144 145 146struct pipe_clip_state 147{ 148 float ucp[PIPE_MAX_CLIP_PLANES][4]; 149 unsigned nr; 150}; 151 152 153/** 154 * Constants for vertex/fragment shaders 155 */ 156struct pipe_constant_buffer 157{ 158 struct pipe_buffer *buffer; 159 unsigned size; /** in bytes (XXX: redundant!) */ 160}; 161 162 163struct pipe_shader_state 164{ 165 const struct tgsi_token *tokens; 166}; 167 168 169struct pipe_depth_stencil_alpha_state 170{ 171 struct { 172 unsigned enabled:1; /**< depth test enabled? */ 173 unsigned writemask:1; /**< allow depth buffer writes? */ 174 unsigned func:3; /**< depth test func (PIPE_FUNC_x) */ 175 unsigned occlusion_count:1; /**< do occlusion counting? */ 176 } depth; 177 struct { 178 unsigned enabled:1; 179 unsigned func:3; /**< PIPE_FUNC_x */ 180 unsigned fail_op:3; /**< PIPE_STENCIL_OP_x */ 181 unsigned zpass_op:3; /**< PIPE_STENCIL_OP_x */ 182 unsigned zfail_op:3; /**< PIPE_STENCIL_OP_x */ 183 ubyte ref_value; 184 ubyte value_mask; 185 ubyte write_mask; 186 } stencil[2]; /**< [0] = front, [1] = back */ 187 struct { 188 unsigned enabled:1; 189 unsigned func:3; /**< PIPE_FUNC_x */ 190 float ref; /**< reference value */ 191 } alpha; 192}; 193 194 195struct pipe_blend_state 196{ 197 unsigned blend_enable:1; 198 199 unsigned rgb_func:3; /**< PIPE_BLEND_x */ 200 unsigned rgb_src_factor:5; /**< PIPE_BLENDFACTOR_x */ 201 unsigned rgb_dst_factor:5; /**< PIPE_BLENDFACTOR_x */ 202 203 unsigned alpha_func:3; /**< PIPE_BLEND_x */ 204 unsigned alpha_src_factor:5; /**< PIPE_BLENDFACTOR_x */ 205 unsigned alpha_dst_factor:5; /**< PIPE_BLENDFACTOR_x */ 206 207 unsigned logicop_enable:1; 208 unsigned logicop_func:4; /**< PIPE_LOGICOP_x */ 209 210 unsigned colormask:4; /**< bitmask of PIPE_MASK_R/G/B/A */ 211 unsigned dither:1; 212}; 213 214 215struct pipe_blend_color 216{ 217 float color[4]; 218}; 219 220 221struct pipe_framebuffer_state 222{ 223 unsigned width, height; 224 225 /** multiple colorbuffers for multiple render targets */ 226 unsigned num_cbufs; 227 struct pipe_surface *cbufs[PIPE_MAX_COLOR_BUFS]; 228 229 struct pipe_surface *zsbuf; /**< Z/stencil buffer */ 230}; 231 232 233/** 234 * Texture sampler state. 235 */ 236struct pipe_sampler_state 237{ 238 unsigned wrap_s:3; /**< PIPE_TEX_WRAP_x */ 239 unsigned wrap_t:3; /**< PIPE_TEX_WRAP_x */ 240 unsigned wrap_r:3; /**< PIPE_TEX_WRAP_x */ 241 unsigned min_img_filter:2; /**< PIPE_TEX_FILTER_x */ 242 unsigned min_mip_filter:2; /**< PIPE_TEX_MIPFILTER_x */ 243 unsigned mag_img_filter:2; /**< PIPE_TEX_FILTER_x */ 244 unsigned compare:1; /**< shadow/depth compare enabled? */ 245 unsigned compare_mode:1; /**< PIPE_TEX_COMPARE_x */ 246 unsigned compare_func:3; /**< PIPE_FUNC_x */ 247 unsigned normalized_coords:1; /**< Are coords normalized to [0,1]? */ 248 unsigned prefilter:4; /**< Wierd sampling state exposed by some api's */ 249 float shadow_ambient; /**< shadow test fail color/intensity */ 250 float lod_bias; /**< LOD/lambda bias */ 251 float min_lod, max_lod; /**< LOD clamp range, after bias */ 252 float border_color[4]; 253 float max_anisotropy; 254}; 255 256 257/** 258 * 2D surface. This is basically a view into a memory buffer. 259 * May be a renderbuffer, texture mipmap level, etc. 260 */ 261struct pipe_surface 262{ 263 struct pipe_buffer *buffer; /**< surface's buffer/memory */ 264 enum pipe_format format; /**< PIPE_FORMAT_x */ 265 unsigned status; /**< PIPE_SURFACE_STATUS_x */ 266 unsigned clear_value; /**< XXX may be temporary */ 267 unsigned cpp; /**< bytes per pixel */ 268 unsigned width; 269 unsigned height; 270 unsigned pitch; /**< in pixels */ 271 unsigned offset; /**< offset from start of buffer, in bytes */ 272 unsigned refcount; 273 struct pipe_winsys *winsys; /**< winsys which owns/created the surface */ 274}; 275 276 277/** 278 * Texture object. 279 */ 280struct pipe_texture 281{ 282 enum pipe_texture_target target; /**< PIPE_TEXTURE_x */ 283 enum pipe_format format; /**< PIPE_FORMAT_x */ 284 285 unsigned width[PIPE_MAX_TEXTURE_LEVELS]; 286 unsigned height[PIPE_MAX_TEXTURE_LEVELS]; 287 unsigned depth[PIPE_MAX_TEXTURE_LEVELS]; 288 289 unsigned cpp:8; 290 unsigned last_level:8; /**< Index of last mipmap level present/defined */ 291 unsigned compressed:1; 292 293 /* These are also refcounted: 294 */ 295 unsigned refcount; 296 297 struct pipe_screen *screen; /**< screen that this texture belongs to */ 298}; 299 300 301/** 302 * A vertex buffer. Typically, all the vertex data/attributes for 303 * drawing something will be in one buffer. But it's also possible, for 304 * example, to put colors in one buffer and texcoords in another. 305 */ 306struct pipe_vertex_buffer 307{ 308 unsigned pitch; /**< stride to same attrib in next vertex, in bytes */ 309 unsigned max_index; /**< number of vertices in this buffer */ 310 unsigned buffer_offset; /**< offset to start of data in buffer, in bytes */ 311 struct pipe_buffer *buffer; /**< the actual buffer */ 312}; 313 314 315/** 316 * Information to describe a vertex attribute (position, color, etc) 317 */ 318struct pipe_vertex_element 319{ 320 /** Offset of this attribute, in bytes, from the start of the vertex */ 321 unsigned src_offset; 322 323 /** Which vertex_buffer (as given to pipe->set_vertex_buffer()) does 324 * this attribute live in? 325 */ 326 unsigned vertex_buffer_index:8; 327 unsigned nr_components:8; 328 329 enum pipe_format src_format; /**< PIPE_FORMAT_* */ 330}; 331 332 333#ifdef __cplusplus 334} 335#endif 336 337#endif 338