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 draw_vertex_shader;
  52 struct draw_context;
  53 struct draw_stage;
  54 struct vbuf_render;
  55 struct tgsi_exec_machine;
  56 struct tgsi_sampler;
  57
  58
  59 /**
  60  * Basic vertex info.
  61  * Carry some useful information around with the vertices in the prim pipe.
  62  */
  63 struct vertex_header {
  64    unsigned clipmask:12;
  65    unsigned edgeflag:1;
  66    unsigned pad:3;
  67    unsigned vertex_id:16;
  68
  69    float clip[4];
  70
  71    /* This will probably become float (*data)[4] soon:
  72     */
  73    float data[][4];
  74 };
  75
  76 /* NOTE: It should match vertex_id size above */
  77 #define UNDEFINED_VERTEX_ID 0xffff
  78
  79
  80 /**
  81  * Private context for the drawing module.
  82  */
  83 struct draw_context
  84 {
  85    struct pipe_context *pipe;
  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[PIPE_MAX_CONSTANT_BUFFERS];
 157          const void *gs_constants[PIPE_MAX_CONSTANT_BUFFERS];
 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    boolean dump_vs;
 176
 177    double mrd;  /**< minimum resolvable depth value, for polygon offset */
 178
 179    /** Current rasterizer state given to us by the driver */
 180    const struct pipe_rasterizer_state *rasterizer;
 181    /** Driver CSO handle for the current rasterizer state */
 182    void *rast_handle;
 183
 184    /** Rasterizer CSOs without culling/stipple/etc */
 185    void *rasterizer_no_cull[2][2];
 186
 187    struct pipe_viewport_state viewport;
 188    boolean identity_viewport;
 189
 190    struct {
 191       struct draw_vertex_shader *vertex_shader;
 192       uint num_vs_outputs;  /**< convenience, from vertex_shader */
 193       uint position_output;
 194       uint edgeflag_output;
 195
 196       /** TGSI program interpreter runtime state */
 197       struct tgsi_exec_machine *machine;
 198
 199       uint num_samplers;
 200       struct tgsi_sampler **samplers;
 201
 202       /* Here's another one:
 203        */
 204       struct aos_machine *aos_machine;
 205
 206
 207       const void *aligned_constants[PIPE_MAX_CONSTANT_BUFFERS];
 208
 209       const void *aligned_constant_storage[PIPE_MAX_CONSTANT_BUFFERS];
 210       unsigned const_storage_size[PIPE_MAX_CONSTANT_BUFFERS];
 211
 212
 213       struct translate *fetch;
 214       struct translate_cache *fetch_cache;
 215       struct translate *emit;
 216       struct translate_cache *emit_cache;
 217    } vs;
 218
 219    struct {
 220       struct draw_geometry_shader *geometry_shader;
 221       uint num_gs_outputs;  /**< convenience, from geometry_shader */
 222       uint position_output;
 223
 224       /** TGSI program interpreter runtime state */
 225       struct tgsi_exec_machine *machine;
 226
 227       uint num_samplers;
 228       struct tgsi_sampler **samplers;
 229    } gs;
 230
 231    /* Clip derived state:
 232     */
 233    float plane[12][4];
 234    unsigned nr_planes;
 235
 236    /* If a prim stage introduces new vertex attributes, they'll be stored here
 237     */
 238    struct {
 239       uint semantic_name;
 240       uint semantic_index;
 241       int slot;
 242    } extra_shader_outputs;
 243
 244    unsigned reduced_prim;
 245
 246    unsigned instance_id;
 247
 248    void *driver_private;
 249 };
 250
 251
 252 /*******************************************************************************
 253  * Vertex shader code:
 254  */
 255 boolean draw_vs_init( struct draw_context *draw );
 256 void draw_vs_destroy( struct draw_context *draw );
 257
 258 void draw_vs_set_viewport( struct draw_context *,
 259                            const struct pipe_viewport_state * );
 260
 261 void
 262 draw_vs_set_constants(struct draw_context *,
 263                       unsigned slot,
 264                       const void *constants,
 265                       unsigned size);
 266
 267
 268
 269 /*******************************************************************************
 270  * Geometry shading code:
 271  */
 272 boolean draw_gs_init( struct draw_context *draw );
 273
 274 void
 275 draw_gs_set_constants(struct draw_context *,
 276                       unsigned slot,
 277                       const void *constants,
 278                       unsigned size);
 279
 280 void draw_gs_destroy( struct draw_context *draw );
 281
 282 /*******************************************************************************
 283  * Common shading code:
 284  */
 285 uint draw_current_shader_outputs(const struct draw_context *draw);
 286 uint draw_current_shader_position_output(const struct draw_context *draw);
 287
 288 /*******************************************************************************
 289  * Vertex processing (was passthrough) code:
 290  */
 291 boolean draw_pt_init( struct draw_context *draw );
 292 void draw_pt_destroy( struct draw_context *draw );
 293 void draw_pt_reset_vertex_ids( struct draw_context *draw );
 294
 295
 296 /*******************************************************************************
 297  * Primitive processing (pipeline) code:
 298  */
 299
 300 boolean draw_pipeline_init( struct draw_context *draw );
 301 void draw_pipeline_destroy( struct draw_context *draw );
 302
 303
 304
 305
 306
 307 /* We use the top few bits in the elts[] parameter to convey a little
 308  * API information.  This limits the number of vertices we can address
 309  * to only 4096 -- if that becomes a problem, we can switch to 32-bit
 310  * draw indices.
 311  *
 312  * These flags expected at first vertex of lines & triangles when
 313  * unfilled and/or line stipple modes are operational.
 314  */
 315 #define DRAW_PIPE_MAX_VERTICES  (0x1<<12)
 316 #define DRAW_PIPE_EDGE_FLAG_0   (0x1<<12)
 317 #define DRAW_PIPE_EDGE_FLAG_1   (0x2<<12)
 318 #define DRAW_PIPE_EDGE_FLAG_2   (0x4<<12)
 319 #define DRAW_PIPE_EDGE_FLAG_ALL (0x7<<12)
 320 #define DRAW_PIPE_RESET_STIPPLE (0x8<<12)
 321 #define DRAW_PIPE_FLAG_MASK     (0xf<<12)
 322
 323 void draw_pipeline_run( struct draw_context *draw,
 324                         unsigned prim,
 325                         struct vertex_header *vertices,
 326                         unsigned vertex_count,
 327                         unsigned stride,
 328                         const ushort *elts,
 329                         unsigned count );
 330
 331 void draw_pipeline_run_linear( struct draw_context *draw,
 332                                unsigned prim,
 333                                struct vertex_header *vertices,
 334                                unsigned count,
 335                                unsigned stride );
 336
 337
 338
 339 void draw_pipeline_flush( struct draw_context *draw,
 340                           unsigned flags );
 341
 342
 343
 344 /*******************************************************************************
 345  * Flushing
 346  */
 347
 348 #define DRAW_FLUSH_STATE_CHANGE              0x8
 349 #define DRAW_FLUSH_BACKEND                   0x10
 350
 351
 352 void draw_do_flush( struct draw_context *draw, unsigned flags );
 353
 354
 355
 356 void *
 357 draw_get_rasterizer_no_cull( struct draw_context *draw,
 358                              boolean scissor,
 359                              boolean flatshade );
 360
 361
 362 #endif /* DRAW_PRIVATE_H */