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