1 /**************************************************************************
3 * Copyright 2007 Tungsten Graphics, Inc., Cedar Park, Texas.
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:
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial portions
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.
26 **************************************************************************/
29 * Private data structures, etc for the draw module.
35 * Keith Whitwell <keith@tungstengraphics.com>
40 #ifndef DRAW_PRIVATE_H
41 #define DRAW_PRIVATE_H
44 #include "pipe/p_state.h"
45 #include "pipe/p_defines.h"
47 #include "tgsi/tgsi_scan.h"
55 /** Sum of frustum planes and user-defined planes */
56 #define DRAW_TOTAL_CLIP_PLANES (6 + PIPE_MAX_CLIP_PLANES)
60 struct draw_vertex_shader
;
64 struct tgsi_exec_machine
;
66 struct draw_pt_front_end
;
71 * Carry some useful information around with the vertices in the prim pipe.
73 struct vertex_header
{
74 unsigned clipmask
:DRAW_TOTAL_CLIP_PLANES
;
76 unsigned have_clipdist
:1;
77 unsigned vertex_id
:16;
80 float pre_clip_pos
[4];
82 /* This will probably become float (*data)[4] soon:
87 /* NOTE: It should match vertex_id size above */
88 #define UNDEFINED_VERTEX_ID 0xffff
91 /* maximum number of shader variants we can cache */
92 #define DRAW_MAX_SHADER_VARIANTS 128
95 * Private context for the drawing module.
99 struct pipe_context
*pipe
;
101 /** Drawing/primitive pipeline stages */
103 struct draw_stage
*first
; /**< one of the following */
105 struct draw_stage
*validate
;
107 /* stages (in logical order) */
108 struct draw_stage
*flatshade
;
109 struct draw_stage
*clip
;
110 struct draw_stage
*cull
;
111 struct draw_stage
*twoside
;
112 struct draw_stage
*offset
;
113 struct draw_stage
*unfilled
;
114 struct draw_stage
*stipple
;
115 struct draw_stage
*aapoint
;
116 struct draw_stage
*aaline
;
117 struct draw_stage
*pstipple
;
118 struct draw_stage
*wide_line
;
119 struct draw_stage
*wide_point
;
120 struct draw_stage
*rasterize
;
122 float wide_point_threshold
; /**< convert pnts to tris if larger than this */
123 float wide_line_threshold
; /**< convert lines to tris if wider than this */
124 boolean wide_point_sprites
; /**< convert points to tris for sprite mode */
125 boolean line_stipple
; /**< do line stipple? */
126 boolean point_sprite
; /**< convert points to quads for sprites? */
128 /* Temporary storage while the pipeline is being run:
131 unsigned vertex_stride
;
132 unsigned vertex_count
;
136 struct vbuf_render
*render
;
138 /* Support prototype passthrough path:
141 /* Current active frontend */
142 struct draw_pt_front_end
*frontend
;
144 unsigned opt
; /**< bitmask of PT_x flags */
145 unsigned eltSize
; /* saved eltSize for flushing */
147 boolean rebind_parameters
;
150 struct draw_pt_middle_end
*fetch_emit
;
151 struct draw_pt_middle_end
*fetch_shade_emit
;
152 struct draw_pt_middle_end
*general
;
153 struct draw_pt_middle_end
*llvm
;
157 struct draw_pt_front_end
*vsplit
;
160 struct pipe_vertex_buffer vertex_buffer
[PIPE_MAX_ATTRIBS
];
161 unsigned nr_vertex_buffers
;
164 * This is the largest legal index value for the current set of
165 * bound vertex buffers. Regardless of any other consideration,
166 * all vertex lookups need to be clamped to 0..max_index to
167 * prevent out-of-bound access.
171 struct pipe_vertex_element vertex_element
[PIPE_MAX_ATTRIBS
];
172 unsigned nr_vertex_elements
;
174 /* user-space vertex data, buffers */
176 /** vertex element/index buffer (ex: glDrawElements) */
178 /** bytes per index (0, 1, 2 or 4) */
186 const void *vbuffer
[PIPE_MAX_ATTRIBS
];
188 /** constant buffers (for vertex/geometry shader) */
189 const void *vs_constants
[PIPE_MAX_CONSTANT_BUFFERS
];
190 unsigned vs_constants_size
[PIPE_MAX_CONSTANT_BUFFERS
];
191 const void *gs_constants
[PIPE_MAX_CONSTANT_BUFFERS
];
192 unsigned gs_constants_size
[PIPE_MAX_CONSTANT_BUFFERS
];
194 /* pointer to planes */
195 float (*planes
)[DRAW_TOTAL_CLIP_PLANES
][4];
198 boolean test_fse
; /* enable FSE even though its not correct (eg for softpipe) */
199 boolean no_fse
; /* disable FSE even when it is correct */
203 boolean bypass_clip_xy
;
204 boolean bypass_clip_z
;
205 boolean guard_band_xy
;
208 boolean quads_always_flatshade_last
;
210 boolean flushing
; /**< debugging/sanity */
211 boolean suspend_flushing
; /**< internally set */
213 /* Flags set if API requires clipping in these planes and the
214 * driver doesn't indicate that it can do it for us.
219 boolean guard_band_xy
;
221 boolean force_passthrough
; /**< never clip or shade */
225 double mrd
; /**< minimum resolvable depth value, for polygon offset */
227 /** Current rasterizer state given to us by the driver */
228 const struct pipe_rasterizer_state
*rasterizer
;
229 /** Driver CSO handle for the current rasterizer state */
232 /** Rasterizer CSOs without culling/stipple/etc */
233 void *rasterizer_no_cull
[2][2];
235 struct pipe_viewport_state viewport
;
236 boolean identity_viewport
;
238 /** Vertex shader state */
240 struct draw_vertex_shader
*vertex_shader
;
241 uint num_vs_outputs
; /**< convenience, from vertex_shader */
242 uint position_output
;
243 uint edgeflag_output
;
244 uint clipvertex_output
;
245 uint clipdistance_output
[2];
247 /** Fields for TGSI interpreter / execution */
249 struct tgsi_exec_machine
*machine
;
251 struct tgsi_sampler
*sampler
;
254 struct translate
*fetch
;
255 struct translate_cache
*fetch_cache
;
256 struct translate
*emit
;
257 struct translate_cache
*emit_cache
;
260 /** Geometry shader state */
262 struct draw_geometry_shader
*geometry_shader
;
263 uint num_gs_outputs
; /**< convenience, from geometry_shader */
264 uint position_output
;
266 /** Fields for TGSI interpreter / execution */
268 struct tgsi_exec_machine
*machine
;
270 struct tgsi_sampler
*sampler
;
275 /** Fragment shader state */
277 struct draw_fragment_shader
*fragment_shader
;
280 /** Stream output (vertex feedback) state */
282 struct draw_so_target
*targets
[PIPE_MAX_SO_BUFFERS
];
286 /* Clip derived state:
288 float plane
[DRAW_TOTAL_CLIP_PLANES
][4];
290 /* If a prim stage introduces new vertex attributes, they'll be stored here
294 uint semantic_name
[10];
295 uint semantic_index
[10];
297 } extra_shader_outputs
;
299 unsigned instance_id
;
302 struct draw_llvm
*llvm
;
305 /** Texture sampler and sampler view state.
306 * Note that we have arrays indexed by shader type. At this time
307 * we only handle vertex and geometry shaders in the draw module, but
308 * there may be more in the future (ex: hull and tessellation).
310 struct pipe_sampler_view
*sampler_views
[PIPE_SHADER_TYPES
][PIPE_MAX_SHADER_SAMPLER_VIEWS
];
311 unsigned num_sampler_views
[PIPE_SHADER_TYPES
];
312 const struct pipe_sampler_state
*samplers
[PIPE_SHADER_TYPES
][PIPE_MAX_SAMPLERS
];
313 unsigned num_samplers
[PIPE_SHADER_TYPES
];
315 struct pipe_query_data_pipeline_statistics statistics
;
316 boolean collect_statistics
;
318 void *driver_private
;
322 struct draw_fetch_info
{
325 const unsigned *elts
;
329 struct draw_vertex_info
{
330 struct vertex_header
*verts
;
331 unsigned vertex_size
;
336 /* these flags are set if the primitive is a segment of a larger one */
337 #define DRAW_SPLIT_BEFORE 0x1
338 #define DRAW_SPLIT_AFTER 0x2
340 struct draw_prim_info
{
349 unsigned *primitive_lengths
;
350 unsigned primitive_count
;
354 /*******************************************************************************
355 * Draw common initialization code
357 boolean
draw_init(struct draw_context
*draw
);
359 /*******************************************************************************
360 * Vertex shader code:
362 boolean
draw_vs_init( struct draw_context
*draw
);
363 void draw_vs_destroy( struct draw_context
*draw
);
365 void draw_vs_set_viewport( struct draw_context
*,
366 const struct pipe_viewport_state
* );
369 /*******************************************************************************
370 * Geometry shading code:
372 boolean
draw_gs_init( struct draw_context
*draw
);
375 void draw_gs_destroy( struct draw_context
*draw
);
377 /*******************************************************************************
378 * Common shading code:
380 uint
draw_current_shader_outputs(const struct draw_context
*draw
);
381 uint
draw_current_shader_position_output(const struct draw_context
*draw
);
382 uint
draw_current_shader_clipvertex_output(const struct draw_context
*draw
);
383 uint
draw_current_shader_clipdistance_output(const struct draw_context
*draw
, int index
);
384 int draw_alloc_extra_vertex_attrib(struct draw_context
*draw
,
385 uint semantic_name
, uint semantic_index
);
386 void draw_remove_extra_vertex_attribs(struct draw_context
*draw
);
389 /*******************************************************************************
390 * Vertex processing (was passthrough) code:
392 boolean
draw_pt_init( struct draw_context
*draw
);
393 void draw_pt_destroy( struct draw_context
*draw
);
394 void draw_pt_reset_vertex_ids( struct draw_context
*draw
);
395 void draw_pt_flush( struct draw_context
*draw
, unsigned flags
);
398 /*******************************************************************************
399 * Primitive processing (pipeline) code:
402 boolean
draw_pipeline_init( struct draw_context
*draw
);
403 void draw_pipeline_destroy( struct draw_context
*draw
);
410 * These flags are used by the pipeline when unfilled and/or line stipple modes
413 #define DRAW_PIPE_EDGE_FLAG_0 0x1
414 #define DRAW_PIPE_EDGE_FLAG_1 0x2
415 #define DRAW_PIPE_EDGE_FLAG_2 0x4
416 #define DRAW_PIPE_EDGE_FLAG_ALL 0x7
417 #define DRAW_PIPE_RESET_STIPPLE 0x8
419 void draw_pipeline_run( struct draw_context
*draw
,
420 const struct draw_vertex_info
*vert
,
421 const struct draw_prim_info
*prim
);
423 void draw_pipeline_run_linear( struct draw_context
*draw
,
424 const struct draw_vertex_info
*vert
,
425 const struct draw_prim_info
*prim
);
430 void draw_pipeline_flush( struct draw_context
*draw
,
435 /*******************************************************************************
439 #define DRAW_FLUSH_PARAMETER_CHANGE 0x1 /**< Constants, viewport, etc */
440 #define DRAW_FLUSH_STATE_CHANGE 0x2 /**< Other/heavy state changes */
441 #define DRAW_FLUSH_BACKEND 0x4 /**< Flush the output buffer */
444 void draw_do_flush( struct draw_context
*draw
, unsigned flags
);
449 draw_get_rasterizer_no_cull( struct draw_context
*draw
,
454 #endif /* DRAW_PRIVATE_H */