summaryrefslogtreecommitdiff
path: root/src/gallium/auxiliary/draw/draw_private.h
blob: 03e3d3a66b6fb452c66f510c056288df3684e6a8 (plain)
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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
/**************************************************************************
 * 
 * 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.
 * 
 **************************************************************************/

/**
 * Private data structures, etc for the draw module.
 */


/**
 * Authors:
 * Keith Whitwell <keith@tungstengraphics.com>
 * Brian Paul
 */


#ifndef DRAW_PRIVATE_H
#define DRAW_PRIVATE_H


#include "pipe/p_state.h"
#include "pipe/p_defines.h"

#include "rtasm/rtasm_x86sse.h"
#include "tgsi/exec/tgsi_exec.h"


struct pipe_context;
struct gallivm_prog;
struct gallivm_cpu_engine;

/**
 * Basic vertex info.
 * Carry some useful information around with the vertices in the prim pipe.  
 */
struct vertex_header {
   unsigned clipmask:12;
   unsigned edgeflag:1;
   unsigned pad:3;
   unsigned vertex_id:16;

   float clip[4];

   float data[][4];		/* Note variable size */
};

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

/* XXX This is too large */
#define MAX_VERTEX_SIZE ((2 + PIPE_MAX_SHADER_OUTPUTS) * 4 * sizeof(float))



/**
 * Basic info for a point/line/triangle primitive.
 */
struct prim_header {
   float det;                 /**< front/back face determinant */
   unsigned reset_line_stipple:1;
   unsigned edgeflags:3;
   unsigned pad:28;
   struct vertex_header *v[3];  /**< 1 to 3 vertex pointers */
};



struct draw_context;

/**
 * Base class for all primitive drawing stages.
 */
struct draw_stage
{
   struct draw_context *draw;   /**< parent context */

   struct draw_stage *next;     /**< next stage in pipeline */

   struct vertex_header **tmp;  /**< temp vert storage, such as for clipping */
   unsigned nr_tmps;

   void (*point)( struct draw_stage *,
		  struct prim_header * );

   void (*line)( struct draw_stage *,
		 struct prim_header * );

   void (*tri)( struct draw_stage *,
		struct prim_header * );

   void (*flush)( struct draw_stage *,
		  unsigned flags );

   void (*reset_stipple_counter)( struct draw_stage * );

   void (*destroy)( struct draw_stage * );
};


#define PRIM_QUEUE_LENGTH      32
#define VCACHE_SIZE            32
#define VCACHE_OVERFLOW        4
#define VS_QUEUE_LENGTH        (VCACHE_SIZE + VCACHE_OVERFLOW + 1)	/* can never fill up */

/**
 * Private version of the compiled vertex_shader
 */
struct draw_vertex_shader {

   /* This member will disappear shortly:
    */
   const struct pipe_shader_state   *state;

   void (*prepare)( struct draw_vertex_shader *shader,
		    struct draw_context *draw );

   /* Run the shader - this interface will get cleaned up in the
    * future:
    */
   void (*run)( struct draw_vertex_shader *shader,
		struct draw_context *draw,
		const unsigned *elts, 
		unsigned count,
		struct vertex_header *vOut[] );
		    

   void (*delete)( struct draw_vertex_shader * );
};


/* Internal function for vertex fetch.
 */
typedef void (*fetch_func)(const void *ptr, float *attrib);
typedef void (*full_fetch_func)( struct draw_context *draw,
				 struct tgsi_exec_machine *machine,
				 const unsigned *elts,
				 unsigned count );



/**
 * Private context for the drawing module.
 */
struct draw_context
{
   /** Drawing/primitive pipeline stages */
   struct {
      struct draw_stage *first;  /**< one of the following */

      struct draw_stage *validate; 

      /* stages (in logical order) */
      struct draw_stage *flatshade;
      struct draw_stage *clip;
      struct draw_stage *cull;
      struct draw_stage *twoside;
      struct draw_stage *offset;
      struct draw_stage *unfilled;
      struct draw_stage *stipple;
      struct draw_stage *aapoint;
      struct draw_stage *aaline;
      struct draw_stage *pstipple;
      struct draw_stage *wide;
      struct draw_stage *rasterize;
   } pipeline;

   /* pipe state that we need: */
   const struct pipe_rasterizer_state *rasterizer;
   struct pipe_viewport_state viewport;
   struct pipe_vertex_buffer vertex_buffer[PIPE_ATTRIB_MAX];
   struct pipe_vertex_element vertex_element[PIPE_ATTRIB_MAX];
   struct draw_vertex_shader *vertex_shader;

   uint num_vs_outputs;  /**< convenience, from vertex_shader */

   /* 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;

      /** vertex arrays */
      const void *vbuffer[PIPE_ATTRIB_MAX];

      /** constant buffer (for vertex shader) */
      const void *constants;
   } user;

   /* Clip derived state:
    */
   float plane[12][4];
   unsigned nr_planes;

   float wide_point_threshold; /**< convert pnts to tris if larger than this */
   boolean convert_wide_lines;  /**< convert wide lines to tris? */
   boolean use_sse;

   /* If a prim stage introduces new vertex attributes, they'll be stored here
    */
   struct {
      uint semantic_name;
      uint semantic_index;
      int slot;
   } extra_vp_outputs;

   unsigned reduced_prim;

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

   /* Vertex fetch internal state
    */
   struct {
      const ubyte *src_ptr[PIPE_ATTRIB_MAX];
      unsigned pitch[PIPE_ATTRIB_MAX];
      fetch_func fetch[PIPE_ATTRIB_MAX];
      unsigned nr_attrs;
      full_fetch_func fetch_func;
   } vertex_fetch;

   /* Post-tnl vertex cache:
    */
   struct {
      unsigned referenced;  /**< bitfield */

      struct {
	 unsigned in;		/* client array element */
	 unsigned out;		/* index in vs queue/array */
      } idx[VCACHE_SIZE + VCACHE_OVERFLOW];

      unsigned overflow;

      /** To find space in the vertex cache: */
      struct vertex_header *(*get_vertex)( struct draw_context *draw,
                                           unsigned i );
   } vcache;

   /* Vertex shader queue:
    */
   struct {
      struct {
	 unsigned elt;   /**< index into the user's vertex arrays */
	 struct vertex_header *vertex;
      } queue[VS_QUEUE_LENGTH];
      unsigned queue_nr;
      unsigned post_nr;
   } vs;

   /**
    * Run the vertex shader on all vertices in the vertex queue.
    */
   void (*shader_queue_flush)(struct draw_context *draw);

   /* Prim pipeline queue:
    */
   struct {
      /* Need to queue up primitives until their vertices have been
       * transformed by a vs queue flush.
       */
      struct prim_header queue[PRIM_QUEUE_LENGTH];
      unsigned queue_nr;
   } pq;


   /* This (and the tgsi_exec_machine struct) probably need to be moved somewhere private.
    */
   struct gallivm_cpu_engine *engine;   
   void *driver_private;
};



extern struct draw_stage *draw_unfilled_stage( struct draw_context *context );
extern struct draw_stage *draw_twoside_stage( struct draw_context *context );
extern struct draw_stage *draw_offset_stage( struct draw_context *context );
extern struct draw_stage *draw_clip_stage( struct draw_context *context );
extern struct draw_stage *draw_flatshade_stage( struct draw_context *context );
extern struct draw_stage *draw_cull_stage( struct draw_context *context );
extern struct draw_stage *draw_stipple_stage( struct draw_context *context );
extern struct draw_stage *draw_wide_stage( struct draw_context *context );
extern struct draw_stage *draw_validate_stage( struct draw_context *context );


extern void draw_free_temp_verts( struct draw_stage *stage );

extern void draw_alloc_temp_verts( struct draw_stage *stage, unsigned nr );

extern void draw_reset_vertex_ids( struct draw_context *draw );


extern int draw_vertex_cache_check_space( struct draw_context *draw, 
					  unsigned nr_verts );

extern void draw_vertex_cache_invalidate( struct draw_context *draw );
extern void draw_vertex_cache_unreference( struct draw_context *draw );
extern void draw_vertex_cache_reset_vertex_ids( struct draw_context *draw );

extern void draw_vertex_shader_queue_flush( struct draw_context *draw );

struct tgsi_exec_machine;

extern void draw_update_vertex_fetch( struct draw_context *draw );


#define DRAW_FLUSH_SHADER_QUEUE              0x1 /* sized not to overflow, never raised */
#define DRAW_FLUSH_PRIM_QUEUE                0x2
#define DRAW_FLUSH_VERTEX_CACHE              0x4
#define DRAW_FLUSH_STATE_CHANGE              0x8
#define DRAW_FLUSH_BACKEND                   0x10


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



/**
 * Get a writeable copy of a vertex.
 * \param stage  drawing stage info
 * \param vert  the vertex to copy (source)
 * \param idx  index into stage's tmp[] array to put the copy (dest)
 * \return  pointer to the copied vertex
 */
static INLINE struct vertex_header *
dup_vert( struct draw_stage *stage,
	  const struct vertex_header *vert,
	  unsigned idx )
{   
   struct vertex_header *tmp = stage->tmp[idx];
   const uint vsize = sizeof(struct vertex_header)
      + stage->draw->num_vs_outputs * 4 * sizeof(float);
   memcpy(tmp, vert, vsize);
   tmp->vertex_id = UNDEFINED_VERTEX_ID;
   return tmp;
}

static INLINE float
dot4(const float *a, const float *b)
{
   float result = (a[0]*b[0] +
                   a[1]*b[1] +
                   a[2]*b[2] +
                   a[3]*b[3]);

   return result;
}

#endif /* DRAW_PRIVATE_H */