draw_private.h 10.2 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
/**************************************************************************
 * 
 * Copyright 2007 Tungsten Graphics, Inc., Cedar Park, Texas.
 * All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sub license, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 * 
 * The above copyright notice and this permission notice (including the
 * next paragraph) shall be included in all copies or substantial portions
 * of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
 * IN NO EVENT SHALL TUNGSTEN GRAPHICS AND/OR ITS SUPPLIERS BE LIABLE FOR
 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 * 
 **************************************************************************/

28 29
/**
 * Private data structures, etc for the draw module.
30 31 32
 */


33 34 35 36 37 38
/**
 * Authors:
 * Keith Whitwell <keith@tungstengraphics.com>
 * Brian Paul
 */

39

40 41
#ifndef DRAW_PRIVATE_H
#define DRAW_PRIVATE_H
42 43


44 45
#include "pipe/p_state.h"
#include "pipe/p_defines.h"
Brian's avatar
Brian committed
46

47
#include "tgsi/tgsi_scan.h"
48

49
#ifdef HAVE_LLVM
50 51 52
#include <llvm-c/ExecutionEngine.h>
#endif

53

Brian's avatar
Brian committed
54
struct pipe_context;
55
struct draw_vertex_shader;
56 57 58
struct draw_context;
struct draw_stage;
struct vbuf_render;
59 60
struct tgsi_exec_machine;
struct tgsi_sampler;
61

62

63 64 65
/**
 * Basic vertex info.
 * Carry some useful information around with the vertices in the prim pipe.  
66
 */
67
struct vertex_header {
68 69
   unsigned clipmask:12;
   unsigned edgeflag:1;
70 71
   unsigned pad:3;
   unsigned vertex_id:16;
72

73
   float clip[4];
74

75 76 77
   /* This will probably become float (*data)[4] soon:
    */
   float data[][4];
78 79
};

80 81 82
/* NOTE: It should match vertex_id size above */
#define UNDEFINED_VERTEX_ID 0xffff

83 84 85 86 87 88

/**
 * Private context for the drawing module.
 */
struct draw_context
{
89
   /** Drawing/primitive pipeline stages */
90
   struct {
Brian's avatar
Brian committed
91
      struct draw_stage *first;  /**< one of the following */
92

93 94
      struct draw_stage *validate; 

95
      /* stages (in logical order) */
Brian's avatar
Brian committed
96 97 98 99 100 101
      struct draw_stage *flatshade;
      struct draw_stage *clip;
      struct draw_stage *cull;
      struct draw_stage *twoside;
      struct draw_stage *offset;
      struct draw_stage *unfilled;
102
      struct draw_stage *stipple;
Brian's avatar
Brian committed
103
      struct draw_stage *aapoint;
Brian's avatar
Brian committed
104
      struct draw_stage *aaline;
105
      struct draw_stage *pstipple;
106 107
      struct draw_stage *wide_line;
      struct draw_stage *wide_point;
108
      struct draw_stage *rasterize;
109 110 111 112 113 114

      float wide_point_threshold; /**< convert pnts to tris if larger than this */
      float wide_line_threshold;  /**< convert lines to tris if wider than this */
      boolean line_stipple;       /**< do line stipple? */
      boolean point_sprite;       /**< convert points to quads for sprites? */

115 116 117 118 119
      /* Temporary storage while the pipeline is being run:
       */
      char *verts;
      unsigned vertex_stride;
      unsigned vertex_count;
120 121
   } pipeline;

122 123 124 125 126 127

   struct vbuf_render *render;

   /* Support prototype passthrough path:
    */
   struct {
128
      struct {
129
         struct draw_pt_middle_end *fetch_emit;
130
         struct draw_pt_middle_end *fetch_shade_emit;
131
         struct draw_pt_middle_end *general;
132 133 134 135
      } middle;

      struct {
         struct draw_pt_front_end *vcache;
136
         struct draw_pt_front_end *varray;
137
      } front;
138 139 140 141 142 143 144 145 146 147 148 149 150

      struct pipe_vertex_buffer vertex_buffer[PIPE_MAX_ATTRIBS];
      unsigned nr_vertex_buffers;

      struct pipe_vertex_element vertex_element[PIPE_MAX_ATTRIBS];
      unsigned nr_vertex_elements;

      /* user-space vertex data, buffers */
      struct {
         /** vertex element/index buffer (ex: glDrawElements) */
         const void *elts;
         /** bytes per index (0, 1, 2 or 4) */
         unsigned eltSize;
151 152
         unsigned min_index;
         unsigned max_index;
153 154 155 156
         
         /** vertex arrays */
         const void *vbuffer[PIPE_MAX_ATTRIBS];
         
157
         /** constant buffer (for vertex/geometry shader) */
158 159
         const void *vs_constants[PIPE_MAX_CONSTANT_BUFFERS];
         const void *gs_constants[PIPE_MAX_CONSTANT_BUFFERS];
160 161
      } user;

162 163
      boolean test_fse;         /* enable FSE even though its not correct (eg for softpipe) */
      boolean no_fse;           /* disable FSE even when it is correct */
164 165
   } pt;

166 167
   struct {
      boolean bypass_clipping;
168
      boolean bypass_vs;
169 170
   } driver;

171 172 173
   boolean flushing;         /**< debugging/sanity */
   boolean suspend_flushing; /**< internally set */
   boolean bypass_clipping;  /**< set if either api or driver bypass_clipping true */
174

175 176
   boolean force_passthrough; /**< never clip or shade */

177 178
   boolean dump_vs;

179 180
   double mrd;  /**< minimum resolvable depth value, for polygon offset */

181
   /* pipe state that we need: */
182
   const struct pipe_rasterizer_state *rasterizer;
183
   struct pipe_viewport_state viewport;
184
   boolean identity_viewport;
185

186 187 188
   struct {
      struct draw_vertex_shader *vertex_shader;
      uint num_vs_outputs;  /**< convenience, from vertex_shader */
189
      uint position_output;
190
      uint edgeflag_output;
191

192
      /** TGSI program interpreter runtime state */
193
      struct tgsi_exec_machine *machine;
194

195 196 197
      uint num_samplers;
      struct tgsi_sampler **samplers;

Keith Whitwell's avatar
Keith Whitwell committed
198 199 200 201
      /* Here's another one:
       */
      struct aos_machine *aos_machine; 

202

203
      const void *aligned_constants[PIPE_MAX_CONSTANT_BUFFERS];
204

205 206
      const void *aligned_constant_storage[PIPE_MAX_CONSTANT_BUFFERS];
      unsigned const_storage_size[PIPE_MAX_CONSTANT_BUFFERS];
207 208


209
      struct translate *fetch;
210
      struct translate_cache *fetch_cache;
211
      struct translate *emit;
212 213
      struct translate_cache *emit_cache;
   } vs;
214

215 216 217 218 219 220 221 222 223 224 225 226
   struct {
      struct draw_geometry_shader *geometry_shader;
      uint num_gs_outputs;  /**< convenience, from geometry_shader */
      uint position_output;

      /** TGSI program interpreter runtime state */
      struct tgsi_exec_machine *machine;

      uint num_samplers;
      struct tgsi_sampler **samplers;
   } gs;

227 228
   /* Clip derived state:
    */
229 230
   float plane[12][4];
   unsigned nr_planes;
231

Brian's avatar
Brian committed
232 233 234 235 236 237
   /* If a prim stage introduces new vertex attributes, they'll be stored here
    */
   struct {
      uint semantic_name;
      uint semantic_index;
      int slot;
238
   } extra_shader_outputs;
Brian's avatar
Brian committed
239

240 241
   unsigned reduced_prim;

242 243
   unsigned instance_id;

244
#ifdef HAVE_LLVM
245 246
   LLVMExecutionEngineRef engine;
#endif
247
   void *driver_private;
248 249
};

250 251 252 253
/*******************************************************************************
 * Draw common initialization code
 */
boolean draw_init(struct draw_context *draw);
254

255 256 257 258 259
/*******************************************************************************
 * Vertex shader code:
 */
boolean draw_vs_init( struct draw_context *draw );
void draw_vs_destroy( struct draw_context *draw );
260

Keith Whitwell's avatar
Keith Whitwell committed
261 262 263
void draw_vs_set_viewport( struct draw_context *, 
                           const struct pipe_viewport_state * );

264 265 266 267 268
void
draw_vs_set_constants(struct draw_context *,
                      unsigned slot,
                      const void *constants,
                      unsigned size);
269

José Fonseca's avatar
José Fonseca committed
270

271

272 273 274 275
/*******************************************************************************
 * Geometry shading code:
 */
boolean draw_gs_init( struct draw_context *draw );
276 277 278 279 280 281 282

void
draw_gs_set_constants(struct draw_context *,
                      unsigned slot,
                      const void *constants,
                      unsigned size);

283
void draw_gs_destroy( struct draw_context *draw );
284 285 286 287

/*******************************************************************************
 * Common shading code:
 */
288 289
uint draw_current_shader_outputs(const struct draw_context *draw);
uint draw_current_shader_position_output(const struct draw_context *draw);
290

291 292 293 294 295 296
/*******************************************************************************
 * Vertex processing (was passthrough) code:
 */
boolean draw_pt_init( struct draw_context *draw );
void draw_pt_destroy( struct draw_context *draw );
void draw_pt_reset_vertex_ids( struct draw_context *draw );
297

298

299
/*******************************************************************************
300
 * Primitive processing (pipeline) code: 
301
 */
302

303 304
boolean draw_pipeline_init( struct draw_context *draw );
void draw_pipeline_destroy( struct draw_context *draw );
305

306 307 308 309 310 311 312 313 314 315 316 317




/* We use the top few bits in the elts[] parameter to convey a little
 * API information.  This limits the number of vertices we can address
 * to only 4096 -- if that becomes a problem, we can switch to 32-bit
 * draw indices.
 *
 * These flags expected at first vertex of lines & triangles when
 * unfilled and/or line stipple modes are operational.
 */
318
#define DRAW_PIPE_MAX_VERTICES  (0x1<<12)
319 320 321 322 323 324 325
#define DRAW_PIPE_EDGE_FLAG_0   (0x1<<12)
#define DRAW_PIPE_EDGE_FLAG_1   (0x2<<12)
#define DRAW_PIPE_EDGE_FLAG_2   (0x4<<12)
#define DRAW_PIPE_EDGE_FLAG_ALL (0x7<<12)
#define DRAW_PIPE_RESET_STIPPLE (0x8<<12)
#define DRAW_PIPE_FLAG_MASK     (0xf<<12)

326 327 328 329 330 331 332 333
void draw_pipeline_run( struct draw_context *draw,
                        unsigned prim,
                        struct vertex_header *vertices,
                        unsigned vertex_count,
                        unsigned stride,
                        const ushort *elts,
                        unsigned count );

Zack Rusin's avatar
Zack Rusin committed
334 335 336 337 338 339
void draw_pipeline_run_linear( struct draw_context *draw,
                               unsigned prim,
                               struct vertex_header *vertices,
                               unsigned count,
                               unsigned stride );

340 341


342 343 344
void draw_pipeline_flush( struct draw_context *draw, 
                          unsigned flags );

345

346

347 348 349 350
/*******************************************************************************
 * Flushing 
 */

351 352
#define DRAW_FLUSH_STATE_CHANGE              0x8
#define DRAW_FLUSH_BACKEND                   0x10
353 354


355
void draw_do_flush( struct draw_context *draw, unsigned flags );
356 357


358

359

360
#endif /* DRAW_PRIVATE_H */