draw_private.h revision 4465efc3bf8d755a9afb7a4bb5382e2f5bf113e1 
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>
51struct draw_llvm;
52#endif
53
54
55struct pipe_context;
56struct draw_vertex_shader;
57struct draw_context;
58struct draw_stage;
59struct vbuf_render;
60struct tgsi_exec_machine;
61struct tgsi_sampler;
62
63
64/**
65 * Basic vertex info.
66 * Carry some useful information around with the vertices in the prim pipe.
67 */
68struct 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 128
87
88/**
89 * Private context for the drawing module.
90 */
91struct 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      /*
150       * This is the largest legal index value for the current set of
151       * bound vertex buffers.  Regardless of any other consideration,
152       * all vertex lookups need to be clamped to 0..max_index to
153       * prevent out-of-bound access.
154       */
155      unsigned max_index;
156
157      struct pipe_vertex_element vertex_element[PIPE_MAX_ATTRIBS];
158      unsigned nr_vertex_elements;
159
160      struct pipe_index_buffer index_buffer;
161
162      /* user-space vertex data, buffers */
163      struct {
164         /** vertex element/index buffer (ex: glDrawElements) */
165         const void *elts;
166         /** bytes per index (0, 1, 2 or 4) */
167         unsigned eltSize;
168         int eltBias;
169         unsigned min_index;
170         unsigned max_index;
171
172         /** vertex arrays */
173         const void *vbuffer[PIPE_MAX_ATTRIBS];
174
175         /** constant buffers (for vertex/geometry shader) */
176         const void *vs_constants[PIPE_MAX_CONSTANT_BUFFERS];
177         unsigned vs_constants_size[PIPE_MAX_CONSTANT_BUFFERS];
178         const void *gs_constants[PIPE_MAX_CONSTANT_BUFFERS];
179         unsigned gs_constants_size[PIPE_MAX_CONSTANT_BUFFERS];
180
181         /* pointer to planes */
182         float (*planes)[12][4];
183      } user;
184
185      boolean test_fse;         /* enable FSE even though its not correct (eg for softpipe) */
186      boolean no_fse;           /* disable FSE even when it is correct */
187   } pt;
188
189   struct {
190      boolean bypass_clip_xy;
191      boolean bypass_clip_z;
192      boolean guard_band_xy;
193   } driver;
194
195   boolean flushing;         /**< debugging/sanity */
196   boolean suspend_flushing; /**< internally set */
197
198   /* Flags set if API requires clipping in these planes and the
199    * driver doesn't indicate that it can do it for us.
200    */
201   boolean clip_xy;
202   boolean clip_z;
203   boolean clip_user;
204   boolean guard_band_xy;
205
206   boolean force_passthrough; /**< never clip or shade */
207
208   boolean dump_vs;
209
210   double mrd;  /**< minimum resolvable depth value, for polygon offset */
211
212   /** Current rasterizer state given to us by the driver */
213   const struct pipe_rasterizer_state *rasterizer;
214   /** Driver CSO handle for the current rasterizer state */
215   void *rast_handle;
216
217   /** Rasterizer CSOs without culling/stipple/etc */
218   void *rasterizer_no_cull[2][2];
219
220   struct pipe_viewport_state viewport;
221   boolean identity_viewport;
222
223   /** Vertex shader state */
224   struct {
225      struct draw_vertex_shader *vertex_shader;
226      uint num_vs_outputs;  /**< convenience, from vertex_shader */
227      uint position_output;
228      uint edgeflag_output;
229
230      /** TGSI program interpreter runtime state */
231      struct tgsi_exec_machine *machine;
232
233      uint num_samplers;
234      struct tgsi_sampler **samplers;
235
236      /* Here's another one:
237       */
238      struct aos_machine *aos_machine;
239
240
241      const void *aligned_constants[PIPE_MAX_CONSTANT_BUFFERS];
242
243      const void *aligned_constant_storage[PIPE_MAX_CONSTANT_BUFFERS];
244      unsigned const_storage_size[PIPE_MAX_CONSTANT_BUFFERS];
245
246
247      struct translate *fetch;
248      struct translate_cache *fetch_cache;
249      struct translate *emit;
250      struct translate_cache *emit_cache;
251   } vs;
252
253   /** Geometry shader state */
254   struct {
255      struct draw_geometry_shader *geometry_shader;
256      uint num_gs_outputs;  /**< convenience, from geometry_shader */
257      uint position_output;
258
259      /** TGSI program interpreter runtime state */
260      struct tgsi_exec_machine *machine;
261
262      uint num_samplers;
263      struct tgsi_sampler **samplers;
264   } gs;
265
266   /** Fragment shader state */
267   struct {
268      struct draw_fragment_shader *fragment_shader;
269   } fs;
270
271   /** Stream output (vertex feedback) state */
272   struct {
273      struct pipe_stream_output_state state;
274      void *buffers[PIPE_MAX_SO_BUFFERS];
275      uint num_buffers;
276   } so;
277
278   /* Clip derived state:
279    */
280   float plane[12][4];
281   unsigned nr_planes;
282   boolean depth_clamp;
283
284   /* If a prim stage introduces new vertex attributes, they'll be stored here
285    */
286   struct {
287      uint num;
288      uint semantic_name[10];
289      uint semantic_index[10];
290      uint slot[10];
291   } extra_shader_outputs;
292
293   unsigned reduced_prim;
294
295   unsigned instance_id;
296
297#ifdef HAVE_LLVM
298   struct draw_llvm *llvm;
299   struct gallivm_state *own_gallivm;
300#endif
301
302   struct pipe_sampler_view *sampler_views[PIPE_MAX_VERTEX_SAMPLERS];
303   unsigned num_sampler_views;
304   const struct pipe_sampler_state *samplers[PIPE_MAX_VERTEX_SAMPLERS];
305   unsigned num_samplers;
306
307   void *driver_private;
308};
309
310
311struct draw_fetch_info {
312   boolean linear;
313   unsigned start;
314   const unsigned *elts;
315   unsigned count;
316};
317
318struct draw_vertex_info {
319   struct vertex_header *verts;
320   unsigned vertex_size;
321   unsigned stride;
322   unsigned count;
323};
324
325/* these flags are set if the primitive is a segment of a larger one */
326#define DRAW_SPLIT_BEFORE 0x1
327#define DRAW_SPLIT_AFTER  0x2
328
329struct draw_prim_info {
330   boolean linear;
331   unsigned start;
332
333   const ushort *elts;
334   unsigned count;
335
336   unsigned prim;
337   unsigned flags;
338   unsigned *primitive_lengths;
339   unsigned primitive_count;
340};
341
342
343/*******************************************************************************
344 * Draw common initialization code
345 */
346boolean draw_init(struct draw_context *draw);
347
348/*******************************************************************************
349 * Vertex shader code:
350 */
351boolean draw_vs_init( struct draw_context *draw );
352void draw_vs_destroy( struct draw_context *draw );
353
354void draw_vs_set_viewport( struct draw_context *,
355                           const struct pipe_viewport_state * );
356
357void
358draw_vs_set_constants(struct draw_context *,
359                      unsigned slot,
360                      const void *constants,
361                      unsigned size);
362
363
364
365/*******************************************************************************
366 * Geometry shading code:
367 */
368boolean draw_gs_init( struct draw_context *draw );
369
370void
371draw_gs_set_constants(struct draw_context *,
372                      unsigned slot,
373                      const void *constants,
374                      unsigned size);
375
376void draw_gs_destroy( struct draw_context *draw );
377
378/*******************************************************************************
379 * Common shading code:
380 */
381uint draw_current_shader_outputs(const struct draw_context *draw);
382uint draw_current_shader_position_output(const struct draw_context *draw);
383
384int draw_alloc_extra_vertex_attrib(struct draw_context *draw,
385                                   uint semantic_name, uint semantic_index);
386void draw_remove_extra_vertex_attribs(struct draw_context *draw);
387
388
389/*******************************************************************************
390 * Vertex processing (was passthrough) code:
391 */
392boolean draw_pt_init( struct draw_context *draw );
393void draw_pt_destroy( struct draw_context *draw );
394void draw_pt_reset_vertex_ids( struct draw_context *draw );
395
396
397/*******************************************************************************
398 * Primitive processing (pipeline) code:
399 */
400
401boolean draw_pipeline_init( struct draw_context *draw );
402void draw_pipeline_destroy( struct draw_context *draw );
403
404
405
406
407
408/*
409 * These flags are used by the pipeline when unfilled and/or line stipple modes
410 * are operational.
411 */
412#define DRAW_PIPE_EDGE_FLAG_0   0x1
413#define DRAW_PIPE_EDGE_FLAG_1   0x2
414#define DRAW_PIPE_EDGE_FLAG_2   0x4
415#define DRAW_PIPE_EDGE_FLAG_ALL 0x7
416#define DRAW_PIPE_RESET_STIPPLE 0x8
417
418void draw_pipeline_run( struct draw_context *draw,
419                        const struct draw_vertex_info *vert,
420                        const struct draw_prim_info *prim);
421
422void draw_pipeline_run_linear( struct draw_context *draw,
423                               const struct draw_vertex_info *vert,
424                               const struct draw_prim_info *prim);
425
426
427
428
429void draw_pipeline_flush( struct draw_context *draw,
430                          unsigned flags );
431
432
433
434/*******************************************************************************
435 * Flushing
436 */
437
438#define DRAW_FLUSH_STATE_CHANGE              0x8
439#define DRAW_FLUSH_BACKEND                   0x10
440
441
442void draw_do_flush( struct draw_context *draw, unsigned flags );
443
444
445
446void *
447draw_get_rasterizer_no_cull( struct draw_context *draw,
448                             boolean scissor,
449                             boolean flatshade );
450
451
452#endif /* DRAW_PRIVATE_H */
453