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_scan.h"
  48
  49 #ifdef HAVE_LLVM
  50 struct draw_llvm;
  51 struct gallivm_state;
  52 #endif
  53
  54
  55 /** Sum of frustum planes and user-defined planes */
  56 #define DRAW_TOTAL_CLIP_PLANES (6 + PIPE_MAX_CLIP_PLANES)
  57
  58 /**
  59  * The largest possible index of a vertex that can be fetched.
  60  */
  61 #define DRAW_MAX_FETCH_IDX 0xffffffff
  62
  63 struct pipe_context;
  64 struct draw_vertex_shader;
  65 struct draw_context;
  66 struct draw_stage;
  67 struct vbuf_render;
  68 struct tgsi_exec_machine;
  69 struct tgsi_sampler;
  70 struct draw_pt_front_end;
  71 struct draw_assembler;
  72
  73
  74 /**
  75  * Represents the mapped vertex buffer.
  76  */
  77 struct draw_vertex_buffer {
  78    const void *map;
  79    uint32_t size;
  80 };
  81
  82 /**
  83  * Basic vertex info.
  84  * Carry some useful information around with the vertices in the prim pipe.
  85  */
  86 struct vertex_header {
  87    unsigned clipmask:DRAW_TOTAL_CLIP_PLANES;
  88    unsigned edgeflag:1;
  89    unsigned have_clipdist:1;
  90    unsigned vertex_id:16;
  91
  92    float clip[4];
  93    float pre_clip_pos[4];
  94
  95    /* This will probably become float (*data)[4] soon:
  96     */
  97    float data[][4];
  98 };
  99
 100 /* NOTE: It should match vertex_id size above */
 101 #define UNDEFINED_VERTEX_ID 0xffff
 102
 103
 104 /* maximum number of shader variants we can cache */
 105 #define DRAW_MAX_SHADER_VARIANTS 128
 106
 107 /**
 108  * Private context for the drawing module.
 109  */
 110 struct draw_context
 111 {
 112    struct pipe_context *pipe;
 113
 114    /** Drawing/primitive pipeline stages */
 115    struct {
 116       struct draw_stage *first;  /**< one of the following */
 117
 118       struct draw_stage *validate;
 119
 120       /* stages (in logical order) */
 121       struct draw_stage *flatshade;
 122       struct draw_stage *clip;
 123       struct draw_stage *cull;
 124       struct draw_stage *twoside;
 125       struct draw_stage *offset;
 126       struct draw_stage *unfilled;
 127       struct draw_stage *stipple;
 128       struct draw_stage *aapoint;
 129       struct draw_stage *aaline;
 130       struct draw_stage *pstipple;
 131       struct draw_stage *wide_line;
 132       struct draw_stage *wide_point;
 133       struct draw_stage *rasterize;
 134
 135       float wide_point_threshold; /**< convert pnts to tris if larger than this */
 136       float wide_line_threshold;  /**< convert lines to tris if wider than this */
 137       boolean wide_point_sprites; /**< convert points to tris for sprite mode */
 138       boolean line_stipple;       /**< do line stipple? */
 139       boolean point_sprite;       /**< convert points to quads for sprites? */
 140
 141       /* Temporary storage while the pipeline is being run:
 142        */
 143       char *verts;
 144       unsigned vertex_stride;
 145       unsigned vertex_count;
 146    } pipeline;
 147
 148
 149    struct vbuf_render *render;
 150
 151    /* Support prototype passthrough path:
 152     */
 153    struct {
 154       /* Current active frontend */
 155       struct draw_pt_front_end *frontend;
 156       unsigned prim;
 157       unsigned opt;     /**< bitmask of PT_x flags */
 158       unsigned eltSize; /* saved eltSize for flushing */
 159
 160       boolean rebind_parameters;
 161
 162       struct {
 163          struct draw_pt_middle_end *fetch_emit;
 164          struct draw_pt_middle_end *fetch_shade_emit;
 165          struct draw_pt_middle_end *general;
 166          struct draw_pt_middle_end *llvm;
 167       } middle;
 168
 169       struct {
 170          struct draw_pt_front_end *vsplit;
 171       } front;
 172
 173       struct pipe_vertex_buffer vertex_buffer[PIPE_MAX_ATTRIBS];
 174       unsigned nr_vertex_buffers;
 175
 176       /*
 177        * This is the largest legal index value for the current set of
 178        * bound vertex buffers.  Regardless of any other consideration,
 179        * all vertex lookups need to be clamped to 0..max_index to
 180        * prevent out-of-bound access.
 181        */
 182       unsigned max_index;
 183
 184       struct pipe_vertex_element vertex_element[PIPE_MAX_ATTRIBS];
 185       unsigned nr_vertex_elements;
 186
 187       /* user-space vertex data, buffers */
 188       struct {
 189          /** vertex element/index buffer (ex: glDrawElements) */
 190          const void *elts;
 191          /** bytes per index (0, 1, 2 or 4) */
 192          unsigned eltSizeIB;
 193          unsigned eltSize;
 194          unsigned eltMax;
 195          int eltBias;
 196          unsigned min_index;
 197          unsigned max_index;
 198
 199          /** vertex arrays */
 200          struct draw_vertex_buffer vbuffer[PIPE_MAX_ATTRIBS];
 201
 202          /** constant buffers (for vertex/geometry shader) */
 203          const void *vs_constants[PIPE_MAX_CONSTANT_BUFFERS];
 204          unsigned vs_constants_size[PIPE_MAX_CONSTANT_BUFFERS];
 205          const void *gs_constants[PIPE_MAX_CONSTANT_BUFFERS];
 206          unsigned gs_constants_size[PIPE_MAX_CONSTANT_BUFFERS];
 207
 208          /* pointer to planes */
 209          float (*planes)[DRAW_TOTAL_CLIP_PLANES][4];
 210       } user;
 211
 212       boolean test_fse;         /* enable FSE even though its not correct (eg for softpipe) */
 213       boolean no_fse;           /* disable FSE even when it is correct */
 214    } pt;
 215
 216    struct {
 217       boolean bypass_clip_xy;
 218       boolean bypass_clip_z;
 219       boolean guard_band_xy;
 220    } driver;
 221
 222    boolean quads_always_flatshade_last;
 223
 224    boolean flushing;         /**< debugging/sanity */
 225    boolean suspend_flushing; /**< internally set */
 226
 227    /* Flags set if API requires clipping in these planes and the
 228     * driver doesn't indicate that it can do it for us.
 229     */
 230    boolean clip_xy;
 231    boolean clip_z;
 232    boolean clip_user;
 233    boolean guard_band_xy;
 234
 235    boolean force_passthrough; /**< never clip or shade */
 236
 237    boolean dump_vs;
 238
 239    double mrd;  /**< minimum resolvable depth value, for polygon offset */
 240
 241    /** Current rasterizer state given to us by the driver */
 242    const struct pipe_rasterizer_state *rasterizer;
 243    /** Driver CSO handle for the current rasterizer state */
 244    void *rast_handle;
 245
 246    /** Rasterizer CSOs without culling/stipple/etc */
 247    void *rasterizer_no_cull[2][2];
 248
 249    struct pipe_viewport_state viewports[PIPE_MAX_VIEWPORTS];
 250    boolean identity_viewport;
 251
 252    /** Vertex shader state */
 253    struct {
 254       struct draw_vertex_shader *vertex_shader;
 255       uint num_vs_outputs;  /**< convenience, from vertex_shader */
 256       uint position_output;
 257       uint edgeflag_output;
 258       uint clipvertex_output;
 259       uint clipdistance_output[2];
 260
 261       /** Fields for TGSI interpreter / execution */
 262       struct {
 263          struct tgsi_exec_machine *machine;
 264
 265          struct tgsi_sampler *sampler;
 266       } tgsi;
 267
 268       struct translate *fetch;
 269       struct translate_cache *fetch_cache;
 270       struct translate *emit;
 271       struct translate_cache *emit_cache;
 272    } vs;
 273
 274    /** Geometry shader state */
 275    struct {
 276       struct draw_geometry_shader *geometry_shader;
 277       uint num_gs_outputs;  /**< convenience, from geometry_shader */
 278       uint position_output;
 279
 280       /** Fields for TGSI interpreter / execution */
 281       struct {
 282          struct tgsi_exec_machine *machine;
 283
 284          struct tgsi_sampler *sampler;
 285       } tgsi;
 286
 287    } gs;
 288
 289    /** Fragment shader state */
 290    struct {
 291       struct draw_fragment_shader *fragment_shader;
 292    } fs;
 293
 294    /** Stream output (vertex feedback) state */
 295    struct {
 296       struct draw_so_target *targets[PIPE_MAX_SO_BUFFERS];
 297       uint num_targets;
 298    } so;
 299
 300    /* Clip derived state:
 301     */
 302    float plane[DRAW_TOTAL_CLIP_PLANES][4];
 303
 304    /* If a prim stage introduces new vertex attributes, they'll be stored here
 305     */
 306    struct {
 307       uint num;
 308       uint semantic_name[10];
 309       uint semantic_index[10];
 310       uint slot[10];
 311    } extra_shader_outputs;
 312
 313    unsigned instance_id;
 314    unsigned start_instance;
 315    unsigned start_index;
 316
 317 #ifdef HAVE_LLVM
 318    struct draw_llvm *llvm;
 319 #endif
 320
 321    /** Texture sampler and sampler view state.
 322     * Note that we have arrays indexed by shader type.  At this time
 323     * we only handle vertex and geometry shaders in the draw module, but
 324     * there may be more in the future (ex: hull and tessellation).
 325     */
 326    struct pipe_sampler_view *sampler_views[PIPE_SHADER_TYPES][PIPE_MAX_SHADER_SAMPLER_VIEWS];
 327    unsigned num_sampler_views[PIPE_SHADER_TYPES];
 328    const struct pipe_sampler_state *samplers[PIPE_SHADER_TYPES][PIPE_MAX_SAMPLERS];
 329    unsigned num_samplers[PIPE_SHADER_TYPES];
 330
 331    struct pipe_query_data_pipeline_statistics statistics;
 332    boolean collect_statistics;
 333
 334    struct draw_assembler *ia;
 335
 336    void *driver_private;
 337 };
 338
 339
 340 struct draw_fetch_info {
 341    boolean linear;
 342    unsigned start;
 343    const unsigned *elts;
 344    unsigned count;
 345 };
 346
 347 struct draw_vertex_info {
 348    struct vertex_header *verts;
 349    unsigned vertex_size;
 350    unsigned stride;
 351    unsigned count;
 352 };
 353
 354 /* these flags are set if the primitive is a segment of a larger one */
 355 #define DRAW_SPLIT_BEFORE 0x1
 356 #define DRAW_SPLIT_AFTER  0x2
 357
 358 struct draw_prim_info {
 359    boolean linear;
 360    unsigned start;
 361
 362    const ushort *elts;
 363    unsigned count;
 364
 365    unsigned prim;
 366    unsigned flags;
 367    unsigned *primitive_lengths;
 368    unsigned primitive_count;
 369 };
 370
 371
 372 /*******************************************************************************
 373  * Draw common initialization code
 374  */
 375 boolean draw_init(struct draw_context *draw);
 376 void draw_new_instance(struct draw_context *draw);
 377
 378 /*******************************************************************************
 379  * Vertex shader code:
 380  */
 381 boolean draw_vs_init( struct draw_context *draw );
 382 void draw_vs_destroy( struct draw_context *draw );
 383
 384
 385 /*******************************************************************************
 386  * Geometry shading code:
 387  */
 388 boolean draw_gs_init( struct draw_context *draw );
 389
 390
 391 void draw_gs_destroy( struct draw_context *draw );
 392
 393 /*******************************************************************************
 394  * Common shading code:
 395  */
 396 uint draw_current_shader_outputs(const struct draw_context *draw);
 397 uint draw_current_shader_position_output(const struct draw_context *draw);
 398 uint draw_current_shader_viewport_index_output(const struct draw_context *draw);
 399 uint draw_current_shader_clipvertex_output(const struct draw_context *draw);
 400 uint draw_current_shader_clipdistance_output(const struct draw_context *draw, int index);
 401 uint draw_current_shader_num_written_clipdistances(const struct draw_context *draw);
 402 uint draw_current_shader_culldistance_output(const struct draw_context *draw, int index);
 403 uint draw_current_shader_num_written_culldistances(const struct draw_context *draw);
 404 int draw_alloc_extra_vertex_attrib(struct draw_context *draw,
 405                                    uint semantic_name, uint semantic_index);
 406 void draw_remove_extra_vertex_attribs(struct draw_context *draw);
 407 boolean draw_current_shader_uses_viewport_index(
 408    const struct draw_context *draw);
 409
 410
 411 /*******************************************************************************
 412  * Vertex processing (was passthrough) code:
 413  */
 414 boolean draw_pt_init( struct draw_context *draw );
 415 void draw_pt_destroy( struct draw_context *draw );
 416 void draw_pt_reset_vertex_ids( struct draw_context *draw );
 417 void draw_pt_flush( struct draw_context *draw, unsigned flags );
 418
 419
 420 /*******************************************************************************
 421  * Primitive processing (pipeline) code:
 422  */
 423
 424 boolean draw_pipeline_init( struct draw_context *draw );
 425 void draw_pipeline_destroy( struct draw_context *draw );
 426
 427
 428
 429
 430
 431 /*
 432  * These flags are used by the pipeline when unfilled and/or line stipple modes
 433  * are operational.
 434  */
 435 #define DRAW_PIPE_EDGE_FLAG_0   0x1
 436 #define DRAW_PIPE_EDGE_FLAG_1   0x2
 437 #define DRAW_PIPE_EDGE_FLAG_2   0x4
 438 #define DRAW_PIPE_EDGE_FLAG_ALL 0x7
 439 #define DRAW_PIPE_RESET_STIPPLE 0x8
 440
 441 void draw_pipeline_run( struct draw_context *draw,
 442                         const struct draw_vertex_info *vert,
 443                         const struct draw_prim_info *prim);
 444
 445 void draw_pipeline_run_linear( struct draw_context *draw,
 446                                const struct draw_vertex_info *vert,
 447                                const struct draw_prim_info *prim);
 448
 449
 450
 451
 452 void draw_pipeline_flush( struct draw_context *draw,
 453                           unsigned flags );
 454
 455
 456
 457 /*******************************************************************************
 458  * Flushing
 459  */
 460
 461 #define DRAW_FLUSH_PARAMETER_CHANGE 0x1  /**< Constants, viewport, etc */
 462 #define DRAW_FLUSH_STATE_CHANGE     0x2  /**< Other/heavy state changes */
 463 #define DRAW_FLUSH_BACKEND          0x4  /**< Flush the output buffer */
 464
 465
 466 void draw_do_flush( struct draw_context *draw, unsigned flags );
 467
 468
 469
 470 void *
 471 draw_get_rasterizer_no_cull( struct draw_context *draw,
 472                              boolean scissor,
 473                              boolean flatshade );
 474
 475 void
 476 draw_stats_clipper_primitives(struct draw_context *draw,
 477                               const struct draw_prim_info *prim_info);
 478
 479 /**
 480  * Return index i from the index buffer.
 481  * If the index buffer would overflow we return the
 482  * maximum possible index.
 483  */
 484 #define DRAW_GET_IDX(_elts, _i)                   \
 485    (((_i) >= draw->pt.user.eltMax) ? DRAW_MAX_FETCH_IDX : (_elts)[_i])
 486
 487 /**
 488  * Return index of the given viewport clamping it
 489  * to be between 0 <= and < PIPE_MAX_VIEWPORTS
 490  */
 491 static INLINE unsigned
 492 draw_clamp_viewport_idx(int idx)
 493 {
 494    return ((PIPE_MAX_VIEWPORTS > idx || idx < 0) ? idx : 0);
 495 }
 496
 497 /**
 498  * Adds two unsigned integers and if the addition
 499  * overflows then it returns the value from
 500  * from the overflow_value variable.
 501  */
 502 static INLINE unsigned
 503 draw_overflow_uadd(unsigned a, unsigned b,
 504                    unsigned overflow_value)
 505 {
 506    unsigned res = a + b;
 507    if (res < a || res < b) {
 508       res = overflow_value;
 509    }
 510    return res;
 511 }
 512
 513 #endif /* DRAW_PRIVATE_H */