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