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 struct pipe_shader_state
 178 {
 179    const struct tgsi_token *tokens;
 180 };
 181
 182
 183 struct pipe_depth_state
 184 {
 185    unsigned enabled:1;         /**< depth test enabled? */
 186    unsigned writemask:1;       /**< allow depth buffer writes? */
 187    unsigned func:3;            /**< depth test func (PIPE_FUNC_x) */
 188 };
 189
 190
 191 struct pipe_stencil_state
 192 {
 193    unsigned enabled:1;  /**< stencil[0]: stencil enabled, stencil[1]: two-side enabled */
 194    unsigned func:3;     /**< PIPE_FUNC_x */
 195    unsigned fail_op:3;  /**< PIPE_STENCIL_OP_x */
 196    unsigned zpass_op:3; /**< PIPE_STENCIL_OP_x */
 197    unsigned zfail_op:3; /**< PIPE_STENCIL_OP_x */
 198    ubyte ref_value;
 199    ubyte valuemask;
 200    ubyte writemask;
 201 };
 202
 203
 204 struct pipe_alpha_state
 205 {
 206    unsigned enabled:1;
 207    unsigned func:3;     /**< PIPE_FUNC_x */
 208    float ref_value;     /**< reference value */
 209 };
 210
 211
 212 struct pipe_depth_stencil_alpha_state
 213 {
 214    struct pipe_depth_state depth;
 215    struct pipe_stencil_state stencil[2]; /**< [0] = front, [1] = back */
 216    struct pipe_alpha_state alpha;
 217 };
 218
 219
 220 struct pipe_blend_state
 221 {
 222    unsigned blend_enable:1;
 223
 224    unsigned rgb_func:3;          /**< PIPE_BLEND_x */
 225    unsigned rgb_src_factor:5;    /**< PIPE_BLENDFACTOR_x */
 226    unsigned rgb_dst_factor:5;    /**< PIPE_BLENDFACTOR_x */
 227
 228    unsigned alpha_func:3;        /**< PIPE_BLEND_x */
 229    unsigned alpha_src_factor:5;  /**< PIPE_BLENDFACTOR_x */
 230    unsigned alpha_dst_factor:5;  /**< PIPE_BLENDFACTOR_x */
 231
 232    unsigned logicop_enable:1;
 233    unsigned logicop_func:4;      /**< PIPE_LOGICOP_x */
 234
 235    unsigned colormask:4;         /**< bitmask of PIPE_MASK_R/G/B/A */
 236    unsigned dither:1;
 237 };
 238
 239
 240 struct pipe_blend_color
 241 {
 242    float color[4];
 243 };
 244
 245
 246 struct pipe_framebuffer_state
 247 {
 248    unsigned width, height;
 249
 250    /** multiple colorbuffers for multiple render targets */
 251    unsigned nr_cbufs;
 252    struct pipe_surface *cbufs[PIPE_MAX_COLOR_BUFS];
 253
 254    struct pipe_surface *zsbuf;      /**< Z/stencil buffer */
 255 };
 256
 257
 258 /**
 259  * Texture sampler state.
 260  */
 261 struct pipe_sampler_state
 262 {
 263    unsigned wrap_s:3;            /**< PIPE_TEX_WRAP_x */
 264    unsigned wrap_t:3;            /**< PIPE_TEX_WRAP_x */
 265    unsigned wrap_r:3;            /**< PIPE_TEX_WRAP_x */
 266    unsigned min_img_filter:2;    /**< PIPE_TEX_FILTER_x */
 267    unsigned min_mip_filter:2;    /**< PIPE_TEX_MIPFILTER_x */
 268    unsigned mag_img_filter:2;    /**< PIPE_TEX_FILTER_x */
 269    unsigned compare_mode:1;      /**< PIPE_TEX_COMPARE_x */
 270    unsigned compare_func:3;      /**< PIPE_FUNC_x */
 271    unsigned normalized_coords:1; /**< Are coords normalized to [0,1]? */
 272    unsigned prefilter:4;         /**< Wierd sampling state exposed by some api's */
 273    float lod_bias;               /**< LOD/lambda bias */
 274    float min_lod, max_lod;       /**< LOD clamp range, after bias */
 275    float border_color[4];
 276    float max_anisotropy;
 277 };
 278
 279
 280 /**
 281  * 2D surface.  This is basically a view into a memory buffer.
 282  * May be a renderbuffer, texture mipmap level, etc.
 283  */
 284 struct pipe_surface
 285 {
 286    struct pipe_reference reference;
 287    enum pipe_format format;      /**< PIPE_FORMAT_x */
 288    unsigned width;               /**< logical width in pixels */
 289    unsigned height;              /**< logical height in pixels */
 290    unsigned layout;              /**< PIPE_SURFACE_LAYOUT_x */
 291    unsigned offset;              /**< offset from start of buffer, in bytes */
 292    unsigned usage;               /**< PIPE_BUFFER_USAGE_*  */
 293
 294    unsigned zslice;
 295    struct pipe_texture *texture; /**< texture into which this is a view  */
 296    unsigned face;
 297    unsigned level;
 298 };
 299
 300
 301 /**
 302  * Transfer object.  For data transfer to/from a texture.
 303  */
 304 struct pipe_transfer
 305 {
 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    unsigned stride;              /**< stride in bytes between rows of blocks */
 311    enum pipe_transfer_usage usage; /**< PIPE_TRANSFER_*  */
 312
 313    struct pipe_texture *texture; /**< texture to transfer to/from  */
 314    unsigned face;
 315    unsigned level;
 316    unsigned zslice;
 317 };
 318
 319
 320 /**
 321  * Texture object.
 322  */
 323 struct pipe_texture
 324 {
 325    struct pipe_reference reference;
 326
 327    enum pipe_texture_target target; /**< PIPE_TEXTURE_x */
 328    enum pipe_format format;         /**< PIPE_FORMAT_x */
 329
 330    unsigned width0;
 331    unsigned height0;
 332    unsigned depth0;
 333
 334    unsigned last_level:8;    /**< Index of last mipmap level present/defined */
 335
 336    unsigned nr_samples:8;    /**< for multisampled surfaces, nr of samples */
 337
 338    unsigned tex_usage;       /* PIPE_TEXTURE_USAGE_* */
 339
 340    struct pipe_screen *screen; /**< screen that this texture belongs to */
 341 };
 342
 343
 344 /**
 345  * A vertex buffer.  Typically, all the vertex data/attributes for
 346  * drawing something will be in one buffer.  But it's also possible, for
 347  * example, to put colors in one buffer and texcoords in another.
 348  */
 349 struct pipe_vertex_buffer
 350 {
 351    unsigned stride;    /**< stride to same attrib in next vertex, in bytes */
 352    unsigned max_index;   /**< number of vertices in this buffer */
 353    unsigned buffer_offset;  /**< offset to start of data in buffer, in bytes */
 354    struct pipe_buffer *buffer;  /**< the actual buffer */
 355 };
 356
 357
 358 /**
 359  * Information to describe a vertex attribute (position, color, etc)
 360  */
 361 struct pipe_vertex_element
 362 {
 363    /** Offset of this attribute, in bytes, from the start of the vertex */
 364    unsigned src_offset;
 365
 366    /** Instance data rate divisor. 0 means this is per-vertex data,
 367     *  n means per-instance data used for n consecutive instances (n > 0).
 368     */
 369    unsigned instance_divisor;
 370
 371    /** Which vertex_buffer (as given to pipe->set_vertex_buffer()) does
 372     * this attribute live in?
 373     */
 374    unsigned vertex_buffer_index:8;
 375    unsigned nr_components:8;
 376
 377    enum pipe_format src_format;            /**< PIPE_FORMAT_* */
 378 };
 379
 380
 381 /* Reference counting helper functions */
 382 static INLINE void
 383 pipe_buffer_reference(struct pipe_buffer **ptr, struct pipe_buffer *buf)
 384 {
 385    struct pipe_buffer *old_buf = *ptr;
 386
 387    if (pipe_reference(&(*ptr)->reference, &buf->reference))
 388       old_buf->screen->buffer_destroy(old_buf);
 389    *ptr = buf;
 390 }
 391
 392 static INLINE void
 393 pipe_surface_reference(struct pipe_surface **ptr, struct pipe_surface *surf)
 394 {
 395    struct pipe_surface *old_surf = *ptr;
 396
 397    if (pipe_reference(&(*ptr)->reference, &surf->reference))
 398       old_surf->texture->screen->tex_surface_destroy(old_surf);
 399    *ptr = surf;
 400 }
 401
 402 static INLINE void
 403 pipe_texture_reference(struct pipe_texture **ptr, struct pipe_texture *tex)
 404 {
 405    struct pipe_texture *old_tex = *ptr;
 406
 407    if (pipe_reference(&(*ptr)->reference, &tex->reference))
 408       old_tex->screen->texture_destroy(old_tex);
 409    *ptr = tex;
 410 }
 411
 412
 413 #ifdef __cplusplus
 414 }
 415 #endif
 416
 417 #endif