src/gallium/include/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  * @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_refcnt.h"
  47 #include "p_screen.h"
  48
  49
  50 #ifdef __cplusplus
  51 extern "C" {
  52 #endif
  53
  54
  55 /**
  56  * Implementation limits
  57  */
  58 #define PIPE_MAX_ATTRIBS          32
  59 #define PIPE_MAX_CLIP_PLANES       6
  60 #define PIPE_MAX_COLOR_BUFS        8
  61 #define PIPE_MAX_CONSTANT         32
  62 #define PIPE_MAX_SAMPLERS         16
  63 #define PIPE_MAX_SHADER_INPUTS    16
  64 #define PIPE_MAX_SHADER_OUTPUTS   16
  65 #define PIPE_MAX_TEXTURE_LEVELS   16
  66
  67
  68 /* fwd decls */
  69 struct pipe_surface;
  70
  71
  72 /**
  73  * The driver will certainly subclass this to include actual memory
  74  * management information.
  75  */
  76 struct pipe_buffer
  77 {
  78    struct pipe_reference reference;
  79    struct pipe_screen *screen;
  80    unsigned alignment;
  81    unsigned usage;
  82    unsigned size;
  83 };
  84
  85
  86 /**
  87  * Primitive (point/line/tri) rasterization info
  88  */
  89 struct pipe_rasterizer_state
  90 {
  91    unsigned flatshade:1;
  92    unsigned light_twoside:1;
  93    unsigned front_winding:2;  /**< PIPE_WINDING_x */
  94    unsigned cull_mode:2;      /**< PIPE_WINDING_x */
  95    unsigned fill_cw:2;        /**< PIPE_POLYGON_MODE_x */
  96    unsigned fill_ccw:2;       /**< PIPE_POLYGON_MODE_x */
  97    unsigned offset_cw:1;
  98    unsigned offset_ccw:1;
  99    unsigned scissor:1;
 100    unsigned poly_smooth:1;
 101    unsigned poly_stipple_enable:1;
 102    unsigned point_smooth:1;
 103    unsigned point_sprite:1;
 104    unsigned point_size_per_vertex:1; /**< size computed in vertex shader */
 105    unsigned multisample:1;         /* XXX maybe more ms state in future */
 106    unsigned line_smooth:1;
 107    unsigned line_stipple_enable:1;
 108    unsigned line_stipple_factor:8;  /**< [1..256] actually */
 109    unsigned line_stipple_pattern:16;
 110    unsigned line_last_pixel:1;
 111
 112    /**
 113     * Vertex coordinates are pre-transformed to screen space.  Skip
 114     * the vertex shader, clipping and viewport processing.  Note that
 115     * a vertex shader is still needed though, to indicate the mapping
 116     * from vertex elements to fragment shader input semantics.
 117     */
 118    unsigned bypass_vs_clip_and_viewport:1;
 119
 120    unsigned origin_lower_left:1;  /**< Is (0,0) the lower-left corner? */
 121    unsigned flatshade_first:1;   /**< take color attribute from the first vertex of a primitive */
 122    unsigned gl_rasterization_rules:1; /**< enable tweaks for GL rasterization?  */
 123
 124    float line_width;
 125    float point_size;           /**< used when no per-vertex size */
 126    float point_size_min;        /* XXX - temporary, will go away */
 127    float point_size_max;        /* XXX - temporary, will go away */
 128    float offset_units;
 129    float offset_scale;
 130    ubyte sprite_coord_mode[PIPE_MAX_SHADER_OUTPUTS]; /**< PIPE_SPRITE_COORD_ */
 131 };
 132
 133
 134 struct pipe_poly_stipple
 135 {
 136    unsigned stipple[32];
 137 };
 138
 139
 140 struct pipe_viewport_state
 141 {
 142    float scale[4];
 143    float translate[4];
 144 };
 145
 146
 147 struct pipe_scissor_state
 148 {
 149    unsigned minx:16;
 150    unsigned miny:16;
 151    unsigned maxx:16;
 152    unsigned maxy:16;
 153 };
 154
 155
 156 struct pipe_clip_state
 157 {
 158    float ucp[PIPE_MAX_CLIP_PLANES][4];
 159    unsigned nr;
 160 };
 161
 162
 163 /**
 164  * Constants for vertex/fragment shaders
 165  */
 166 struct pipe_constant_buffer
 167 {
 168    struct pipe_buffer *buffer;
 169 };
 170
 171
 172 struct pipe_shader_state
 173 {
 174    const struct tgsi_token *tokens;
 175 };
 176
 177
 178 struct pipe_depth_state
 179 {
 180    unsigned enabled:1;         /**< depth test enabled? */
 181    unsigned writemask:1;       /**< allow depth buffer writes? */
 182    unsigned func:3;            /**< depth test func (PIPE_FUNC_x) */
 183    unsigned occlusion_count:1; /**< do occlusion counting? */
 184 };
 185
 186
 187 struct pipe_stencil_state
 188 {
 189    unsigned enabled:1;  /**< stencil[0]: stencil enabled, stencil[1]: two-side enabled */
 190    unsigned func:3;     /**< PIPE_FUNC_x */
 191    unsigned fail_op:3;  /**< PIPE_STENCIL_OP_x */
 192    unsigned zpass_op:3; /**< PIPE_STENCIL_OP_x */
 193    unsigned zfail_op:3; /**< PIPE_STENCIL_OP_x */
 194    ubyte ref_value;
 195    ubyte valuemask;
 196    ubyte writemask;
 197 };
 198
 199
 200 struct pipe_alpha_state
 201 {
 202    unsigned enabled:1;
 203    unsigned func:3;     /**< PIPE_FUNC_x */
 204    float ref_value;     /**< reference value */
 205 };
 206
 207
 208 struct pipe_depth_stencil_alpha_state
 209 {
 210    struct pipe_depth_state depth;
 211    struct pipe_stencil_state stencil[2]; /**< [0] = front, [1] = back */
 212    struct pipe_alpha_state alpha;
 213 };
 214
 215
 216 struct pipe_blend_state
 217 {
 218    unsigned blend_enable:1;
 219
 220    unsigned rgb_func:3;          /**< PIPE_BLEND_x */
 221    unsigned rgb_src_factor:5;    /**< PIPE_BLENDFACTOR_x */
 222    unsigned rgb_dst_factor:5;    /**< PIPE_BLENDFACTOR_x */
 223
 224    unsigned alpha_func:3;        /**< PIPE_BLEND_x */
 225    unsigned alpha_src_factor:5;  /**< PIPE_BLENDFACTOR_x */
 226    unsigned alpha_dst_factor:5;  /**< PIPE_BLENDFACTOR_x */
 227
 228    unsigned logicop_enable:1;
 229    unsigned logicop_func:4;      /**< PIPE_LOGICOP_x */
 230
 231    unsigned colormask:4;         /**< bitmask of PIPE_MASK_R/G/B/A */
 232    unsigned dither:1;
 233 };
 234
 235
 236 struct pipe_blend_color
 237 {
 238    float color[4];
 239 };
 240
 241
 242 struct pipe_framebuffer_state
 243 {
 244    unsigned width, height;
 245
 246    /** multiple colorbuffers for multiple render targets */
 247    unsigned nr_cbufs;
 248    struct pipe_surface *cbufs[PIPE_MAX_COLOR_BUFS];
 249
 250    struct pipe_surface *zsbuf;      /**< Z/stencil buffer */
 251 };
 252
 253
 254 /**
 255  * Texture sampler state.
 256  */
 257 struct pipe_sampler_state
 258 {
 259    unsigned wrap_s:3;            /**< PIPE_TEX_WRAP_x */
 260    unsigned wrap_t:3;            /**< PIPE_TEX_WRAP_x */
 261    unsigned wrap_r:3;            /**< PIPE_TEX_WRAP_x */
 262    unsigned min_img_filter:2;    /**< PIPE_TEX_FILTER_x */
 263    unsigned min_mip_filter:2;    /**< PIPE_TEX_MIPFILTER_x */
 264    unsigned mag_img_filter:2;    /**< PIPE_TEX_FILTER_x */
 265    unsigned compare_mode:1;      /**< PIPE_TEX_COMPARE_x */
 266    unsigned compare_func:3;      /**< PIPE_FUNC_x */
 267    unsigned normalized_coords:1; /**< Are coords normalized to [0,1]? */
 268    unsigned prefilter:4;         /**< Wierd sampling state exposed by some api's */
 269    float shadow_ambient;         /**< shadow test fail color/intensity */
 270    float lod_bias;               /**< LOD/lambda bias */
 271    float min_lod, max_lod;       /**< LOD clamp range, after bias */
 272    float border_color[4];
 273    float max_anisotropy;
 274 };
 275
 276
 277 /**
 278  * 2D surface.  This is basically a view into a memory buffer.
 279  * May be a renderbuffer, texture mipmap level, etc.
 280  */
 281 struct pipe_surface
 282 {
 283    struct pipe_reference reference;
 284    enum pipe_format format;      /**< PIPE_FORMAT_x */
 285    unsigned status;              /**< PIPE_SURFACE_STATUS_x */
 286    unsigned clear_value;         /**< XXX may be temporary */
 287    unsigned width;               /**< logical width in pixels */
 288    unsigned height;              /**< logical height in pixels */
 289    unsigned layout;              /**< PIPE_SURFACE_LAYOUT_x */
 290    unsigned offset;              /**< offset from start of buffer, in bytes */
 291    unsigned usage;               /**< PIPE_BUFFER_USAGE_*  */
 292
 293    struct pipe_texture *texture; /**< texture into which this is a view  */
 294    unsigned face;
 295    unsigned level;
 296    unsigned zslice;
 297 };
 298
 299
 300 /**
 301  * Transfer object.  For data transfer to/from a texture.
 302  */
 303 struct pipe_transfer
 304 {
 305    enum pipe_format format;      /**< PIPE_FORMAT_x */
 306    unsigned x;                   /**< x offset from start of texture image */
 307    unsigned y;                   /**< y offset from start of texture image */
 308    unsigned width;               /**< logical width in pixels */
 309    unsigned height;              /**< logical height in pixels */
 310    struct pipe_format_block block;
 311    unsigned nblocksx;            /**< allocated width in blocks */
 312    unsigned nblocksy;            /**< allocated height in blocks */
 313    unsigned stride;              /**< stride in bytes between rows of blocks */
 314    unsigned usage;               /**< PIPE_TRANSFER_*  */
 315
 316    struct pipe_texture *texture; /**< texture to transfer to/from  */
 317    unsigned face;
 318    unsigned level;
 319    unsigned zslice;
 320 };
 321
 322
 323 /**
 324  * Texture object.
 325  */
 326 struct pipe_texture
 327 {
 328    struct pipe_reference reference;
 329
 330    enum pipe_texture_target target; /**< PIPE_TEXTURE_x */
 331    enum pipe_format format;         /**< PIPE_FORMAT_x */
 332
 333    unsigned width[PIPE_MAX_TEXTURE_LEVELS];
 334    unsigned height[PIPE_MAX_TEXTURE_LEVELS];
 335    unsigned depth[PIPE_MAX_TEXTURE_LEVELS];
 336
 337    struct pipe_format_block block;
 338    unsigned nblocksx[PIPE_MAX_TEXTURE_LEVELS]; /**< allocated width in blocks */
 339    unsigned nblocksy[PIPE_MAX_TEXTURE_LEVELS]; /**< allocated height in blocks */
 340
 341    unsigned last_level:8;    /**< Index of last mipmap level present/defined */
 342    unsigned compressed:1;
 343
 344    unsigned nr_samples:8;    /**< for multisampled surfaces, nr of samples */
 345
 346    unsigned tex_usage;       /* PIPE_TEXTURE_USAGE_* */
 347
 348    struct pipe_screen *screen; /**< screen that this texture belongs to */
 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 stride;    /**< 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 *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;
 373
 374    /** Which vertex_buffer (as given to pipe->set_vertex_buffer()) does
 375     * this attribute live in?
 376     */
 377    unsigned vertex_buffer_index:8;
 378    unsigned nr_components:8;
 379
 380    enum pipe_format src_format;            /**< PIPE_FORMAT_* */
 381 };
 382
 383
 384 /* Reference counting helper functions */
 385 static INLINE void
 386 pipe_buffer_reference(struct pipe_buffer **ptr, struct pipe_buffer *buf)
 387 {
 388    struct pipe_buffer *old_buf = *ptr;
 389
 390    if (pipe_reference((struct pipe_reference **)ptr, &buf->reference))
 391       old_buf->screen->buffer_destroy(old_buf);
 392 }
 393
 394 static INLINE void
 395 pipe_surface_reference(struct pipe_surface **ptr, struct pipe_surface *surf)
 396 {
 397    struct pipe_surface *old_surf = *ptr;
 398
 399    if (pipe_reference((struct pipe_reference **)ptr, &surf->reference))
 400       old_surf->texture->screen->tex_surface_destroy(old_surf);
 401 }
 402
 403 static INLINE void
 404 pipe_texture_reference(struct pipe_texture **ptr, struct pipe_texture *tex)
 405 {
 406    struct pipe_texture *old_tex = *ptr;
 407
 408    if (pipe_reference((struct pipe_reference **)ptr, &tex->reference))
 409       old_tex->screen->texture_destroy(old_tex);
 410 }
 411
 412
 413 #ifdef __cplusplus
 414 }
 415 #endif
 416
 417 #endif