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