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 "rtasm/rtasm_x86sse.h"
  48 #include "tgsi/exec/tgsi_exec.h"
  49 #include "tgsi/util/tgsi_scan.h"
  50
  51
  52 struct pipe_context;
  53 struct gallivm_prog;
  54 struct gallivm_cpu_engine;
  55
  56 /**
  57  * Basic vertex info.
  58  * Carry some useful information around with the vertices in the prim pipe.
  59  */
  60 struct vertex_header {
  61    unsigned clipmask:12;
  62    unsigned edgeflag:1;
  63    unsigned pad:3;
  64    unsigned vertex_id:16;
  65
  66    float clip[4];
  67
  68    float data[][4];             /* Note variable size */
  69 };
  70
  71 /* NOTE: It should match vertex_id size above */
  72 #define UNDEFINED_VERTEX_ID 0xffff
  73
  74 /* XXX This is too large */
  75 #define MAX_VERTEX_SIZE ((2 + PIPE_MAX_SHADER_OUTPUTS) * 4 * sizeof(float))
  76
  77
  78
  79 /**
  80  * Basic info for a point/line/triangle primitive.
  81  */
  82 struct prim_header {
  83    float det;                 /**< front/back face determinant */
  84    unsigned reset_line_stipple:1;
  85    unsigned edgeflags:3;
  86    unsigned pad:28;
  87    struct vertex_header *v[3];  /**< 1 to 3 vertex pointers */
  88 };
  89
  90
  91
  92 struct draw_context;
  93
  94 /**
  95  * Base class for all primitive drawing stages.
  96  */
  97 struct draw_stage
  98 {
  99    struct draw_context *draw;   /**< parent context */
 100
 101    struct draw_stage *next;     /**< next stage in pipeline */
 102
 103    struct vertex_header **tmp;  /**< temp vert storage, such as for clipping */
 104    unsigned nr_tmps;
 105
 106    void (*point)( struct draw_stage *,
 107                   struct prim_header * );
 108
 109    void (*line)( struct draw_stage *,
 110                  struct prim_header * );
 111
 112    void (*tri)( struct draw_stage *,
 113                 struct prim_header * );
 114
 115    void (*flush)( struct draw_stage *,
 116                   unsigned flags );
 117
 118    void (*reset_stipple_counter)( struct draw_stage * );
 119
 120    void (*destroy)( struct draw_stage * );
 121 };
 122
 123
 124 #define PRIM_QUEUE_LENGTH      32
 125 #define VCACHE_SIZE            32
 126 #define VCACHE_OVERFLOW        4
 127 #define VS_QUEUE_LENGTH        (VCACHE_SIZE + VCACHE_OVERFLOW + 1)      /* can never fill up */
 128
 129 /**
 130  * Private version of the compiled vertex_shader
 131  */
 132 struct draw_vertex_shader {
 133
 134    /* This member will disappear shortly:
 135     */
 136    const struct pipe_shader_state   *state;
 137
 138    struct tgsi_shader_info info;
 139
 140    void (*prepare)( struct draw_vertex_shader *shader,
 141                     struct draw_context *draw );
 142
 143    /* Run the shader - this interface will get cleaned up in the
 144     * future:
 145     */
 146    void (*run)( struct draw_vertex_shader *shader,
 147                 struct draw_context *draw,
 148                 const unsigned *elts,
 149                 unsigned count,
 150                 struct vertex_header *vOut[] );
 151
 152
 153    void (*delete)( struct draw_vertex_shader * );
 154 };
 155
 156
 157 /* Internal function for vertex fetch.
 158  */
 159 typedef void (*fetch_func)(const void *ptr, float *attrib);
 160 typedef void (*full_fetch_func)( struct draw_context *draw,
 161                                  struct tgsi_exec_machine *machine,
 162                                  const unsigned *elts,
 163                                  unsigned count );
 164
 165
 166
 167 /**
 168  * Private context for the drawing module.
 169  */
 170 struct draw_context
 171 {
 172    /** Drawing/primitive pipeline stages */
 173    struct {
 174       struct draw_stage *first;  /**< one of the following */
 175
 176       struct draw_stage *validate;
 177
 178       /* stages (in logical order) */
 179       struct draw_stage *flatshade;
 180       struct draw_stage *clip;
 181       struct draw_stage *cull;
 182       struct draw_stage *twoside;
 183       struct draw_stage *offset;
 184       struct draw_stage *unfilled;
 185       struct draw_stage *stipple;
 186       struct draw_stage *aapoint;
 187       struct draw_stage *aaline;
 188       struct draw_stage *pstipple;
 189       struct draw_stage *wide;
 190       struct draw_stage *rasterize;
 191    } pipeline;
 192
 193    /* pipe state that we need: */
 194    const struct pipe_rasterizer_state *rasterizer;
 195    struct pipe_viewport_state viewport;
 196    struct pipe_vertex_buffer vertex_buffer[PIPE_ATTRIB_MAX];
 197    struct pipe_vertex_element vertex_element[PIPE_ATTRIB_MAX];
 198    struct draw_vertex_shader *vertex_shader;
 199
 200    uint num_vs_outputs;  /**< convenience, from vertex_shader */
 201
 202    /* user-space vertex data, buffers */
 203    struct {
 204       /** vertex element/index buffer (ex: glDrawElements) */
 205       const void *elts;
 206       /** bytes per index (0, 1, 2 or 4) */
 207       unsigned eltSize;
 208
 209       /** vertex arrays */
 210       const void *vbuffer[PIPE_ATTRIB_MAX];
 211
 212       /** constant buffer (for vertex shader) */
 213       const void *constants;
 214    } user;
 215
 216    /* Clip derived state:
 217     */
 218    float plane[12][4];
 219    unsigned nr_planes;
 220
 221    float wide_point_threshold; /**< convert pnts to tris if larger than this */
 222    boolean convert_wide_lines;  /**< convert wide lines to tris? */
 223    boolean use_sse;
 224
 225    /* If a prim stage introduces new vertex attributes, they'll be stored here
 226     */
 227    struct {
 228       uint semantic_name;
 229       uint semantic_index;
 230       int slot;
 231    } extra_vp_outputs;
 232
 233    unsigned reduced_prim;
 234
 235    /** TGSI program interpreter runtime state */
 236    struct tgsi_exec_machine machine;
 237
 238    /* Vertex fetch internal state
 239     */
 240    struct {
 241       const ubyte *src_ptr[PIPE_ATTRIB_MAX];
 242       unsigned pitch[PIPE_ATTRIB_MAX];
 243       fetch_func fetch[PIPE_ATTRIB_MAX];
 244       unsigned nr_attrs;
 245       full_fetch_func fetch_func;
 246    } vertex_fetch;
 247
 248    /* Post-tnl vertex cache:
 249     */
 250    struct {
 251       unsigned referenced;  /**< bitfield */
 252
 253       struct {
 254          unsigned in;           /* client array element */
 255          unsigned out;          /* index in vs queue/array */
 256       } idx[VCACHE_SIZE + VCACHE_OVERFLOW];
 257
 258       unsigned overflow;
 259
 260       /** To find space in the vertex cache: */
 261       struct vertex_header *(*get_vertex)( struct draw_context *draw,
 262                                            unsigned i );
 263    } vcache;
 264
 265    /* Vertex shader queue:
 266     */
 267    struct {
 268       struct {
 269          unsigned elt;   /**< index into the user's vertex arrays */
 270          struct vertex_header *vertex;
 271       } queue[VS_QUEUE_LENGTH];
 272       unsigned queue_nr;
 273       unsigned post_nr;
 274    } vs;
 275
 276    /**
 277     * Run the vertex shader on all vertices in the vertex queue.
 278     */
 279    void (*shader_queue_flush)(struct draw_context *draw);
 280
 281    /* Prim pipeline queue:
 282     */
 283    struct {
 284       /* Need to queue up primitives until their vertices have been
 285        * transformed by a vs queue flush.
 286        */
 287       struct prim_header queue[PRIM_QUEUE_LENGTH];
 288       unsigned queue_nr;
 289    } pq;
 290
 291
 292    /* This (and the tgsi_exec_machine struct) probably need to be moved somewhere private.
 293     */
 294    struct gallivm_cpu_engine *engine;
 295    void *driver_private;
 296 };
 297
 298
 299
 300 extern struct draw_stage *draw_unfilled_stage( struct draw_context *context );
 301 extern struct draw_stage *draw_twoside_stage( struct draw_context *context );
 302 extern struct draw_stage *draw_offset_stage( struct draw_context *context );
 303 extern struct draw_stage *draw_clip_stage( struct draw_context *context );
 304 extern struct draw_stage *draw_flatshade_stage( struct draw_context *context );
 305 extern struct draw_stage *draw_cull_stage( struct draw_context *context );
 306 extern struct draw_stage *draw_stipple_stage( struct draw_context *context );
 307 extern struct draw_stage *draw_wide_stage( struct draw_context *context );
 308 extern struct draw_stage *draw_validate_stage( struct draw_context *context );
 309
 310
 311 extern void draw_free_temp_verts( struct draw_stage *stage );
 312
 313 extern void draw_alloc_temp_verts( struct draw_stage *stage, unsigned nr );
 314
 315 extern void draw_reset_vertex_ids( struct draw_context *draw );
 316
 317
 318 extern int draw_vertex_cache_check_space( struct draw_context *draw,
 319                                           unsigned nr_verts );
 320
 321 extern void draw_vertex_cache_invalidate( struct draw_context *draw );
 322 extern void draw_vertex_cache_unreference( struct draw_context *draw );
 323 extern void draw_vertex_cache_reset_vertex_ids( struct draw_context *draw );
 324
 325 extern void draw_vertex_shader_queue_flush( struct draw_context *draw );
 326
 327 struct tgsi_exec_machine;
 328
 329 extern void draw_update_vertex_fetch( struct draw_context *draw );
 330
 331
 332 #define DRAW_FLUSH_SHADER_QUEUE              0x1 /* sized not to overflow, never raised */
 333 #define DRAW_FLUSH_PRIM_QUEUE                0x2
 334 #define DRAW_FLUSH_VERTEX_CACHE              0x4
 335 #define DRAW_FLUSH_STATE_CHANGE              0x8
 336 #define DRAW_FLUSH_BACKEND                   0x10
 337
 338
 339 void draw_do_flush( struct draw_context *draw, unsigned flags );
 340
 341
 342
 343 /**
 344  * Get a writeable copy of a vertex.
 345  * \param stage  drawing stage info
 346  * \param vert  the vertex to copy (source)
 347  * \param idx  index into stage's tmp[] array to put the copy (dest)
 348  * \return  pointer to the copied vertex
 349  */
 350 static INLINE struct vertex_header *
 351 dup_vert( struct draw_stage *stage,
 352           const struct vertex_header *vert,
 353           unsigned idx )
 354 {
 355    struct vertex_header *tmp = stage->tmp[idx];
 356    const uint vsize = sizeof(struct vertex_header)
 357       + stage->draw->num_vs_outputs * 4 * sizeof(float);
 358    memcpy(tmp, vert, vsize);
 359    tmp->vertex_id = UNDEFINED_VERTEX_ID;
 360    return tmp;
 361 }
 362
 363 static INLINE float
 364 dot4(const float *a, const float *b)
 365 {
 366    float result = (a[0]*b[0] +
 367                    a[1]*b[1] +
 368                    a[2]*b[2] +
 369                    a[3]*b[3]);
 370
 371    return result;
 372 }
 373
 374 #endif /* DRAW_PRIVATE_H */