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_screen.h"
  47
  48
  49 #ifdef __cplusplus
  50 extern "C" {
  51 #endif
  52
  53
  54 /**
  55  * Implementation limits
  56  */
  57 #define PIPE_MAX_ATTRIBS          32
  58 #define PIPE_MAX_CLIP_PLANES       6
  59 #define PIPE_MAX_COLOR_BUFS        8
  60 #define PIPE_MAX_CONSTANT_BUFFERS 32
  61 #define PIPE_MAX_SAMPLERS         16
  62 #define PIPE_MAX_VERTEX_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 struct pipe_reference
  69 {
  70    int32_t count; /* atomic */
  71 };
  72
  73
  74 /**
  75  * The driver will certainly subclass this to include actual memory
  76  * management information.
  77  */
  78 struct pipe_buffer
  79 {
  80    struct pipe_reference  reference;
  81    unsigned               size;
  82    struct pipe_screen    *screen;
  83    unsigned               alignment;
  84    unsigned               usage;
  85 };
  86
  87
  88 /**
  89  * Primitive (point/line/tri) rasterization info
  90  */
  91 struct pipe_rasterizer_state
  92 {
  93    unsigned flatshade:1;
  94    unsigned light_twoside:1;
  95    unsigned front_winding:2;  /**< PIPE_WINDING_x */
  96    unsigned cull_mode:2;      /**< PIPE_WINDING_x */
  97    unsigned fill_cw:2;        /**< PIPE_POLYGON_MODE_x */
  98    unsigned fill_ccw:2;       /**< PIPE_POLYGON_MODE_x */
  99    unsigned offset_cw:1;
 100    unsigned offset_ccw:1;
 101    unsigned scissor:1;
 102    unsigned poly_smooth:1;
 103    unsigned poly_stipple_enable:1;
 104    unsigned point_smooth:1;
 105    unsigned sprite_coord_enable:PIPE_MAX_SHADER_OUTPUTS;
 106    unsigned sprite_coord_mode:1;     /**< PIPE_SPRITE_COORD_ */
 107    unsigned point_quad_rasterization:1; /** points rasterized as quads or points */
 108    unsigned point_size_per_vertex:1; /**< size computed in vertex shader */
 109    unsigned multisample:1;         /* XXX maybe more ms state in future */
 110    unsigned line_smooth:1;
 111    unsigned line_stipple_enable:1;
 112    unsigned line_stipple_factor:8;  /**< [1..256] actually */
 113    unsigned line_stipple_pattern:16;
 114    unsigned line_last_pixel:1;
 115
 116    /**
 117     * Vertex coordinates are pre-transformed to screen space.  Skip
 118     * the vertex shader, clipping and viewport processing.  Note that
 119     * a vertex shader is still needed though, to indicate the mapping
 120     * from vertex elements to fragment shader input semantics.
 121     *
 122     * XXX: considered for removal.
 123     */
 124    unsigned bypass_vs_clip_and_viewport:1;
 125
 126    /**
 127     * Use the first vertex of a primitive as the provoking vertex for
 128     * flat shading.
 129     */
 130    unsigned flatshade_first:1;
 131
 132    /**
 133     * When true, triangle rasterization uses (0.5, 0.5) pixel centers
 134     * for determining pixel ownership.
 135     *
 136     * When false, triangle rasterization uses (0,0) pixel centers for
 137     * determining pixel ownership.
 138     *
 139     * Triangle rasterization always uses a 'top,left' rule for pixel
 140     * ownership, this just alters which point we consider the pixel
 141     * center for that test.
 142     */
 143    unsigned gl_rasterization_rules:1;
 144
 145    float line_width;
 146    float point_size;           /**< used when no per-vertex size */
 147    float offset_units;
 148    float offset_scale;
 149 };
 150
 151
 152 struct pipe_poly_stipple
 153 {
 154    unsigned stipple[32];
 155 };
 156
 157
 158 struct pipe_viewport_state
 159 {
 160    float scale[4];
 161    float translate[4];
 162 };
 163
 164
 165 struct pipe_scissor_state
 166 {
 167    unsigned minx:16;
 168    unsigned miny:16;
 169    unsigned maxx:16;
 170    unsigned maxy:16;
 171 };
 172
 173
 174 struct pipe_clip_state
 175 {
 176    float ucp[PIPE_MAX_CLIP_PLANES][4];
 177    unsigned nr;
 178 };
 179
 180
 181 struct pipe_shader_state
 182 {
 183    const struct tgsi_token *tokens;
 184 };
 185
 186
 187 struct pipe_depth_state
 188 {
 189    unsigned enabled:1;         /**< depth test enabled? */
 190    unsigned writemask:1;       /**< allow depth buffer writes? */
 191    unsigned func:3;            /**< depth test func (PIPE_FUNC_x) */
 192 };
 193
 194
 195 struct pipe_stencil_state
 196 {
 197    unsigned enabled:1;  /**< stencil[0]: stencil enabled, stencil[1]: two-side enabled */
 198    unsigned func:3;     /**< PIPE_FUNC_x */
 199    unsigned fail_op:3;  /**< PIPE_STENCIL_OP_x */
 200    unsigned zpass_op:3; /**< PIPE_STENCIL_OP_x */
 201    unsigned zfail_op:3; /**< PIPE_STENCIL_OP_x */
 202    ubyte ref_value;
 203    ubyte valuemask;
 204    ubyte writemask;
 205 };
 206
 207
 208 struct pipe_alpha_state
 209 {
 210    unsigned enabled:1;
 211    unsigned func:3;     /**< PIPE_FUNC_x */
 212    float ref_value;     /**< reference value */
 213 };
 214
 215
 216 struct pipe_depth_stencil_alpha_state
 217 {
 218    struct pipe_depth_state depth;
 219    struct pipe_stencil_state stencil[2]; /**< [0] = front, [1] = back */
 220    struct pipe_alpha_state alpha;
 221 };
 222
 223
 224 struct pipe_rt_blend_state
 225 {
 226    unsigned blend_enable:1;
 227
 228    unsigned rgb_func:3;          /**< PIPE_BLEND_x */
 229    unsigned rgb_src_factor:5;    /**< PIPE_BLENDFACTOR_x */
 230    unsigned rgb_dst_factor:5;    /**< PIPE_BLENDFACTOR_x */
 231
 232    unsigned alpha_func:3;        /**< PIPE_BLEND_x */
 233    unsigned alpha_src_factor:5;  /**< PIPE_BLENDFACTOR_x */
 234    unsigned alpha_dst_factor:5;  /**< PIPE_BLENDFACTOR_x */
 235
 236    unsigned colormask:4;         /**< bitmask of PIPE_MASK_R/G/B/A */
 237 };
 238
 239 struct pipe_blend_state
 240 {
 241    unsigned independent_blend_enable:1;
 242    unsigned logicop_enable:1;
 243    unsigned logicop_func:4;      /**< PIPE_LOGICOP_x */
 244    unsigned dither:1;
 245    struct pipe_rt_blend_state rt[PIPE_MAX_COLOR_BUFS];
 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    float lod_bias;               /**< LOD/lambda bias */
 282    float min_lod, max_lod;       /**< LOD clamp range, after bias */
 283    float border_color[4];
 284    float max_anisotropy;
 285 };
 286
 287
 288 /**
 289  * 2D surface.  This is basically a view into a memory buffer.
 290  * May be a renderbuffer, texture mipmap level, etc.
 291  */
 292 struct pipe_surface
 293 {
 294    struct pipe_reference reference;
 295    enum pipe_format format;      /**< PIPE_FORMAT_x */
 296    unsigned width;               /**< logical width in pixels */
 297    unsigned height;              /**< logical height in pixels */
 298    unsigned layout;              /**< PIPE_SURFACE_LAYOUT_x */
 299    unsigned offset;              /**< offset from start of buffer, in bytes */
 300    unsigned usage;               /**< PIPE_BUFFER_USAGE_*  */
 301
 302    unsigned zslice;
 303    struct pipe_texture *texture; /**< texture into which this is a view  */
 304    unsigned face;
 305    unsigned level;
 306 };
 307
 308
 309 /**
 310  * Transfer object.  For data transfer to/from a texture.
 311  */
 312 struct pipe_transfer
 313 {
 314    unsigned x;                   /**< x offset from start of texture image */
 315    unsigned y;                   /**< y offset from start of texture image */
 316    unsigned width;               /**< logical width in pixels */
 317    unsigned height;              /**< logical height in pixels */
 318    unsigned stride;              /**< stride in bytes between rows of blocks */
 319    enum pipe_transfer_usage usage; /**< PIPE_TRANSFER_*  */
 320
 321    struct pipe_texture *texture; /**< texture to transfer to/from  */
 322    unsigned face;
 323    unsigned level;
 324    unsigned zslice;
 325 };
 326
 327
 328 /**
 329  * Texture object.
 330  */
 331 struct pipe_texture
 332 {
 333    struct pipe_reference reference;
 334
 335    enum pipe_texture_target target; /**< PIPE_TEXTURE_x */
 336    enum pipe_format format;         /**< PIPE_FORMAT_x */
 337
 338    unsigned width0;
 339    unsigned height0;
 340    unsigned depth0;
 341
 342    unsigned last_level:8;    /**< Index of last mipmap level present/defined */
 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    /** Instance data rate divisor. 0 means this is per-vertex data,
 375     *  n means per-instance data used for n consecutive instances (n > 0).
 376     */
 377    unsigned instance_divisor;
 378
 379    /** Which vertex_buffer (as given to pipe->set_vertex_buffer()) does
 380     * this attribute live in?
 381     */
 382    unsigned vertex_buffer_index:8;
 383    unsigned nr_components:8;
 384
 385    enum pipe_format src_format;            /**< PIPE_FORMAT_* */
 386 };
 387
 388
 389 #ifdef __cplusplus
 390 }
 391 #endif
 392
 393 #endif