workbench/libs/mesa/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_BUFFERS 32
  60 #define PIPE_MAX_SAMPLERS         16
  61 #define PIPE_MAX_VERTEX_SAMPLERS  16
  62 #define PIPE_MAX_GEOMETRY_SAMPLERS  16
  63 #define PIPE_MAX_SHADER_INPUTS    32
  64 #define PIPE_MAX_SHADER_OUTPUTS   32
  65 #define PIPE_MAX_SHADER_RESOURCES 32
  66 #define PIPE_MAX_TEXTURE_LEVELS   16
  67 #define PIPE_MAX_SO_BUFFERS        4
  68
  69
  70 struct pipe_reference
  71 {
  72    int32_t count; /* atomic */
  73 };
  74
  75
  76
  77 /**
  78  * Primitive (point/line/tri) rasterization info
  79  */
  80 struct pipe_rasterizer_state
  81 {
  82    unsigned flatshade:1;
  83    unsigned light_twoside:1;
  84    unsigned clamp_vertex_color:1;
  85    unsigned clamp_fragment_color:1;
  86    unsigned front_ccw:1;
  87    unsigned cull_face:2;      /**< PIPE_FACE_x */
  88    unsigned fill_front:2;     /**< PIPE_POLYGON_MODE_x */
  89    unsigned fill_back:2;      /**< PIPE_POLYGON_MODE_x */
  90    unsigned offset_point:1;
  91    unsigned offset_line:1;
  92    unsigned offset_tri:1;
  93    unsigned scissor:1;
  94    unsigned poly_smooth:1;
  95    unsigned poly_stipple_enable:1;
  96    unsigned point_smooth:1;
  97    unsigned sprite_coord_mode:1;     /**< PIPE_SPRITE_COORD_ */
  98    unsigned point_quad_rasterization:1; /** points rasterized as quads or points */
  99    unsigned point_size_per_vertex:1; /**< size computed in vertex shader */
 100    unsigned multisample:1;         /* XXX maybe more ms state in future */
 101    unsigned line_smooth:1;
 102    unsigned line_stipple_enable:1;
 103    unsigned line_last_pixel:1;
 104
 105    /**
 106     * Use the first vertex of a primitive as the provoking vertex for
 107     * flat shading.
 108     */
 109    unsigned flatshade_first:1;
 110
 111    /**
 112     * When true, triangle rasterization uses (0.5, 0.5) pixel centers
 113     * for determining pixel ownership.
 114     *
 115     * When false, triangle rasterization uses (0,0) pixel centers for
 116     * determining pixel ownership.
 117     *
 118     * Triangle rasterization always uses a 'top,left' rule for pixel
 119     * ownership, this just alters which point we consider the pixel
 120     * center for that test.
 121     */
 122    unsigned gl_rasterization_rules:1;
 123
 124    unsigned line_stipple_factor:8;  /**< [1..256] actually */
 125    unsigned line_stipple_pattern:16;
 126
 127    unsigned sprite_coord_enable:PIPE_MAX_SHADER_OUTPUTS;
 128
 129    float line_width;
 130    float point_size;           /**< used when no per-vertex size */
 131    float offset_units;
 132    float offset_scale;
 133 };
 134
 135
 136 struct pipe_poly_stipple
 137 {
 138    unsigned stipple[32];
 139 };
 140
 141
 142 struct pipe_viewport_state
 143 {
 144    float scale[4];
 145    float translate[4];
 146 };
 147
 148
 149 struct pipe_scissor_state
 150 {
 151    unsigned minx:16;
 152    unsigned miny:16;
 153    unsigned maxx:16;
 154    unsigned maxy:16;
 155 };
 156
 157
 158 struct pipe_clip_state
 159 {
 160    float ucp[PIPE_MAX_CLIP_PLANES][4];
 161    unsigned nr;
 162    unsigned depth_clamp:1;
 163 };
 164
 165
 166 struct pipe_shader_state
 167 {
 168    const struct tgsi_token *tokens;
 169 };
 170
 171
 172 struct pipe_depth_state
 173 {
 174    unsigned enabled:1;         /**< depth test enabled? */
 175    unsigned writemask:1;       /**< allow depth buffer writes? */
 176    unsigned func:3;            /**< depth test func (PIPE_FUNC_x) */
 177 };
 178
 179
 180 struct pipe_stencil_state
 181 {
 182    unsigned enabled:1;  /**< stencil[0]: stencil enabled, stencil[1]: two-side enabled */
 183    unsigned func:3;     /**< PIPE_FUNC_x */
 184    unsigned fail_op:3;  /**< PIPE_STENCIL_OP_x */
 185    unsigned zpass_op:3; /**< PIPE_STENCIL_OP_x */
 186    unsigned zfail_op:3; /**< PIPE_STENCIL_OP_x */
 187    unsigned valuemask:8;
 188    unsigned writemask:8;
 189 };
 190
 191
 192 struct pipe_alpha_state
 193 {
 194    unsigned enabled:1;
 195    unsigned func:3;     /**< PIPE_FUNC_x */
 196    float ref_value;     /**< reference value */
 197 };
 198
 199
 200 struct pipe_depth_stencil_alpha_state
 201 {
 202    struct pipe_depth_state depth;
 203    struct pipe_stencil_state stencil[2]; /**< [0] = front, [1] = back */
 204    struct pipe_alpha_state alpha;
 205 };
 206
 207
 208 struct pipe_rt_blend_state
 209 {
 210    unsigned blend_enable:1;
 211
 212    unsigned rgb_func:3;          /**< PIPE_BLEND_x */
 213    unsigned rgb_src_factor:5;    /**< PIPE_BLENDFACTOR_x */
 214    unsigned rgb_dst_factor:5;    /**< PIPE_BLENDFACTOR_x */
 215
 216    unsigned alpha_func:3;        /**< PIPE_BLEND_x */
 217    unsigned alpha_src_factor:5;  /**< PIPE_BLENDFACTOR_x */
 218    unsigned alpha_dst_factor:5;  /**< PIPE_BLENDFACTOR_x */
 219
 220    unsigned colormask:4;         /**< bitmask of PIPE_MASK_R/G/B/A */
 221 };
 222
 223 struct pipe_blend_state
 224 {
 225    unsigned independent_blend_enable:1;
 226    unsigned logicop_enable:1;
 227    unsigned logicop_func:4;      /**< PIPE_LOGICOP_x */
 228    unsigned dither:1;
 229    unsigned alpha_to_coverage:1;
 230    unsigned alpha_to_one:1;
 231    struct pipe_rt_blend_state rt[PIPE_MAX_COLOR_BUFS];
 232 };
 233
 234
 235 struct pipe_blend_color
 236 {
 237    float color[4];
 238 };
 239
 240 struct pipe_stencil_ref
 241 {
 242    ubyte ref_value[2];
 243 };
 244
 245 struct pipe_framebuffer_state
 246 {
 247    unsigned width, height;
 248
 249    /** multiple color buffers for multiple render targets */
 250    unsigned nr_cbufs;
 251    struct pipe_surface *cbufs[PIPE_MAX_COLOR_BUFS];
 252
 253    struct pipe_surface *zsbuf;      /**< Z/stencil buffer */
 254 };
 255
 256
 257 /**
 258  * Texture sampler state.
 259  */
 260 struct pipe_sampler_state
 261 {
 262    unsigned wrap_s:3;            /**< PIPE_TEX_WRAP_x */
 263    unsigned wrap_t:3;            /**< PIPE_TEX_WRAP_x */
 264    unsigned wrap_r:3;            /**< PIPE_TEX_WRAP_x */
 265    unsigned min_img_filter:2;    /**< PIPE_TEX_FILTER_x */
 266    unsigned min_mip_filter:2;    /**< PIPE_TEX_MIPFILTER_x */
 267    unsigned mag_img_filter:2;    /**< PIPE_TEX_FILTER_x */
 268    unsigned compare_mode:1;      /**< PIPE_TEX_COMPARE_x */
 269    unsigned compare_func:3;      /**< PIPE_FUNC_x */
 270    unsigned normalized_coords:1; /**< Are coords normalized to [0,1]? */
 271    unsigned max_anisotropy:6;
 272    unsigned seamless_cube_map:1;
 273    float lod_bias;               /**< LOD/lambda bias */
 274    float min_lod, max_lod;       /**< LOD clamp range, after bias */
 275    float border_color[4];
 276 };
 277
 278
 279 /**
 280  * A view into a texture that can be bound to a color render target /
 281  * depth stencil attachment point.
 282  */
 283 struct pipe_surface
 284 {
 285    struct pipe_reference reference;
 286    struct pipe_resource *texture; /**< resource into which this is a view  */
 287    struct pipe_context *context; /**< context this view belongs to */
 288    enum pipe_format format;
 289
 290    /* XXX width/height should be removed */
 291    unsigned width;               /**< logical width in pixels */
 292    unsigned height;              /**< logical height in pixels */
 293
 294    unsigned usage;               /**< bitmask of PIPE_BIND_x */
 295
 296    union {
 297       struct {
 298          unsigned level;
 299          unsigned first_layer:16;
 300          unsigned last_layer:16;
 301       } tex;
 302       struct {
 303          unsigned first_element;
 304          unsigned last_element;
 305       } buf;
 306    } u;
 307 };
 308
 309
 310 /**
 311  * A view into a texture that can be bound to a shader stage.
 312  */
 313 struct pipe_sampler_view
 314 {
 315    struct pipe_reference reference;
 316    enum pipe_format format;      /**< typed PIPE_FORMAT_x */
 317    struct pipe_resource *texture; /**< texture into which this is a view  */
 318    struct pipe_context *context; /**< context this view belongs to */
 319    union {
 320       struct {
 321          unsigned first_layer:16;     /**< first layer to use for array textures */
 322          unsigned last_layer:16;      /**< last layer to use for array textures */
 323          unsigned first_level:8;      /**< first mipmap level to use */
 324          unsigned last_level:8;       /**< last mipmap level to use */
 325       } tex;
 326       struct {
 327          unsigned first_element;
 328          unsigned last_element;
 329       } buf;
 330    } u;
 331    unsigned swizzle_r:3;         /**< PIPE_SWIZZLE_x for red component */
 332    unsigned swizzle_g:3;         /**< PIPE_SWIZZLE_x for green component */
 333    unsigned swizzle_b:3;         /**< PIPE_SWIZZLE_x for blue component */
 334    unsigned swizzle_a:3;         /**< PIPE_SWIZZLE_x for alpha component */
 335 };
 336
 337
 338 /**
 339  * Subregion of 1D/2D/3D image resource.
 340  */
 341 struct pipe_box
 342 {
 343    unsigned x;
 344    unsigned y;
 345    unsigned z;
 346    unsigned width;
 347    unsigned height;
 348    unsigned depth;
 349 };
 350
 351
 352 /**
 353  * A memory object/resource such as a vertex buffer or texture.
 354  */
 355 struct pipe_resource
 356 {
 357    struct pipe_reference reference;
 358    struct pipe_screen *screen; /**< screen that this texture belongs to */
 359    enum pipe_texture_target target; /**< PIPE_TEXTURE_x */
 360    enum pipe_format format;         /**< PIPE_FORMAT_x */
 361
 362    unsigned width0;
 363    unsigned height0;
 364    unsigned depth0;
 365    unsigned array_size;
 366
 367    unsigned last_level:8;    /**< Index of last mipmap level present/defined */
 368    unsigned nr_samples:8;    /**< for multisampled surfaces, nr of samples */
 369    unsigned usage:8;         /**< PIPE_USAGE_x (not a bitmask) */
 370
 371    unsigned bind;            /**< bitmask of PIPE_BIND_x */
 372    unsigned flags;           /**< bitmask of PIPE_RESOURCE_FLAG_x */
 373 };
 374
 375
 376 /**
 377  * Stream output for vertex transform feedback.
 378  */
 379 struct pipe_stream_output_state
 380 {
 381    /** number of the output buffer to insert each element into */
 382    int output_buffer[PIPE_MAX_SHADER_OUTPUTS];
 383    /** which register to grab each output from */
 384    int register_index[PIPE_MAX_SHADER_OUTPUTS];
 385    /** TGSI_WRITEMASK signifying which components to output */
 386    ubyte register_mask[PIPE_MAX_SHADER_OUTPUTS];
 387    /** number of outputs */
 388    int num_outputs;
 389    /** stride for an entire vertex, only used if all output_buffers are 0 */
 390    unsigned stride;
 391 };
 392
 393
 394 /**
 395  * Transfer object.  For data transfer to/from a resource.
 396  */
 397 struct pipe_transfer
 398 {
 399    struct pipe_resource *resource; /**< resource to transfer to/from  */
 400    unsigned level;                 /**< texture mipmap level */
 401    enum pipe_transfer_usage usage;
 402    struct pipe_box box;            /**< region of the resource to access */
 403    unsigned stride;                /**< row stride in bytes */
 404    unsigned layer_stride;          /**< image/layer stride in bytes */
 405    void *data;
 406 };
 407
 408
 409
 410 /**
 411  * A vertex buffer.  Typically, all the vertex data/attributes for
 412  * drawing something will be in one buffer.  But it's also possible, for
 413  * example, to put colors in one buffer and texcoords in another.
 414  */
 415 struct pipe_vertex_buffer
 416 {
 417    unsigned stride;    /**< stride to same attrib in next vertex, in bytes */
 418    unsigned buffer_offset;  /**< offset to start of data in buffer, in bytes */
 419    struct pipe_resource *buffer;  /**< the actual buffer */
 420 };
 421
 422
 423 /**
 424  * Information to describe a vertex attribute (position, color, etc)
 425  */
 426 struct pipe_vertex_element
 427 {
 428    /** Offset of this attribute, in bytes, from the start of the vertex */
 429    unsigned src_offset;
 430
 431    /** Instance data rate divisor. 0 means this is per-vertex data,
 432     *  n means per-instance data used for n consecutive instances (n > 0).
 433     */
 434    unsigned instance_divisor;
 435
 436    /** Which vertex_buffer (as given to pipe->set_vertex_buffer()) does
 437     * this attribute live in?
 438     */
 439    unsigned vertex_buffer_index;
 440
 441    enum pipe_format src_format;
 442 };
 443
 444
 445 /**
 446  * An index buffer.  When an index buffer is bound, all indices to vertices
 447  * will be looked up in the buffer.
 448  */
 449 struct pipe_index_buffer
 450 {
 451    unsigned index_size;  /**< size of an index, in bytes */
 452    unsigned offset;  /**< offset to start of data in buffer, in bytes */
 453    struct pipe_resource *buffer; /**< the actual buffer */
 454 };
 455
 456
 457 /**
 458  * Information to describe a draw_vbo call.
 459  */
 460 struct pipe_draw_info
 461 {
 462    boolean indexed;  /**< use index buffer */
 463
 464    unsigned mode;  /**< the mode of the primitive */
 465    unsigned start;  /**< the index of the first vertex */
 466    unsigned count;  /**< number of vertices */
 467
 468    unsigned start_instance; /**< first instance id */
 469    unsigned instance_count; /**< number of instances */
 470
 471    /**
 472     * For indexed drawing, these fields apply after index lookup.
 473     */
 474    int index_bias; /**< a bias to be added to each index */
 475    unsigned min_index; /**< the min index */
 476    unsigned max_index; /**< the max index */
 477
 478    /**
 479     * Primitive restart enable/index (only applies to indexed drawing)
 480     */
 481    boolean primitive_restart;
 482    unsigned restart_index;
 483 };
 484
 485
 486 #ifdef __cplusplus
 487 }
 488 #endif
 489
 490 #endif