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 HAVE_LLVM
  50 #include <llvm-c/ExecutionEngine.h>
  51 struct draw_llvm;
  52 #endif
  53
  54
  55 struct pipe_context;
  56 struct draw_vertex_shader;
  57 struct draw_context;
  58 struct draw_stage;
  59 struct vbuf_render;
  60 struct tgsi_exec_machine;
  61 struct tgsi_sampler;
  62
  63
  64 /**
  65  * Basic vertex info.
  66  * Carry some useful information around with the vertices in the prim pipe.
  67  */
  68 struct vertex_header {
  69    unsigned clipmask:12;
  70    unsigned edgeflag:1;
  71    unsigned pad:3;
  72    unsigned vertex_id:16;
  73
  74    float clip[4];
  75
  76    /* This will probably become float (*data)[4] soon:
  77     */
  78    float data[][4];
  79 };
  80
  81 /* NOTE: It should match vertex_id size above */
  82 #define UNDEFINED_VERTEX_ID 0xffff
  83
  84
  85 /* maximum number of shader variants we can cache */
  86 #define DRAW_MAX_SHADER_VARIANTS 1024
  87
  88 /**
  89  * Private context for the drawing module.
  90  */
  91 struct draw_context
  92 {
  93    struct pipe_context *pipe;
  94
  95    /** Drawing/primitive pipeline stages */
  96    struct {
  97       struct draw_stage *first;  /**< one of the following */
  98
  99       struct draw_stage *validate;
 100
 101       /* stages (in logical order) */
 102       struct draw_stage *flatshade;
 103       struct draw_stage *clip;
 104       struct draw_stage *cull;
 105       struct draw_stage *twoside;
 106       struct draw_stage *offset;
 107       struct draw_stage *unfilled;
 108       struct draw_stage *stipple;
 109       struct draw_stage *aapoint;
 110       struct draw_stage *aaline;
 111       struct draw_stage *pstipple;
 112       struct draw_stage *wide_line;
 113       struct draw_stage *wide_point;
 114       struct draw_stage *rasterize;
 115
 116       float wide_point_threshold; /**< convert pnts to tris if larger than this */
 117       float wide_line_threshold;  /**< convert lines to tris if wider than this */
 118       boolean wide_point_sprites; /**< convert points to tris for sprite mode */
 119       boolean line_stipple;       /**< do line stipple? */
 120       boolean point_sprite;       /**< convert points to quads for sprites? */
 121
 122       /* Temporary storage while the pipeline is being run:
 123        */
 124       char *verts;
 125       unsigned vertex_stride;
 126       unsigned vertex_count;
 127    } pipeline;
 128
 129
 130    struct vbuf_render *render;
 131
 132    /* Support prototype passthrough path:
 133     */
 134    struct {
 135       struct {
 136          struct draw_pt_middle_end *fetch_emit;
 137          struct draw_pt_middle_end *fetch_shade_emit;
 138          struct draw_pt_middle_end *general;
 139          struct draw_pt_middle_end *llvm;
 140       } middle;
 141
 142       struct {
 143          struct draw_pt_front_end *vsplit;
 144       } front;
 145
 146       struct pipe_vertex_buffer vertex_buffer[PIPE_MAX_ATTRIBS];
 147       unsigned nr_vertex_buffers;
 148
 149       struct pipe_vertex_element vertex_element[PIPE_MAX_ATTRIBS];
 150       unsigned nr_vertex_elements;
 151
 152       struct pipe_index_buffer index_buffer;
 153
 154       /* user-space vertex data, buffers */
 155       struct {
 156          /** vertex element/index buffer (ex: glDrawElements) */
 157          const void *elts;
 158          /** bytes per index (0, 1, 2 or 4) */
 159          unsigned eltSize;
 160          int eltBias;
 161          unsigned min_index;
 162          unsigned max_index;
 163
 164          /** vertex arrays */
 165          const void *vbuffer[PIPE_MAX_ATTRIBS];
 166
 167          /** constant buffers (for vertex/geometry shader) */
 168          const void *vs_constants[PIPE_MAX_CONSTANT_BUFFERS];
 169          unsigned vs_constants_size[PIPE_MAX_CONSTANT_BUFFERS];
 170          const void *gs_constants[PIPE_MAX_CONSTANT_BUFFERS];
 171          unsigned gs_constants_size[PIPE_MAX_CONSTANT_BUFFERS];
 172       } user;
 173
 174       boolean test_fse;         /* enable FSE even though its not correct (eg for softpipe) */
 175       boolean no_fse;           /* disable FSE even when it is correct */
 176    } pt;
 177
 178    struct {
 179       boolean bypass_clip_xy;
 180       boolean bypass_clip_z;
 181    } driver;
 182
 183    boolean flushing;         /**< debugging/sanity */
 184    boolean suspend_flushing; /**< internally set */
 185
 186    /* Flags set if API requires clipping in these planes and the
 187     * driver doesn't indicate that it can do it for us.
 188     */
 189    boolean clip_xy;
 190    boolean clip_z;
 191    boolean clip_user;
 192
 193    boolean force_passthrough; /**< never clip or shade */
 194
 195    boolean dump_vs;
 196
 197    double mrd;  /**< minimum resolvable depth value, for polygon offset */
 198
 199    /** Current rasterizer state given to us by the driver */
 200    const struct pipe_rasterizer_state *rasterizer;
 201    /** Driver CSO handle for the current rasterizer state */
 202    void *rast_handle;
 203
 204    /** Rasterizer CSOs without culling/stipple/etc */
 205    void *rasterizer_no_cull[2][2];
 206
 207    struct pipe_viewport_state viewport;
 208    boolean identity_viewport;
 209
 210    /** Vertex shader state */
 211    struct {
 212       struct draw_vertex_shader *vertex_shader;
 213       uint num_vs_outputs;  /**< convenience, from vertex_shader */
 214       uint position_output;
 215       uint edgeflag_output;
 216
 217       /** TGSI program interpreter runtime state */
 218       struct tgsi_exec_machine *machine;
 219
 220       uint num_samplers;
 221       struct tgsi_sampler **samplers;
 222
 223       /* Here's another one:
 224        */
 225       struct aos_machine *aos_machine;
 226
 227
 228       const void *aligned_constants[PIPE_MAX_CONSTANT_BUFFERS];
 229
 230       const void *aligned_constant_storage[PIPE_MAX_CONSTANT_BUFFERS];
 231       unsigned const_storage_size[PIPE_MAX_CONSTANT_BUFFERS];
 232
 233
 234       struct translate *fetch;
 235       struct translate_cache *fetch_cache;
 236       struct translate *emit;
 237       struct translate_cache *emit_cache;
 238    } vs;
 239
 240    /** Geometry shader state */
 241    struct {
 242       struct draw_geometry_shader *geometry_shader;
 243       uint num_gs_outputs;  /**< convenience, from geometry_shader */
 244       uint position_output;
 245
 246       /** TGSI program interpreter runtime state */
 247       struct tgsi_exec_machine *machine;
 248
 249       uint num_samplers;
 250       struct tgsi_sampler **samplers;
 251    } gs;
 252
 253    /** Stream output (vertex feedback) state */
 254    struct {
 255       struct pipe_stream_output_state state;
 256       void *buffers[PIPE_MAX_SO_BUFFERS];
 257       uint num_buffers;
 258    } so;
 259
 260    /* Clip derived state:
 261     */
 262    float plane[12][4];
 263    unsigned nr_planes;
 264    boolean depth_clamp;
 265
 266    /* If a prim stage introduces new vertex attributes, they'll be stored here
 267     */
 268    struct {
 269       uint semantic_name;
 270       uint semantic_index;
 271       int slot;
 272    } extra_shader_outputs;
 273
 274    unsigned reduced_prim;
 275
 276    unsigned instance_id;
 277
 278 #ifdef HAVE_LLVM
 279    struct draw_llvm *llvm;
 280    LLVMExecutionEngineRef engine;
 281 #endif
 282
 283    struct pipe_sampler_view *sampler_views[PIPE_MAX_VERTEX_SAMPLERS];
 284    unsigned num_sampler_views;
 285    const struct pipe_sampler_state *samplers[PIPE_MAX_VERTEX_SAMPLERS];
 286    unsigned num_samplers;
 287
 288    void *driver_private;
 289 };
 290
 291
 292 struct draw_fetch_info {
 293    boolean linear;
 294    unsigned start;
 295    const unsigned *elts;
 296    unsigned count;
 297 };
 298
 299 struct draw_vertex_info {
 300    struct vertex_header *verts;
 301    unsigned vertex_size;
 302    unsigned stride;
 303    unsigned count;
 304 };
 305
 306 /* these flags are set if the primitive is a segment of a larger one */
 307 #define DRAW_SPLIT_BEFORE 0x1
 308 #define DRAW_SPLIT_AFTER  0x2
 309
 310 struct draw_prim_info {
 311    boolean linear;
 312    unsigned start;
 313
 314    const ushort *elts;
 315    unsigned count;
 316
 317    unsigned prim;
 318    unsigned flags;
 319    unsigned *primitive_lengths;
 320    unsigned primitive_count;
 321 };
 322
 323
 324 /*******************************************************************************
 325  * Draw common initialization code
 326  */
 327 boolean draw_init(struct draw_context *draw);
 328
 329 /*******************************************************************************
 330  * Vertex shader code:
 331  */
 332 boolean draw_vs_init( struct draw_context *draw );
 333 void draw_vs_destroy( struct draw_context *draw );
 334
 335 void draw_vs_set_viewport( struct draw_context *,
 336                            const struct pipe_viewport_state * );
 337
 338 void
 339 draw_vs_set_constants(struct draw_context *,
 340                       unsigned slot,
 341                       const void *constants,
 342                       unsigned size);
 343
 344
 345
 346 /*******************************************************************************
 347  * Geometry shading code:
 348  */
 349 boolean draw_gs_init( struct draw_context *draw );
 350
 351 void
 352 draw_gs_set_constants(struct draw_context *,
 353                       unsigned slot,
 354                       const void *constants,
 355                       unsigned size);
 356
 357 void draw_gs_destroy( struct draw_context *draw );
 358
 359 /*******************************************************************************
 360  * Common shading code:
 361  */
 362 uint draw_current_shader_outputs(const struct draw_context *draw);
 363 uint draw_current_shader_position_output(const struct draw_context *draw);
 364
 365 /*******************************************************************************
 366  * Vertex processing (was passthrough) code:
 367  */
 368 boolean draw_pt_init( struct draw_context *draw );
 369 void draw_pt_destroy( struct draw_context *draw );
 370 void draw_pt_reset_vertex_ids( struct draw_context *draw );
 371
 372
 373 /*******************************************************************************
 374  * Primitive processing (pipeline) code:
 375  */
 376
 377 boolean draw_pipeline_init( struct draw_context *draw );
 378 void draw_pipeline_destroy( struct draw_context *draw );
 379
 380
 381
 382
 383
 384 /*
 385  * These flags are used by the pipeline when unfilled and/or line stipple modes
 386  * are operational.
 387  */
 388 #define DRAW_PIPE_EDGE_FLAG_0   0x1
 389 #define DRAW_PIPE_EDGE_FLAG_1   0x2
 390 #define DRAW_PIPE_EDGE_FLAG_2   0x4
 391 #define DRAW_PIPE_EDGE_FLAG_ALL 0x7
 392 #define DRAW_PIPE_RESET_STIPPLE 0x8
 393
 394 void draw_pipeline_run( struct draw_context *draw,
 395                         const struct draw_vertex_info *vert,
 396                         const struct draw_prim_info *prim);
 397
 398 void draw_pipeline_run_linear( struct draw_context *draw,
 399                                const struct draw_vertex_info *vert,
 400                                const struct draw_prim_info *prim);
 401
 402
 403
 404
 405 void draw_pipeline_flush( struct draw_context *draw,
 406                           unsigned flags );
 407
 408
 409
 410 /*******************************************************************************
 411  * Flushing
 412  */
 413
 414 #define DRAW_FLUSH_STATE_CHANGE              0x8
 415 #define DRAW_FLUSH_BACKEND                   0x10
 416
 417
 418 void draw_do_flush( struct draw_context *draw, unsigned flags );
 419
 420
 421
 422 void *
 423 draw_get_rasterizer_no_cull( struct draw_context *draw,
 424                              boolean scissor,
 425                              boolean flatshade );
 426
 427
 428 #endif /* DRAW_PRIVATE_H */