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