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