src/mesa/pipe/p_state.h

   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
  43 /**
  44  * Implementation limits
  45  */
  46 #define PIPE_MAX_SAMPLERS     8
  47 #define PIPE_MAX_CLIP_PLANES  6
  48 #define PIPE_MAX_CONSTANT    32
  49 #define PIPE_ATTRIB_MAX      32
  50 #define PIPE_MAX_COLOR_BUFS   8
  51 #define PIPE_MAX_TEXTURE_LEVELS  16
  52 #define PIPE_MAX_FEEDBACK_ATTRIBS 16
  53 #define PIPE_MAX_SHADER_INPUTS 16
  54 #define PIPE_MAX_SHADER_OUTPUTS 16
  55
  56
  57 /* fwd decl */
  58 struct pipe_surface;
  59
  60 /* opaque type */
  61 struct pipe_buffer_handle;
  62
  63 struct pipe_winsys;
  64
  65
  66 /***
  67  *** State objects
  68  ***/
  69
  70
  71 /**
  72  * Primitive (point/line/tri) rasterization info
  73  */
  74 struct pipe_rasterizer_state
  75 {
  76    unsigned flatshade:1;
  77    unsigned light_twoside:1;
  78    unsigned front_winding:2;  /**< PIPE_WINDING_x */
  79    unsigned cull_mode:2;      /**< PIPE_WINDING_x */
  80    unsigned fill_cw:2;        /**< PIPE_POLYGON_MODE_x */
  81    unsigned fill_ccw:2;       /**< PIPE_POLYGON_MODE_x */
  82    unsigned offset_cw:1;
  83    unsigned offset_ccw:1;
  84    unsigned scissor:1;
  85    unsigned poly_smooth:1;
  86    unsigned poly_stipple_enable:1;
  87    unsigned point_smooth:1;
  88    unsigned point_sprite:1;
  89    unsigned point_size_per_vertex:1; /**< size computed in vertex shader */
  90    unsigned multisample:1;         /* XXX maybe more ms state in future */
  91    unsigned line_smooth:1;
  92    unsigned line_stipple_enable:1;
  93    unsigned line_stipple_factor:8;  /**< [1..256] actually */
  94    unsigned line_stipple_pattern:16;
  95    unsigned bypass_clipping:1;
  96
  97    float line_width;
  98    float point_size;           /**< used when no per-vertex size */
  99    float offset_units;
 100    float offset_scale;
 101    ubyte sprite_coord_mode[PIPE_MAX_SHADER_OUTPUTS]; /**< PIPE_SPRITE_COORD_ */
 102 };
 103
 104
 105 /**
 106  * Post-transform vertex feeback
 107  */
 108 struct pipe_feedback_state {
 109    uint enabled:1;        /**< enable feedback? */
 110    uint discard:1;        /**< discard primitives? */
 111    uint interleaved:1;    /**< interleaved output? */
 112    uint num_attribs;
 113    uint attrib[PIPE_MAX_FEEDBACK_ATTRIBS];
 114    uint size[PIPE_MAX_FEEDBACK_ATTRIBS];
 115 };
 116
 117
 118 struct pipe_poly_stipple {
 119    unsigned stipple[32];
 120 };
 121
 122
 123 struct pipe_viewport_state {
 124    float scale[4];
 125    float translate[4];
 126 };
 127
 128 struct pipe_scissor_state {
 129    unsigned minx:16;
 130    unsigned miny:16;
 131    unsigned maxx:16;
 132    unsigned maxy:16;
 133 };
 134
 135 struct pipe_clip_state {
 136    float ucp[PIPE_MAX_CLIP_PLANES][4];
 137    unsigned nr;
 138 };
 139
 140
 141 /**
 142  * Constants for vertex/fragment shaders
 143  */
 144 struct pipe_constant_buffer {
 145    struct pipe_buffer_handle *buffer;
 146    unsigned size;    /** in bytes */
 147 };
 148
 149
 150 struct pipe_shader_state {
 151    const struct tgsi_token *tokens;
 152    ubyte num_inputs;
 153    ubyte num_outputs;
 154    ubyte input_semantic_name[PIPE_MAX_SHADER_INPUTS]; /**< TGSI_SEMANTIC_x */
 155    ubyte input_semantic_index[PIPE_MAX_SHADER_INPUTS];
 156    ubyte output_semantic_name[PIPE_MAX_SHADER_OUTPUTS]; /**< TGSI_SEMANTIC_x */
 157    ubyte output_semantic_index[PIPE_MAX_SHADER_OUTPUTS];
 158 };
 159
 160 struct pipe_depth_stencil_state
 161 {
 162    struct {
 163       unsigned enabled:1;   /**< depth test enabled? */
 164       unsigned writemask:1; /**< allow depth buffer writes? */
 165       unsigned func:3;      /**< depth test func (PIPE_FUNC_x) */
 166       unsigned occlusion_count:1; /**< XXX move this elsewhere? */
 167       float clear;      /**< Clear value in [0,1] (XXX correct place?) */
 168    } depth;
 169    struct {
 170       unsigned front_enabled:1;
 171       unsigned front_func:3;     /**< PIPE_FUNC_x */
 172       unsigned front_fail_op:3;  /**< PIPE_STENCIL_OP_x */
 173       unsigned front_zpass_op:3; /**< PIPE_STENCIL_OP_x */
 174       unsigned front_zfail_op:3; /**< PIPE_STENCIL_OP_x */
 175       unsigned back_enabled:1;
 176       unsigned back_func:3;      /**< PIPE_FUNC_x */
 177       unsigned back_fail_op:3;   /**< PIPE_STENCIL_OP_x */
 178       unsigned back_zpass_op:3;  /**< PIPE_STENCIL_OP_x */
 179       unsigned back_zfail_op:3;  /**< PIPE_STENCIL_OP_x */
 180       ubyte ref_value[2];    /**< [0] = front, [1] = back */
 181       ubyte value_mask[2];
 182       ubyte write_mask[2];
 183       ubyte clear_value;
 184    } stencil;
 185 };
 186
 187 struct pipe_alpha_test_state {
 188    unsigned enabled:1;
 189    unsigned func:3;    /**< PIPE_FUNC_x */
 190    float ref;      /**< reference value */
 191 };
 192
 193 struct pipe_blend_state {
 194    unsigned blend_enable:1;
 195
 196    unsigned rgb_func:3;          /**< PIPE_BLEND_x */
 197    unsigned rgb_src_factor:5;    /**< PIPE_BLENDFACTOR_x */
 198    unsigned rgb_dst_factor:5;    /**< PIPE_BLENDFACTOR_x */
 199
 200    unsigned alpha_func:3;        /**< PIPE_BLEND_x */
 201    unsigned alpha_src_factor:5;  /**< PIPE_BLENDFACTOR_x */
 202    unsigned alpha_dst_factor:5;  /**< PIPE_BLENDFACTOR_x */
 203
 204    unsigned logicop_enable:1;
 205    unsigned logicop_func:4;      /**< PIPE_LOGICOP_x */
 206
 207    unsigned colormask:4;         /**< bitmask of PIPE_MASK_R/G/B/A */
 208    unsigned dither:1;
 209 };
 210
 211 struct pipe_blend_color {
 212    float color[4];
 213 };
 214
 215 struct pipe_clear_color_state
 216 {
 217    float color[4];
 218 };
 219
 220 struct pipe_framebuffer_state
 221 {
 222    /** multiple colorbuffers for multiple render targets */
 223    unsigned num_cbufs;
 224    struct pipe_surface *cbufs[PIPE_MAX_COLOR_BUFS];
 225
 226    struct pipe_surface *zbuf;      /**< Z buffer */
 227    struct pipe_surface *sbuf;      /**< Stencil buffer */
 228 };
 229
 230
 231 /**
 232  * Texture sampler state.
 233  */
 234 struct pipe_sampler_state
 235 {
 236    unsigned wrap_s:3;        /**< PIPE_TEX_WRAP_x */
 237    unsigned wrap_t:3;        /**< PIPE_TEX_WRAP_x */
 238    unsigned wrap_r:3;        /**< PIPE_TEX_WRAP_x */
 239    unsigned min_img_filter:2;    /**< PIPE_TEX_FILTER_x */
 240    unsigned min_mip_filter:2;    /**< PIPE_TEX_MIPFILTER_x */
 241    unsigned mag_img_filter:2;    /**< PIPE_TEX_FILTER_x */
 242    unsigned compare:1;       /**< shadow/depth compare enabled? */
 243    unsigned compare_mode:1;  /**< PIPE_TEX_COMPARE_x */
 244    unsigned compare_func:3;  /**< PIPE_FUNC_x */
 245    unsigned normalized_coords:1;  /**< Are coords normalized to [0,1]? */
 246    float shadow_ambient; /**< shadow test fail color/intensity */
 247    float min_lod;
 248    float max_lod;
 249    float lod_bias;
 250 #if 0 /* need these? */
 251    int BaseLevel;     /**< min mipmap level, OpenGL 1.2 */
 252    int MaxLevel;      /**< max mipmap level, OpenGL 1.2 */
 253 #endif
 254    float border_color[4];
 255    float max_anisotropy;
 256 };
 257
 258
 259 /***
 260  *** Resource Objects
 261  ***/
 262
 263 struct pipe_region
 264 {
 265    struct pipe_buffer_handle *buffer; /**< driver private buffer handle */
 266
 267    unsigned refcount; /**< Reference count for region */
 268    unsigned cpp;      /**< bytes per pixel */
 269    unsigned pitch;    /**< in pixels */
 270    unsigned height;   /**< in pixels */
 271    ubyte *map;    /**< only non-NULL when region is actually mapped */
 272    unsigned map_refcount;  /**< Reference count for mapping */
 273 };
 274
 275
 276 /**
 277  * 2D surface.  This is basically a view into a pipe_region (memory buffer).
 278  * May be a renderbuffer, texture mipmap level, etc.
 279  */
 280 struct pipe_surface
 281 {
 282    struct pipe_region *region;
 283    unsigned format;              /**< PIPE_FORMAT_x */
 284    unsigned width, height;
 285    unsigned offset;              /**< offset from start of region, in bytes */
 286    unsigned refcount;
 287    struct pipe_winsys *winsys;   /**< winsys which owns/created the surface */
 288 };
 289
 290
 291 /**
 292  * Describes the location of each texture image within a texture region.
 293  */
 294 struct pipe_mipmap_level
 295 {
 296    unsigned level_offset;
 297    unsigned width;
 298    unsigned height;
 299    unsigned depth;
 300    unsigned nr_images;
 301
 302    /* Explicitly store the offset of each image for each cube face or
 303     * depth value.  Pretty much have to accept that hardware formats
 304     * are going to be so diverse that there is no unified way to
 305     * compute the offsets of depth/cube images within a mipmap level,
 306     * so have to store them as a lookup table:
 307     */
 308    unsigned *image_offset;   /**< array [depth] of offsets */
 309 };
 310
 311 struct pipe_mipmap_tree
 312 {
 313    /* Effectively the key:
 314     */
 315    unsigned target;            /* XXX convert to PIPE_TEXTURE_x */
 316    unsigned internal_format;   /* XXX convert to PIPE_FORMAT_x */
 317
 318    unsigned format;            /**< PIPE_FORMAT_x */
 319    unsigned first_level;
 320    unsigned last_level;
 321
 322    unsigned width0, height0, depth0; /**< Level zero image dimensions */
 323    unsigned cpp;
 324
 325    unsigned compressed:1;
 326
 327    /* Derived from the above:
 328     */
 329    unsigned pitch;
 330    unsigned depth_pitch;          /* per-image on i945? */
 331    unsigned total_height;
 332
 333    /* Includes image offset tables:
 334     */
 335    struct pipe_mipmap_level level[PIPE_MAX_TEXTURE_LEVELS];
 336
 337    /* The data is held here:
 338     */
 339    struct pipe_region *region;
 340
 341    /* These are also refcounted:
 342     */
 343    unsigned refcount;
 344 };
 345
 346
 347 /**
 348  * A vertex buffer.  Typically, all the vertex data/attributes for
 349  * drawing something will be in one buffer.  But it's also possible, for
 350  * example, to put colors in one buffer and texcoords in another.
 351  */
 352 struct pipe_vertex_buffer
 353 {
 354    unsigned pitch:11;    /**< stride to same attrib in next vertex, in bytes */
 355    unsigned max_index;   /**< number of vertices in this buffer */
 356    unsigned buffer_offset;  /**< offset to start of data in buffer, in bytes */
 357    struct pipe_buffer_handle *buffer;  /**< the actual buffer */
 358 };
 359
 360
 361 /**
 362  * Information to describe a vertex attribute (position, color, etc)
 363  */
 364 struct pipe_vertex_element
 365 {
 366    /** Offset of this attribute, in bytes, from the start of the vertex */
 367    unsigned src_offset:11;
 368
 369    /** Which vertex_buffer (as given to pipe->set_vertex_buffer()) does
 370     * this attribute live in?
 371     */
 372    unsigned vertex_buffer_index:5;
 373
 374    unsigned dst_offset:8;
 375    unsigned src_format;            /**< PIPE_FORMAT_* */
 376 };
 377
 378
 379 /**
 380  * Vertex feedback buffer
 381  */
 382 struct pipe_feedback_buffer {
 383    struct pipe_buffer_handle *buffer;
 384    unsigned size;
 385    unsigned start_offset;
 386 };
 387
 388
 389 /**
 390  * Hardware queries (occlusion, transform feedback, timing, etc)
 391  */
 392 struct pipe_query_object {
 393    uint type:3;   /**< PIPE_QUERY_x */
 394    uint ready:1;  /**< is result ready? */
 395    uint64 count;
 396 };
 397
 398
 399 #endif