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