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 #endif
  52
  53
  54 struct pipe_context;
  55 struct draw_vertex_shader;
  56 struct draw_context;
  57 struct draw_stage;
  58 struct vbuf_render;
  59 struct tgsi_exec_machine;
  60 struct tgsi_sampler;
  61
  62
  63 /**
  64  * Basic vertex info.
  65  * Carry some useful information around with the vertices in the prim pipe.
  66  */
  67 struct vertex_header {
  68    unsigned clipmask:12;
  69    unsigned edgeflag:1;
  70    unsigned pad:3;
  71    unsigned vertex_id:16;
  72
  73    float clip[4];
  74
  75    /* This will probably become float (*data)[4] soon:
  76     */
  77    float data[][4];
  78 };
  79
  80 /* NOTE: It should match vertex_id size above */
  81 #define UNDEFINED_VERTEX_ID 0xffff
  82
  83
  84 /**
  85  * Private context for the drawing module.
  86  */
  87 struct draw_context
  88 {
  89    struct pipe_context *pipe;
  90
  91    /** Drawing/primitive pipeline stages */
  92    struct {
  93       struct draw_stage *first;  /**< one of the following */
  94
  95       struct draw_stage *validate;
  96
  97       /* stages (in logical order) */
  98       struct draw_stage *flatshade;
  99       struct draw_stage *clip;
 100       struct draw_stage *cull;
 101       struct draw_stage *twoside;
 102       struct draw_stage *offset;
 103       struct draw_stage *unfilled;
 104       struct draw_stage *stipple;
 105       struct draw_stage *aapoint;
 106       struct draw_stage *aaline;
 107       struct draw_stage *pstipple;
 108       struct draw_stage *wide_line;
 109       struct draw_stage *wide_point;
 110       struct draw_stage *rasterize;
 111
 112       float wide_point_threshold; /**< convert pnts to tris if larger than this */
 113       float wide_line_threshold;  /**< convert lines to tris if wider than this */
 114       boolean line_stipple;       /**< do line stipple? */
 115       boolean point_sprite;       /**< convert points to quads for sprites? */
 116
 117       /* Temporary storage while the pipeline is being run:
 118        */
 119       char *verts;
 120       unsigned vertex_stride;
 121       unsigned vertex_count;
 122    } pipeline;
 123
 124
 125    struct vbuf_render *render;
 126
 127    /* Support prototype passthrough path:
 128     */
 129    struct {
 130       struct {
 131          struct draw_pt_middle_end *fetch_emit;
 132          struct draw_pt_middle_end *fetch_shade_emit;
 133          struct draw_pt_middle_end *general;
 134       } middle;
 135
 136       struct {
 137          struct draw_pt_front_end *vcache;
 138          struct draw_pt_front_end *varray;
 139       } front;
 140
 141       struct pipe_vertex_buffer vertex_buffer[PIPE_MAX_ATTRIBS];
 142       unsigned nr_vertex_buffers;
 143
 144       struct pipe_vertex_element vertex_element[PIPE_MAX_ATTRIBS];
 145       unsigned nr_vertex_elements;
 146
 147       /* user-space vertex data, buffers */
 148       struct {
 149          /** vertex element/index buffer (ex: glDrawElements) */
 150          const void *elts;
 151          /** bytes per index (0, 1, 2 or 4) */
 152          unsigned eltSize;
 153          unsigned min_index;
 154          unsigned max_index;
 155
 156          /** vertex arrays */
 157          const void *vbuffer[PIPE_MAX_ATTRIBS];
 158
 159          /** constant buffer (for vertex/geometry shader) */
 160          const void *vs_constants[PIPE_MAX_CONSTANT_BUFFERS];
 161          const void *gs_constants[PIPE_MAX_CONSTANT_BUFFERS];
 162       } user;
 163
 164       boolean test_fse;         /* enable FSE even though its not correct (eg for softpipe) */
 165       boolean no_fse;           /* disable FSE even when it is correct */
 166    } pt;
 167
 168    struct {
 169       boolean bypass_clipping;
 170       boolean bypass_vs;
 171    } driver;
 172
 173    boolean flushing;         /**< debugging/sanity */
 174    boolean suspend_flushing; /**< internally set */
 175    boolean bypass_clipping;  /**< set if either api or driver bypass_clipping true */
 176
 177    boolean force_passthrough; /**< never clip or shade */
 178
 179    boolean dump_vs;
 180
 181    double mrd;  /**< minimum resolvable depth value, for polygon offset */
 182
 183    /** Current rasterizer state given to us by the driver */
 184    const struct pipe_rasterizer_state *rasterizer;
 185    /** Driver CSO handle for the current rasterizer state */
 186    void *rast_handle;
 187
 188    /** Rasterizer CSOs without culling/stipple/etc */
 189    void *rasterizer_no_cull[2][2];
 190
 191    struct pipe_viewport_state viewport;
 192    boolean identity_viewport;
 193
 194    struct {
 195       struct draw_vertex_shader *vertex_shader;
 196       uint num_vs_outputs;  /**< convenience, from vertex_shader */
 197       uint position_output;
 198       uint edgeflag_output;
 199
 200       /** TGSI program interpreter runtime state */
 201       struct tgsi_exec_machine *machine;
 202
 203       uint num_samplers;
 204       struct tgsi_sampler **samplers;
 205
 206       /* Here's another one:
 207        */
 208       struct aos_machine *aos_machine;
 209
 210
 211       const void *aligned_constants[PIPE_MAX_CONSTANT_BUFFERS];
 212
 213       const void *aligned_constant_storage[PIPE_MAX_CONSTANT_BUFFERS];
 214       unsigned const_storage_size[PIPE_MAX_CONSTANT_BUFFERS];
 215
 216
 217       struct translate *fetch;
 218       struct translate_cache *fetch_cache;
 219       struct translate *emit;
 220       struct translate_cache *emit_cache;
 221    } vs;
 222
 223    struct {
 224       struct draw_geometry_shader *geometry_shader;
 225       uint num_gs_outputs;  /**< convenience, from geometry_shader */
 226       uint position_output;
 227
 228       /** TGSI program interpreter runtime state */
 229       struct tgsi_exec_machine *machine;
 230
 231       uint num_samplers;
 232       struct tgsi_sampler **samplers;
 233    } gs;
 234
 235    /* Clip derived state:
 236     */
 237    float plane[12][4];
 238    unsigned nr_planes;
 239
 240    /* If a prim stage introduces new vertex attributes, they'll be stored here
 241     */
 242    struct {
 243       uint semantic_name;
 244       uint semantic_index;
 245       int slot;
 246    } extra_shader_outputs;
 247
 248    unsigned reduced_prim;
 249
 250    unsigned instance_id;
 251
 252 #ifdef HAVE_LLVM
 253    LLVMExecutionEngineRef engine;
 254 #endif
 255    void *driver_private;
 256 };
 257
 258 /*******************************************************************************
 259  * Draw common initialization code
 260  */
 261 boolean draw_init(struct draw_context *draw);
 262
 263 /*******************************************************************************
 264  * Vertex shader code:
 265  */
 266 boolean draw_vs_init( struct draw_context *draw );
 267 void draw_vs_destroy( struct draw_context *draw );
 268
 269 void draw_vs_set_viewport( struct draw_context *,
 270                            const struct pipe_viewport_state * );
 271
 272 void
 273 draw_vs_set_constants(struct draw_context *,
 274                       unsigned slot,
 275                       const void *constants,
 276                       unsigned size);
 277
 278
 279
 280 /*******************************************************************************
 281  * Geometry shading code:
 282  */
 283 boolean draw_gs_init( struct draw_context *draw );
 284
 285 void
 286 draw_gs_set_constants(struct draw_context *,
 287                       unsigned slot,
 288                       const void *constants,
 289                       unsigned size);
 290
 291 void draw_gs_destroy( struct draw_context *draw );
 292
 293 /*******************************************************************************
 294  * Common shading code:
 295  */
 296 uint draw_current_shader_outputs(const struct draw_context *draw);
 297 uint draw_current_shader_position_output(const struct draw_context *draw);
 298
 299 /*******************************************************************************
 300  * Vertex processing (was passthrough) code:
 301  */
 302 boolean draw_pt_init( struct draw_context *draw );
 303 void draw_pt_destroy( struct draw_context *draw );
 304 void draw_pt_reset_vertex_ids( struct draw_context *draw );
 305
 306
 307 /*******************************************************************************
 308  * Primitive processing (pipeline) code:
 309  */
 310
 311 boolean draw_pipeline_init( struct draw_context *draw );
 312 void draw_pipeline_destroy( struct draw_context *draw );
 313
 314
 315
 316
 317
 318 /* We use the top few bits in the elts[] parameter to convey a little
 319  * API information.  This limits the number of vertices we can address
 320  * to only 4096 -- if that becomes a problem, we can switch to 32-bit
 321  * draw indices.
 322  *
 323  * These flags expected at first vertex of lines & triangles when
 324  * unfilled and/or line stipple modes are operational.
 325  */
 326 #define DRAW_PIPE_MAX_VERTICES  (0x1<<12)
 327 #define DRAW_PIPE_EDGE_FLAG_0   (0x1<<12)
 328 #define DRAW_PIPE_EDGE_FLAG_1   (0x2<<12)
 329 #define DRAW_PIPE_EDGE_FLAG_2   (0x4<<12)
 330 #define DRAW_PIPE_EDGE_FLAG_ALL (0x7<<12)
 331 #define DRAW_PIPE_RESET_STIPPLE (0x8<<12)
 332 #define DRAW_PIPE_FLAG_MASK     (0xf<<12)
 333
 334 void draw_pipeline_run( struct draw_context *draw,
 335                         unsigned prim,
 336                         struct vertex_header *vertices,
 337                         unsigned vertex_count,
 338                         unsigned stride,
 339                         const ushort *elts,
 340                         unsigned count );
 341
 342 void draw_pipeline_run_linear( struct draw_context *draw,
 343                                unsigned prim,
 344                                struct vertex_header *vertices,
 345                                unsigned count,
 346                                unsigned stride );
 347
 348
 349
 350 void draw_pipeline_flush( struct draw_context *draw,
 351                           unsigned flags );
 352
 353
 354
 355 /*******************************************************************************
 356  * Flushing
 357  */
 358
 359 #define DRAW_FLUSH_STATE_CHANGE              0x8
 360 #define DRAW_FLUSH_BACKEND                   0x10
 361
 362
 363 void draw_do_flush( struct draw_context *draw, unsigned flags );
 364
 365
 366
 367 void *
 368 draw_get_rasterizer_no_cull( struct draw_context *draw,
 369                              boolean scissor,
 370                              boolean flatshade );
 371
 372
 373 #endif /* DRAW_PRIVATE_H */