draw_private.h revision 0c31661e73dd2979df22a275452efc71c7064f81 
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_exec.h"
48#include "tgsi/tgsi_scan.h"
49
50
51struct pipe_context;
52struct gallivm_prog;
53struct gallivm_cpu_engine;
54struct draw_vertex_shader;
55struct draw_context;
56struct draw_stage;
57struct vbuf_render;
58
59
60/**
61 * Basic vertex info.
62 * Carry some useful information around with the vertices in the prim pipe.
63 */
64struct vertex_header {
65   unsigned clipmask:12;
66   unsigned edgeflag:1;
67   unsigned pad:3;
68   unsigned vertex_id:16;
69
70   float clip[4];
71
72   /* This will probably become float (*data)[4] soon:
73    */
74   float data[][4];
75};
76
77/* NOTE: It should match vertex_id size above */
78#define UNDEFINED_VERTEX_ID 0xffff
79
80
81/**
82 * Private context for the drawing module.
83 */
84struct draw_context
85{
86   /** Drawing/primitive pipeline stages */
87   struct {
88      struct draw_stage *first;  /**< one of the following */
89
90      struct draw_stage *validate;
91
92      /* stages (in logical order) */
93      struct draw_stage *flatshade;
94      struct draw_stage *clip;
95      struct draw_stage *cull;
96      struct draw_stage *twoside;
97      struct draw_stage *offset;
98      struct draw_stage *unfilled;
99      struct draw_stage *stipple;
100      struct draw_stage *aapoint;
101      struct draw_stage *aaline;
102      struct draw_stage *pstipple;
103      struct draw_stage *wide_line;
104      struct draw_stage *wide_point;
105      struct draw_stage *rasterize;
106
107      float wide_point_threshold; /**< convert pnts to tris if larger than this */
108      float wide_line_threshold;  /**< convert lines to tris if wider than this */
109      boolean line_stipple;       /**< do line stipple? */
110      boolean point_sprite;       /**< convert points to quads for sprites? */
111
112      /* Temporary storage while the pipeline is being run:
113       */
114      char *verts;
115      unsigned vertex_stride;
116      unsigned vertex_count;
117   } pipeline;
118
119
120   struct vbuf_render *render;
121
122   /* Support prototype passthrough path:
123    */
124   struct {
125      struct {
126         struct draw_pt_middle_end *fetch_emit;
127         struct draw_pt_middle_end *fetch_shade_emit;
128         struct draw_pt_middle_end *general;
129      } middle;
130
131      struct {
132         struct draw_pt_front_end *vcache;
133         struct draw_pt_front_end *varray;
134      } front;
135
136      struct pipe_vertex_buffer vertex_buffer[PIPE_MAX_ATTRIBS];
137      unsigned nr_vertex_buffers;
138
139      struct pipe_vertex_element vertex_element[PIPE_MAX_ATTRIBS];
140      unsigned nr_vertex_elements;
141
142      /* user-space vertex data, buffers */
143      struct {
144         const unsigned *edgeflag;
145
146         /** vertex element/index buffer (ex: glDrawElements) */
147         const void *elts;
148         /** bytes per index (0, 1, 2 or 4) */
149         unsigned eltSize;
150         unsigned min_index;
151         unsigned max_index;
152
153         /** vertex arrays */
154         const void *vbuffer[PIPE_MAX_ATTRIBS];
155
156         /** constant buffer (for vertex shader) */
157         const void *constants;
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   double mrd;  /**< minimum resolvable depth value, for polygon offset */
176
177   /* pipe state that we need: */
178   const struct pipe_rasterizer_state *rasterizer;
179   struct pipe_viewport_state viewport;
180   boolean identity_viewport;
181
182   struct {
183      struct draw_vertex_shader *vertex_shader;
184      uint num_vs_outputs;  /**< convenience, from vertex_shader */
185      uint position_output;
186
187      /** TGSI program interpreter runtime state */
188      struct tgsi_exec_machine machine;
189
190      uint num_samplers;
191      struct tgsi_sampler **samplers;
192
193      /* This (and the tgsi_exec_machine struct) probably need to be moved somewhere private.
194       */
195      struct gallivm_cpu_engine *engine;
196
197      /* Here's another one:
198       */
199      struct aos_machine *aos_machine;
200
201
202      const float (*aligned_constants)[4];
203
204      const float (*aligned_constant_storage)[4];
205      unsigned const_storage_size;
206
207
208      struct translate *fetch;
209      struct translate_cache *fetch_cache;
210      struct translate *emit;
211      struct translate_cache *emit_cache;
212   } vs;
213
214   /* Clip derived state:
215    */
216   float plane[12][4];
217   unsigned nr_planes;
218
219   /* If a prim stage introduces new vertex attributes, they'll be stored here
220    */
221   struct {
222      uint semantic_name;
223      uint semantic_index;
224      int slot;
225   } extra_vp_outputs;
226
227   unsigned reduced_prim;
228
229   void *driver_private;
230};
231
232
233/*******************************************************************************
234 * Vertex shader code:
235 */
236boolean draw_vs_init( struct draw_context *draw );
237void draw_vs_destroy( struct draw_context *draw );
238
239void draw_vs_set_viewport( struct draw_context *,
240                           const struct pipe_viewport_state * );
241
242void draw_vs_set_constants( struct draw_context *,
243                            const float (*constants)[4],
244                            unsigned size );
245
246
247
248
249/*******************************************************************************
250 * Vertex processing (was passthrough) code:
251 */
252boolean draw_pt_init( struct draw_context *draw );
253void draw_pt_destroy( struct draw_context *draw );
254void draw_pt_reset_vertex_ids( struct draw_context *draw );
255
256
257/*******************************************************************************
258 * Primitive processing (pipeline) code:
259 */
260
261boolean draw_pipeline_init( struct draw_context *draw );
262void draw_pipeline_destroy( struct draw_context *draw );
263
264
265
266
267
268/* We use the top few bits in the elts[] parameter to convey a little
269 * API information.  This limits the number of vertices we can address
270 * to only 4096 -- if that becomes a problem, we can switch to 32-bit
271 * draw indices.
272 *
273 * These flags expected at first vertex of lines & triangles when
274 * unfilled and/or line stipple modes are operational.
275 */
276#define DRAW_PIPE_MAX_VERTICES  (0x1<<12)
277#define DRAW_PIPE_EDGE_FLAG_0   (0x1<<12)
278#define DRAW_PIPE_EDGE_FLAG_1   (0x2<<12)
279#define DRAW_PIPE_EDGE_FLAG_2   (0x4<<12)
280#define DRAW_PIPE_EDGE_FLAG_ALL (0x7<<12)
281#define DRAW_PIPE_RESET_STIPPLE (0x8<<12)
282#define DRAW_PIPE_FLAG_MASK     (0xf<<12)
283
284void draw_pipeline_run( struct draw_context *draw,
285                        unsigned prim,
286                        struct vertex_header *vertices,
287                        unsigned vertex_count,
288                        unsigned stride,
289                        const ushort *elts,
290                        unsigned count );
291
292void draw_pipeline_run_linear( struct draw_context *draw,
293                               unsigned prim,
294                               struct vertex_header *vertices,
295                               unsigned count,
296                               unsigned stride );
297
298
299
300void draw_pipeline_flush( struct draw_context *draw,
301                          unsigned flags );
302
303
304
305/*******************************************************************************
306 * Flushing
307 */
308
309#define DRAW_FLUSH_STATE_CHANGE              0x8
310#define DRAW_FLUSH_BACKEND                   0x10
311
312
313void draw_do_flush( struct draw_context *draw, unsigned flags );
314
315
316
317
318#endif /* DRAW_PRIVATE_H */
319