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