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