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/geometry shader) */
 156          const void *vs_constants;
 157          const void *gs_constants;
 158       } user;
 159
 160       boolean test_fse;         /* enable FSE even though its not correct (eg for softpipe) */
 161       boolean no_fse;           /* disable FSE even when it is correct */
 162    } pt;
 163
 164    struct {
 165       boolean bypass_clipping;
 166       boolean bypass_vs;
 167    } driver;
 168
 169    boolean flushing;         /**< debugging/sanity */
 170    boolean suspend_flushing; /**< internally set */
 171    boolean bypass_clipping;  /**< set if either api or driver bypass_clipping true */
 172
 173    boolean force_passthrough; /**< never clip or shade */
 174
 175    double mrd;  /**< minimum resolvable depth value, for polygon offset */
 176
 177    /* pipe state that we need: */
 178    const struct pipe_rasterizer_state *rasterizer;
 179    struct pipe_viewport_state viewport;
 180    boolean identity_viewport;
 181
 182    struct {
 183       struct draw_vertex_shader *vertex_shader;
 184       uint num_vs_outputs;  /**< convenience, from vertex_shader */
 185       uint position_output;
 186       uint edgeflag_output;
 187
 188       /** TGSI program interpreter runtime state */
 189       struct tgsi_exec_machine *machine;
 190
 191       uint num_samplers;
 192       struct tgsi_sampler **samplers;
 193
 194       /* This (and the tgsi_exec_machine struct) probably need to be moved somewhere private.
 195        */
 196       struct gallivm_cpu_engine *engine;
 197
 198       /* Here's another one:
 199        */
 200       struct aos_machine *aos_machine;
 201
 202
 203       const float (*aligned_constants)[4];
 204
 205       const float (*aligned_constant_storage)[4];
 206       unsigned const_storage_size;
 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    void *driver_private;
 243 };
 244
 245
 246 /*******************************************************************************
 247  * Vertex shader code:
 248  */
 249 boolean draw_vs_init( struct draw_context *draw );
 250 void draw_vs_destroy( struct draw_context *draw );
 251
 252 void draw_vs_set_viewport( struct draw_context *,
 253                            const struct pipe_viewport_state * );
 254
 255 void draw_vs_set_constants( struct draw_context *,
 256                             const float (*constants)[4],
 257                             unsigned size );
 258
 259
 260
 261 /*******************************************************************************
 262  * Geometry shading code:
 263  */
 264 boolean draw_gs_init( struct draw_context *draw );
 265 void draw_gs_set_constants( struct draw_context *,
 266                             const float (*constants)[4],
 267                             unsigned size );
 268
 269 /*******************************************************************************
 270  * Common shading code:
 271  */
 272 int draw_current_shader_outputs(struct draw_context *draw);
 273 int draw_current_shader_position_output(struct draw_context *draw);
 274
 275 /*******************************************************************************
 276  * Vertex processing (was passthrough) code:
 277  */
 278 boolean draw_pt_init( struct draw_context *draw );
 279 void draw_pt_destroy( struct draw_context *draw );
 280 void draw_pt_reset_vertex_ids( struct draw_context *draw );
 281
 282
 283 /*******************************************************************************
 284  * Primitive processing (pipeline) code:
 285  */
 286
 287 boolean draw_pipeline_init( struct draw_context *draw );
 288 void draw_pipeline_destroy( struct draw_context *draw );
 289
 290
 291
 292
 293
 294 /* We use the top few bits in the elts[] parameter to convey a little
 295  * API information.  This limits the number of vertices we can address
 296  * to only 4096 -- if that becomes a problem, we can switch to 32-bit
 297  * draw indices.
 298  *
 299  * These flags expected at first vertex of lines & triangles when
 300  * unfilled and/or line stipple modes are operational.
 301  */
 302 #define DRAW_PIPE_MAX_VERTICES  (0x1<<12)
 303 #define DRAW_PIPE_EDGE_FLAG_0   (0x1<<12)
 304 #define DRAW_PIPE_EDGE_FLAG_1   (0x2<<12)
 305 #define DRAW_PIPE_EDGE_FLAG_2   (0x4<<12)
 306 #define DRAW_PIPE_EDGE_FLAG_ALL (0x7<<12)
 307 #define DRAW_PIPE_RESET_STIPPLE (0x8<<12)
 308 #define DRAW_PIPE_FLAG_MASK     (0xf<<12)
 309
 310 void draw_pipeline_run( struct draw_context *draw,
 311                         unsigned prim,
 312                         struct vertex_header *vertices,
 313                         unsigned vertex_count,
 314                         unsigned stride,
 315                         const ushort *elts,
 316                         unsigned count );
 317
 318 void draw_pipeline_run_linear( struct draw_context *draw,
 319                                unsigned prim,
 320                                struct vertex_header *vertices,
 321                                unsigned count,
 322                                unsigned stride );
 323
 324
 325
 326 void draw_pipeline_flush( struct draw_context *draw,
 327                           unsigned flags );
 328
 329
 330
 331 /*******************************************************************************
 332  * Flushing
 333  */
 334
 335 #define DRAW_FLUSH_STATE_CHANGE              0x8
 336 #define DRAW_FLUSH_BACKEND                   0x10
 337
 338
 339 void draw_do_flush( struct draw_context *draw, unsigned flags );
 340
 341
 342
 343
 344 #endif /* DRAW_PRIVATE_H */