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