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 #include <llvm-c/ExecutionEngine.h>
  51 struct draw_llvm;
  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 struct pipe_context;
  60 struct draw_vertex_shader;
  61 struct draw_context;
  62 struct draw_stage;
  63 struct vbuf_render;
  64 struct tgsi_exec_machine;
  65 struct tgsi_sampler;
  66
  67
  68 /**
  69  * Basic vertex info.
  70  * Carry some useful information around with the vertices in the prim pipe.
  71  */
  72 struct vertex_header {
  73    unsigned clipmask:DRAW_TOTAL_CLIP_PLANES;
  74    unsigned edgeflag:1;
  75    unsigned pad:1;
  76    unsigned vertex_id:16;
  77
  78    float clip[4];
  79
  80    /* This will probably become float (*data)[4] soon:
  81     */
  82    float data[][4];
  83 };
  84
  85 /* NOTE: It should match vertex_id size above */
  86 #define UNDEFINED_VERTEX_ID 0xffff
  87
  88
  89 /* maximum number of shader variants we can cache */
  90 #define DRAW_MAX_SHADER_VARIANTS 128
  91
  92 /**
  93  * Private context for the drawing module.
  94  */
  95 struct draw_context
  96 {
  97    struct pipe_context *pipe;
  98
  99    /** Drawing/primitive pipeline stages */
 100    struct {
 101       struct draw_stage *first;  /**< one of the following */
 102
 103       struct draw_stage *validate;
 104
 105       /* stages (in logical order) */
 106       struct draw_stage *flatshade;
 107       struct draw_stage *clip;
 108       struct draw_stage *cull;
 109       struct draw_stage *twoside;
 110       struct draw_stage *offset;
 111       struct draw_stage *unfilled;
 112       struct draw_stage *stipple;
 113       struct draw_stage *aapoint;
 114       struct draw_stage *aaline;
 115       struct draw_stage *pstipple;
 116       struct draw_stage *wide_line;
 117       struct draw_stage *wide_point;
 118       struct draw_stage *rasterize;
 119
 120       float wide_point_threshold; /**< convert pnts to tris if larger than this */
 121       float wide_line_threshold;  /**< convert lines to tris if wider than this */
 122       boolean wide_point_sprites; /**< convert points to tris for sprite mode */
 123       boolean line_stipple;       /**< do line stipple? */
 124       boolean point_sprite;       /**< convert points to quads for sprites? */
 125
 126       /* Temporary storage while the pipeline is being run:
 127        */
 128       char *verts;
 129       unsigned vertex_stride;
 130       unsigned vertex_count;
 131    } pipeline;
 132
 133
 134    struct vbuf_render *render;
 135
 136    /* Support prototype passthrough path:
 137     */
 138    struct {
 139       struct {
 140          struct draw_pt_middle_end *fetch_emit;
 141          struct draw_pt_middle_end *fetch_shade_emit;
 142          struct draw_pt_middle_end *general;
 143          struct draw_pt_middle_end *llvm;
 144       } middle;
 145
 146       struct {
 147          struct draw_pt_front_end *vsplit;
 148       } front;
 149
 150       struct pipe_vertex_buffer vertex_buffer[PIPE_MAX_ATTRIBS];
 151       unsigned nr_vertex_buffers;
 152
 153       /*
 154        * This is the largest legal index value for the current set of
 155        * bound vertex buffers.  Regardless of any other consideration,
 156        * all vertex lookups need to be clamped to 0..max_index to
 157        * prevent out-of-bound access.
 158        */
 159       unsigned max_index;
 160
 161       struct pipe_vertex_element vertex_element[PIPE_MAX_ATTRIBS];
 162       unsigned nr_vertex_elements;
 163
 164       struct pipe_index_buffer index_buffer;
 165
 166       /* user-space vertex data, buffers */
 167       struct {
 168          /** vertex element/index buffer (ex: glDrawElements) */
 169          const void *elts;
 170          /** bytes per index (0, 1, 2 or 4) */
 171          unsigned eltSize;
 172          int eltBias;
 173          unsigned min_index;
 174          unsigned max_index;
 175
 176          /** vertex arrays */
 177          const void *vbuffer[PIPE_MAX_ATTRIBS];
 178
 179          /** constant buffers (for vertex/geometry shader) */
 180          const void *vs_constants[PIPE_MAX_CONSTANT_BUFFERS];
 181          unsigned vs_constants_size[PIPE_MAX_CONSTANT_BUFFERS];
 182          const void *gs_constants[PIPE_MAX_CONSTANT_BUFFERS];
 183          unsigned gs_constants_size[PIPE_MAX_CONSTANT_BUFFERS];
 184
 185          /* pointer to planes */
 186          float (*planes)[DRAW_TOTAL_CLIP_PLANES][4];
 187       } user;
 188
 189       boolean test_fse;         /* enable FSE even though its not correct (eg for softpipe) */
 190       boolean no_fse;           /* disable FSE even when it is correct */
 191    } pt;
 192
 193    struct {
 194       boolean bypass_clip_xy;
 195       boolean bypass_clip_z;
 196       boolean guard_band_xy;
 197    } driver;
 198
 199    boolean flushing;         /**< debugging/sanity */
 200    boolean suspend_flushing; /**< internally set */
 201
 202    /* Flags set if API requires clipping in these planes and the
 203     * driver doesn't indicate that it can do it for us.
 204     */
 205    boolean clip_xy;
 206    boolean clip_z;
 207    boolean clip_user;
 208    boolean guard_band_xy;
 209
 210    boolean force_passthrough; /**< never clip or shade */
 211
 212    boolean dump_vs;
 213
 214    double mrd;  /**< minimum resolvable depth value, for polygon offset */
 215
 216    /** Current rasterizer state given to us by the driver */
 217    const struct pipe_rasterizer_state *rasterizer;
 218    /** Driver CSO handle for the current rasterizer state */
 219    void *rast_handle;
 220
 221    /** Rasterizer CSOs without culling/stipple/etc */
 222    void *rasterizer_no_cull[2][2];
 223
 224    struct pipe_viewport_state viewport;
 225    boolean identity_viewport;
 226
 227    /** Vertex shader state */
 228    struct {
 229       struct draw_vertex_shader *vertex_shader;
 230       uint num_vs_outputs;  /**< convenience, from vertex_shader */
 231       uint position_output;
 232       uint edgeflag_output;
 233
 234       /** TGSI program interpreter runtime state */
 235       struct tgsi_exec_machine *machine;
 236
 237       uint num_samplers;
 238       struct tgsi_sampler **samplers;
 239
 240
 241       const void *aligned_constants[PIPE_MAX_CONSTANT_BUFFERS];
 242
 243       const void *aligned_constant_storage[PIPE_MAX_CONSTANT_BUFFERS];
 244       unsigned const_storage_size[PIPE_MAX_CONSTANT_BUFFERS];
 245
 246
 247       struct translate *fetch;
 248       struct translate_cache *fetch_cache;
 249       struct translate *emit;
 250       struct translate_cache *emit_cache;
 251    } vs;
 252
 253    /** Geometry shader state */
 254    struct {
 255       struct draw_geometry_shader *geometry_shader;
 256       uint num_gs_outputs;  /**< convenience, from geometry_shader */
 257       uint position_output;
 258
 259       /** TGSI program interpreter runtime state */
 260       struct tgsi_exec_machine *machine;
 261
 262       uint num_samplers;
 263       struct tgsi_sampler **samplers;
 264    } gs;
 265
 266    /** Fragment shader state */
 267    struct {
 268       struct draw_fragment_shader *fragment_shader;
 269    } fs;
 270
 271    /** Stream output (vertex feedback) state */
 272    struct {
 273       struct pipe_stream_output_info state;
 274       void *buffers[PIPE_MAX_SO_BUFFERS];
 275       uint num_buffers;
 276    } so;
 277
 278    /* Clip derived state:
 279     */
 280    float plane[DRAW_TOTAL_CLIP_PLANES][4];
 281    unsigned nr_planes;
 282    boolean depth_clamp;
 283
 284    /* If a prim stage introduces new vertex attributes, they'll be stored here
 285     */
 286    struct {
 287       uint num;
 288       uint semantic_name[10];
 289       uint semantic_index[10];
 290       uint slot[10];
 291    } extra_shader_outputs;
 292
 293    unsigned reduced_prim;
 294
 295    unsigned instance_id;
 296
 297 #ifdef HAVE_LLVM
 298    struct draw_llvm *llvm;
 299    struct gallivm_state *own_gallivm;
 300 #endif
 301
 302    struct pipe_sampler_view *sampler_views[PIPE_MAX_VERTEX_SAMPLERS];
 303    unsigned num_sampler_views;
 304    const struct pipe_sampler_state *samplers[PIPE_MAX_VERTEX_SAMPLERS];
 305    unsigned num_samplers;
 306
 307    void *driver_private;
 308 };
 309
 310
 311 struct draw_fetch_info {
 312    boolean linear;
 313    unsigned start;
 314    const unsigned *elts;
 315    unsigned count;
 316 };
 317
 318 struct draw_vertex_info {
 319    struct vertex_header *verts;
 320    unsigned vertex_size;
 321    unsigned stride;
 322    unsigned count;
 323 };
 324
 325 /* these flags are set if the primitive is a segment of a larger one */
 326 #define DRAW_SPLIT_BEFORE 0x1
 327 #define DRAW_SPLIT_AFTER  0x2
 328
 329 struct draw_prim_info {
 330    boolean linear;
 331    unsigned start;
 332
 333    const ushort *elts;
 334    unsigned count;
 335
 336    unsigned prim;
 337    unsigned flags;
 338    unsigned *primitive_lengths;
 339    unsigned primitive_count;
 340 };
 341
 342
 343 /*******************************************************************************
 344  * Draw common initialization code
 345  */
 346 boolean draw_init(struct draw_context *draw);
 347
 348 /*******************************************************************************
 349  * Vertex shader code:
 350  */
 351 boolean draw_vs_init( struct draw_context *draw );
 352 void draw_vs_destroy( struct draw_context *draw );
 353
 354 void draw_vs_set_viewport( struct draw_context *,
 355                            const struct pipe_viewport_state * );
 356
 357 void
 358 draw_vs_set_constants(struct draw_context *,
 359                       unsigned slot,
 360                       const void *constants,
 361                       unsigned size);
 362
 363
 364
 365 /*******************************************************************************
 366  * Geometry shading code:
 367  */
 368 boolean draw_gs_init( struct draw_context *draw );
 369
 370 void
 371 draw_gs_set_constants(struct draw_context *,
 372                       unsigned slot,
 373                       const void *constants,
 374                       unsigned size);
 375
 376 void draw_gs_destroy( struct draw_context *draw );
 377
 378 /*******************************************************************************
 379  * Common shading code:
 380  */
 381 uint draw_current_shader_outputs(const struct draw_context *draw);
 382 uint draw_current_shader_position_output(const struct draw_context *draw);
 383
 384 int draw_alloc_extra_vertex_attrib(struct draw_context *draw,
 385                                    uint semantic_name, uint semantic_index);
 386 void draw_remove_extra_vertex_attribs(struct draw_context *draw);
 387
 388
 389 /*******************************************************************************
 390  * Vertex processing (was passthrough) code:
 391  */
 392 boolean draw_pt_init( struct draw_context *draw );
 393 void draw_pt_destroy( struct draw_context *draw );
 394 void draw_pt_reset_vertex_ids( struct draw_context *draw );
 395
 396
 397 /*******************************************************************************
 398  * Primitive processing (pipeline) code:
 399  */
 400
 401 boolean draw_pipeline_init( struct draw_context *draw );
 402 void draw_pipeline_destroy( struct draw_context *draw );
 403
 404
 405
 406
 407
 408 /*
 409  * These flags are used by the pipeline when unfilled and/or line stipple modes
 410  * are operational.
 411  */
 412 #define DRAW_PIPE_EDGE_FLAG_0   0x1
 413 #define DRAW_PIPE_EDGE_FLAG_1   0x2
 414 #define DRAW_PIPE_EDGE_FLAG_2   0x4
 415 #define DRAW_PIPE_EDGE_FLAG_ALL 0x7
 416 #define DRAW_PIPE_RESET_STIPPLE 0x8
 417
 418 void draw_pipeline_run( struct draw_context *draw,
 419                         const struct draw_vertex_info *vert,
 420                         const struct draw_prim_info *prim);
 421
 422 void draw_pipeline_run_linear( struct draw_context *draw,
 423                                const struct draw_vertex_info *vert,
 424                                const struct draw_prim_info *prim);
 425
 426
 427
 428
 429 void draw_pipeline_flush( struct draw_context *draw,
 430                           unsigned flags );
 431
 432
 433
 434 /*******************************************************************************
 435  * Flushing
 436  */
 437
 438 #define DRAW_FLUSH_STATE_CHANGE              0x8
 439 #define DRAW_FLUSH_BACKEND                   0x10
 440
 441
 442 void draw_do_flush( struct draw_context *draw, unsigned flags );
 443
 444
 445
 446 void *
 447 draw_get_rasterizer_no_cull( struct draw_context *draw,
 448                              boolean scissor,
 449                              boolean flatshade );
 450
 451
 452 #endif /* DRAW_PRIVATE_H */