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