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