src/gallium/auxiliary/draw/draw_private.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  * Private data structures, etc for the draw module.
  30  */
  31
  32
  33 /**
  34  * Authors:
  35  * Keith Whitwell <keith@tungstengraphics.com>
  36  * Brian Paul
  37  */
  38
  39
  40 #ifndef DRAW_PRIVATE_H
  41 #define DRAW_PRIVATE_H
  42
  43
  44 #include "pipe/p_state.h"
  45 #include "pipe/p_defines.h"
  46
  47 #include "tgsi/tgsi_exec.h"
  48 #include "tgsi/tgsi_scan.h"
  49
  50
  51 struct pipe_context;
  52 struct gallivm_prog;
  53 struct gallivm_cpu_engine;
  54 struct draw_vertex_shader;
  55 struct draw_context;
  56 struct draw_stage;
  57 struct vbuf_render;
  58
  59
  60 /**
  61  * Basic vertex info.
  62  * Carry some useful information around with the vertices in the prim pipe.
  63  */
  64 struct vertex_header {
  65    unsigned clipmask:12;
  66    unsigned edgeflag:1;
  67    unsigned pad:3;
  68    unsigned vertex_id:16;
  69
  70    float clip[4];
  71
  72    /* This will probably become float (*data)[4] soon:
  73     */
  74    float data[][4];
  75 };
  76
  77 /* NOTE: It should match vertex_id size above */
  78 #define UNDEFINED_VERTEX_ID 0xffff
  79
  80
  81 /**
  82  * Private context for the drawing module.
  83  */
  84 struct draw_context
  85 {
  86    /** Drawing/primitive pipeline stages */
  87    struct {
  88       struct draw_stage *first;  /**< one of the following */
  89
  90       struct draw_stage *validate;
  91
  92       /* stages (in logical order) */
  93       struct draw_stage *flatshade;
  94       struct draw_stage *clip;
  95       struct draw_stage *cull;
  96       struct draw_stage *twoside;
  97       struct draw_stage *offset;
  98       struct draw_stage *unfilled;
  99       struct draw_stage *stipple;
 100       struct draw_stage *aapoint;
 101       struct draw_stage *aaline;
 102       struct draw_stage *pstipple;
 103       struct draw_stage *wide_line;
 104       struct draw_stage *wide_point;
 105       struct draw_stage *rasterize;
 106
 107       float wide_point_threshold; /**< convert pnts to tris if larger than this */
 108       float wide_line_threshold;  /**< convert lines to tris if wider than this */
 109       boolean line_stipple;       /**< do line stipple? */
 110       boolean point_sprite;       /**< convert points to quads for sprites? */
 111
 112       /* Temporary storage while the pipeline is being run:
 113        */
 114       char *verts;
 115       unsigned vertex_stride;
 116       unsigned vertex_count;
 117    } pipeline;
 118
 119
 120    struct vbuf_render *render;
 121
 122    /* Support prototype passthrough path:
 123     */
 124    struct {
 125       struct {
 126          struct draw_pt_middle_end *fetch_emit;
 127          struct draw_pt_middle_end *fetch_shade_emit;
 128          struct draw_pt_middle_end *general;
 129       } middle;
 130
 131       struct {
 132          struct draw_pt_front_end *vcache;
 133          struct draw_pt_front_end *varray;
 134       } front;
 135
 136       struct pipe_vertex_buffer vertex_buffer[PIPE_MAX_ATTRIBS];
 137       unsigned nr_vertex_buffers;
 138
 139       struct pipe_vertex_element vertex_element[PIPE_MAX_ATTRIBS];
 140       unsigned nr_vertex_elements;
 141
 142       /* user-space vertex data, buffers */
 143       struct {
 144          const unsigned *edgeflag;
 145
 146          /** vertex element/index buffer (ex: glDrawElements) */
 147          const void *elts;
 148          /** bytes per index (0, 1, 2 or 4) */
 149          unsigned eltSize;
 150          unsigned min_index;
 151          unsigned max_index;
 152
 153          /** vertex arrays */
 154          const void *vbuffer[PIPE_MAX_ATTRIBS];
 155
 156          /** constant buffer (for vertex shader) */
 157          const void *constants;
 158       } user;
 159
 160       boolean test_fse;         /* enable FSE even though its not correct (eg for softpipe) */
 161       boolean no_fse;           /* disable FSE even when it is correct */
 162    } pt;
 163
 164    struct {
 165       boolean bypass_clipping;
 166       boolean bypass_vs;
 167    } driver;
 168
 169    boolean flushing;         /**< debugging/sanity */
 170    boolean suspend_flushing; /**< internally set */
 171    boolean bypass_clipping;  /**< set if either api or driver bypass_clipping true */
 172
 173    boolean force_passthrough; /**< never clip or shade */
 174
 175    /* pipe state that we need: */
 176    const struct pipe_rasterizer_state *rasterizer;
 177    struct pipe_viewport_state viewport;
 178    boolean identity_viewport;
 179
 180    struct {
 181       struct draw_vertex_shader *vertex_shader;
 182       uint num_vs_outputs;  /**< convenience, from vertex_shader */
 183       uint position_output;
 184
 185       /** TGSI program interpreter runtime state */
 186       struct tgsi_exec_machine machine;
 187
 188       uint num_samplers;
 189       struct tgsi_sampler **samplers;
 190
 191       /* This (and the tgsi_exec_machine struct) probably need to be moved somewhere private.
 192        */
 193       struct gallivm_cpu_engine *engine;
 194
 195       /* Here's another one:
 196        */
 197       struct aos_machine *aos_machine;
 198
 199
 200       const float (*aligned_constants)[4];
 201
 202       const float (*aligned_constant_storage)[4];
 203       unsigned const_storage_size;
 204
 205
 206       struct translate *fetch;
 207       struct translate_cache *fetch_cache;
 208       struct translate *emit;
 209       struct translate_cache *emit_cache;
 210    } vs;
 211
 212    /* Clip derived state:
 213     */
 214    float plane[12][4];
 215    unsigned nr_planes;
 216
 217    /* If a prim stage introduces new vertex attributes, they'll be stored here
 218     */
 219    struct {
 220       uint semantic_name;
 221       uint semantic_index;
 222       int slot;
 223    } extra_vp_outputs;
 224
 225    unsigned reduced_prim;
 226
 227    void *driver_private;
 228 };
 229
 230
 231 /*******************************************************************************
 232  * Vertex shader code:
 233  */
 234 boolean draw_vs_init( struct draw_context *draw );
 235 void draw_vs_destroy( struct draw_context *draw );
 236
 237 void draw_vs_set_viewport( struct draw_context *,
 238                            const struct pipe_viewport_state * );
 239
 240 void draw_vs_set_constants( struct draw_context *,
 241                             const float (*constants)[4],
 242                             unsigned size );
 243
 244
 245
 246
 247 /*******************************************************************************
 248  * Vertex processing (was passthrough) code:
 249  */
 250 boolean draw_pt_init( struct draw_context *draw );
 251 void draw_pt_destroy( struct draw_context *draw );
 252 void draw_pt_reset_vertex_ids( struct draw_context *draw );
 253
 254
 255 /*******************************************************************************
 256  * Primitive processing (pipeline) code:
 257  */
 258
 259 boolean draw_pipeline_init( struct draw_context *draw );
 260 void draw_pipeline_destroy( struct draw_context *draw );
 261
 262
 263
 264
 265
 266 /* We use the top few bits in the elts[] parameter to convey a little
 267  * API information.  This limits the number of vertices we can address
 268  * to only 4096 -- if that becomes a problem, we can switch to 32-bit
 269  * draw indices.
 270  *
 271  * These flags expected at first vertex of lines & triangles when
 272  * unfilled and/or line stipple modes are operational.
 273  */
 274 #define DRAW_PIPE_MAX_VERTICES  (0x1<<12)
 275 #define DRAW_PIPE_EDGE_FLAG_0   (0x1<<12)
 276 #define DRAW_PIPE_EDGE_FLAG_1   (0x2<<12)
 277 #define DRAW_PIPE_EDGE_FLAG_2   (0x4<<12)
 278 #define DRAW_PIPE_EDGE_FLAG_ALL (0x7<<12)
 279 #define DRAW_PIPE_RESET_STIPPLE (0x8<<12)
 280 #define DRAW_PIPE_FLAG_MASK     (0xf<<12)
 281
 282 void draw_pipeline_run( struct draw_context *draw,
 283                         unsigned prim,
 284                         struct vertex_header *vertices,
 285                         unsigned vertex_count,
 286                         unsigned stride,
 287                         const ushort *elts,
 288                         unsigned count );
 289
 290 void draw_pipeline_run_linear( struct draw_context *draw,
 291                                unsigned prim,
 292                                struct vertex_header *vertices,
 293                                unsigned count,
 294                                unsigned stride );
 295
 296
 297
 298 void draw_pipeline_flush( struct draw_context *draw,
 299                           unsigned flags );
 300
 301
 302
 303 /*******************************************************************************
 304  * Flushing
 305  */
 306
 307 #define DRAW_FLUSH_STATE_CHANGE              0x8
 308 #define DRAW_FLUSH_BACKEND                   0x10
 309
 310
 311 void draw_do_flush( struct draw_context *draw, unsigned flags );
 312
 313
 314
 315
 316 #endif /* DRAW_PRIVATE_H */