src/mesa/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  * Abstract graphics pipe state objects.
  31  *
  32  * Basic notes:
  33  *   1. Want compact representations, so we use bitfields.
  34  *   2. Put bitfields before other (GLfloat) fields.
  35  */
  36
  37
  38 #ifndef PIPE_STATE_H
  39 #define PIPE_STATE_H
  40
  41 #include "p_compiler.h"
  42 #include "p_format.h"
  43
  44 /**
  45  * Implementation limits
  46  */
  47 #define PIPE_MAX_SAMPLERS     8
  48 #define PIPE_MAX_CLIP_PLANES  6
  49 #define PIPE_MAX_CONSTANT    32
  50 #define PIPE_ATTRIB_MAX      32
  51 #define PIPE_MAX_COLOR_BUFS   8
  52 #define PIPE_MAX_TEXTURE_LEVELS  16
  53 #define PIPE_MAX_FEEDBACK_ATTRIBS 16
  54 #define PIPE_MAX_SHADER_INPUTS 16
  55 #define PIPE_MAX_SHADER_OUTPUTS 16
  56
  57
  58 /* fwd decl */
  59 struct pipe_surface;
  60
  61 /* opaque type */
  62 struct pipe_buffer_handle;
  63
  64 struct pipe_winsys;
  65
  66
  67 /***
  68  *** State objects
  69  ***/
  70
  71
  72 /**
  73  * Primitive (point/line/tri) rasterization info
  74  */
  75 struct pipe_rasterizer_state
  76 {
  77    unsigned flatshade:1;
  78    unsigned light_twoside:1;
  79    unsigned front_winding:2;  /**< PIPE_WINDING_x */
  80    unsigned cull_mode:2;      /**< PIPE_WINDING_x */
  81    unsigned fill_cw:2;        /**< PIPE_POLYGON_MODE_x */
  82    unsigned fill_ccw:2;       /**< PIPE_POLYGON_MODE_x */
  83    unsigned offset_cw:1;
  84    unsigned offset_ccw:1;
  85    unsigned scissor:1;
  86    unsigned poly_smooth:1;
  87    unsigned poly_stipple_enable:1;
  88    unsigned point_smooth:1;
  89    unsigned point_sprite:1;
  90    unsigned point_size_per_vertex:1; /**< size computed in vertex shader */
  91    unsigned multisample:1;         /* XXX maybe more ms state in future */
  92    unsigned line_smooth:1;
  93    unsigned line_stipple_enable:1;
  94    unsigned line_stipple_factor:8;  /**< [1..256] actually */
  95    unsigned line_stipple_pattern:16;
  96    unsigned bypass_clipping:1;
  97
  98    float line_width;
  99    float point_size;           /**< used when no per-vertex size */
 100    float offset_units;
 101    float offset_scale;
 102    ubyte sprite_coord_mode[PIPE_MAX_SHADER_OUTPUTS]; /**< PIPE_SPRITE_COORD_ */
 103 };
 104
 105
 106 struct pipe_poly_stipple {
 107    unsigned stipple[32];
 108 };
 109
 110
 111 struct pipe_viewport_state {
 112    float scale[4];
 113    float translate[4];
 114 };
 115
 116 struct pipe_scissor_state {
 117    unsigned minx:16;
 118    unsigned miny:16;
 119    unsigned maxx:16;
 120    unsigned maxy:16;
 121 };
 122
 123 struct pipe_clip_state {
 124    float ucp[PIPE_MAX_CLIP_PLANES][4];
 125    unsigned nr;
 126 };
 127
 128
 129 /**
 130  * Constants for vertex/fragment shaders
 131  */
 132 struct pipe_constant_buffer {
 133    struct pipe_buffer_handle *buffer;
 134    unsigned size;    /** in bytes */
 135 };
 136
 137
 138 struct pipe_shader_state {
 139    const struct tgsi_token *tokens;
 140    ubyte num_inputs;
 141    ubyte num_outputs;
 142    ubyte input_map[PIPE_MAX_SHADER_INPUTS]; /* XXX this may be temporary */
 143    ubyte input_semantic_name[PIPE_MAX_SHADER_INPUTS]; /**< TGSI_SEMANTIC_x */
 144    ubyte input_semantic_index[PIPE_MAX_SHADER_INPUTS];
 145    ubyte output_semantic_name[PIPE_MAX_SHADER_OUTPUTS]; /**< TGSI_SEMANTIC_x */
 146    ubyte output_semantic_index[PIPE_MAX_SHADER_OUTPUTS];
 147 };
 148
 149 struct pipe_depth_stencil_state
 150 {
 151    struct {
 152       unsigned enabled:1;   /**< depth test enabled? */
 153       unsigned writemask:1; /**< allow depth buffer writes? */
 154       unsigned func:3;      /**< depth test func (PIPE_FUNC_x) */
 155       unsigned occlusion_count:1; /**< XXX move this elsewhere? */
 156    } depth;
 157    struct {
 158       unsigned front_enabled:1;
 159       unsigned front_func:3;     /**< PIPE_FUNC_x */
 160       unsigned front_fail_op:3;  /**< PIPE_STENCIL_OP_x */
 161       unsigned front_zpass_op:3; /**< PIPE_STENCIL_OP_x */
 162       unsigned front_zfail_op:3; /**< PIPE_STENCIL_OP_x */
 163       unsigned back_enabled:1;
 164       unsigned back_func:3;      /**< PIPE_FUNC_x */
 165       unsigned back_fail_op:3;   /**< PIPE_STENCIL_OP_x */
 166       unsigned back_zpass_op:3;  /**< PIPE_STENCIL_OP_x */
 167       unsigned back_zfail_op:3;  /**< PIPE_STENCIL_OP_x */
 168       ubyte ref_value[2];    /**< [0] = front, [1] = back */
 169       ubyte value_mask[2];
 170       ubyte write_mask[2];
 171    } stencil;
 172 };
 173
 174 struct pipe_alpha_test_state {
 175    unsigned enabled:1;
 176    unsigned func:3;    /**< PIPE_FUNC_x */
 177    float ref;      /**< reference value */
 178 };
 179
 180 struct pipe_blend_state {
 181    unsigned blend_enable:1;
 182
 183    unsigned rgb_func:3;          /**< PIPE_BLEND_x */
 184    unsigned rgb_src_factor:5;    /**< PIPE_BLENDFACTOR_x */
 185    unsigned rgb_dst_factor:5;    /**< PIPE_BLENDFACTOR_x */
 186
 187    unsigned alpha_func:3;        /**< PIPE_BLEND_x */
 188    unsigned alpha_src_factor:5;  /**< PIPE_BLENDFACTOR_x */
 189    unsigned alpha_dst_factor:5;  /**< PIPE_BLENDFACTOR_x */
 190
 191    unsigned logicop_enable:1;
 192    unsigned logicop_func:4;      /**< PIPE_LOGICOP_x */
 193
 194    unsigned colormask:4;         /**< bitmask of PIPE_MASK_R/G/B/A */
 195    unsigned dither:1;
 196 };
 197
 198 struct pipe_blend_color {
 199    float color[4];
 200 };
 201
 202 struct pipe_framebuffer_state
 203 {
 204    /** multiple colorbuffers for multiple render targets */
 205    unsigned num_cbufs;
 206    struct pipe_surface *cbufs[PIPE_MAX_COLOR_BUFS];
 207
 208    struct pipe_surface *zbuf;      /**< Z buffer */
 209    struct pipe_surface *sbuf;      /**< Stencil buffer */
 210 };
 211
 212
 213 /**
 214  * Texture sampler state.
 215  */
 216 struct pipe_sampler_state
 217 {
 218    unsigned wrap_s:3;        /**< PIPE_TEX_WRAP_x */
 219    unsigned wrap_t:3;        /**< PIPE_TEX_WRAP_x */
 220    unsigned wrap_r:3;        /**< PIPE_TEX_WRAP_x */
 221    unsigned min_img_filter:2;    /**< PIPE_TEX_FILTER_x */
 222    unsigned min_mip_filter:2;    /**< PIPE_TEX_MIPFILTER_x */
 223    unsigned mag_img_filter:2;    /**< PIPE_TEX_FILTER_x */
 224    unsigned compare:1;       /**< shadow/depth compare enabled? */
 225    unsigned compare_mode:1;  /**< PIPE_TEX_COMPARE_x */
 226    unsigned compare_func:3;  /**< PIPE_FUNC_x */
 227    unsigned normalized_coords:1;  /**< Are coords normalized to [0,1]? */
 228    float shadow_ambient; /**< shadow test fail color/intensity */
 229    float min_lod;
 230    float max_lod;
 231    float lod_bias;
 232 #if 0 /* need these? */
 233    int BaseLevel;     /**< min mipmap level, OpenGL 1.2 */
 234    int MaxLevel;      /**< max mipmap level, OpenGL 1.2 */
 235 #endif
 236    float border_color[4];
 237    float max_anisotropy;
 238 };
 239
 240
 241 /**
 242  * 2D surface.  This is basically a view into a memory buffer.
 243  * May be a renderbuffer, texture mipmap level, etc.
 244  */
 245 struct pipe_surface
 246 {
 247    struct pipe_buffer_handle *buffer; /**< driver private buffer handle */
 248    ubyte *map;    /**< only non-NULL when surface is actually mapped */
 249    unsigned map_refcount;  /**< Reference count for mapping */
 250    enum pipe_format format;      /**< PIPE_FORMAT_x */
 251    unsigned cpp;                 /**< bytes per pixel */
 252    unsigned width, height;
 253    unsigned pitch;               /**< in pixels */
 254    unsigned offset;              /**< offset from start of buffer, in bytes */
 255    unsigned refcount;
 256    struct pipe_winsys *winsys;   /**< winsys which owns/created the surface */
 257 };
 258
 259
 260 /**
 261  * Texture. Represents one or several texture images on one or several mipmap
 262  * levels.
 263  */
 264 struct pipe_texture
 265 {
 266    /* Effectively the key:
 267     */
 268    unsigned target;            /**< PIPE_TEXTURE_x */
 269    enum pipe_format format;    /**< PIPE_FORMAT_x */
 270
 271    unsigned first_level;
 272    unsigned last_level;
 273
 274    unsigned width[PIPE_MAX_TEXTURE_LEVELS];
 275    unsigned height[PIPE_MAX_TEXTURE_LEVELS];
 276    unsigned depth[PIPE_MAX_TEXTURE_LEVELS];
 277    unsigned cpp;
 278
 279    unsigned compressed:1;
 280
 281    /* These are also refcounted:
 282     */
 283    unsigned refcount;
 284 };
 285
 286
 287 /**
 288  * A vertex buffer.  Typically, all the vertex data/attributes for
 289  * drawing something will be in one buffer.  But it's also possible, for
 290  * example, to put colors in one buffer and texcoords in another.
 291  */
 292 struct pipe_vertex_buffer
 293 {
 294    unsigned pitch:11;    /**< stride to same attrib in next vertex, in bytes */
 295    unsigned max_index;   /**< number of vertices in this buffer */
 296    unsigned buffer_offset;  /**< offset to start of data in buffer, in bytes */
 297    struct pipe_buffer_handle *buffer;  /**< the actual buffer */
 298 };
 299
 300
 301 /**
 302  * Information to describe a vertex attribute (position, color, etc)
 303  */
 304 struct pipe_vertex_element
 305 {
 306    /** Offset of this attribute, in bytes, from the start of the vertex */
 307    unsigned src_offset:11;
 308
 309    /** Which vertex_buffer (as given to pipe->set_vertex_buffer()) does
 310     * this attribute live in?
 311     */
 312    unsigned vertex_buffer_index:5;
 313
 314    unsigned dst_offset:8;
 315    enum pipe_format src_format;            /**< PIPE_FORMAT_* */
 316 };
 317
 318
 319
 320 #endif