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"
50 #include <llvm-c/ExecutionEngine.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
;
70 * Carry some useful information around with the vertices in the prim pipe.
72 struct vertex_header
{
73 unsigned clipmask
:DRAW_TOTAL_CLIP_PLANES
;
76 unsigned vertex_id
:16;
80 /* This will probably become float (*data)[4] soon:
85 /* NOTE: It should match vertex_id size above */
86 #define UNDEFINED_VERTEX_ID 0xffff
89 /* maximum number of shader variants we can cache */
90 #define DRAW_MAX_SHADER_VARIANTS 128
93 * Private context for the drawing module.
97 struct pipe_context
*pipe
;
99 /** Drawing/primitive pipeline stages */
101 struct draw_stage
*first
; /**< one of the following */
103 struct draw_stage
*validate
;
105 /* stages (in logical order) */
106 struct draw_stage
*flatshade
;
107 struct draw_stage
*clip
;
108 struct draw_stage
*cull
;
109 struct draw_stage
*twoside
;
110 struct draw_stage
*offset
;
111 struct draw_stage
*unfilled
;
112 struct draw_stage
*stipple
;
113 struct draw_stage
*aapoint
;
114 struct draw_stage
*aaline
;
115 struct draw_stage
*pstipple
;
116 struct draw_stage
*wide_line
;
117 struct draw_stage
*wide_point
;
118 struct draw_stage
*rasterize
;
120 float wide_point_threshold
; /**< convert pnts to tris if larger than this */
121 float wide_line_threshold
; /**< convert lines to tris if wider than this */
122 boolean wide_point_sprites
; /**< convert points to tris for sprite mode */
123 boolean line_stipple
; /**< do line stipple? */
124 boolean point_sprite
; /**< convert points to quads for sprites? */
126 /* Temporary storage while the pipeline is being run:
129 unsigned vertex_stride
;
130 unsigned vertex_count
;
134 struct vbuf_render
*render
;
136 /* Support prototype passthrough path:
140 struct draw_pt_middle_end
*fetch_emit
;
141 struct draw_pt_middle_end
*fetch_shade_emit
;
142 struct draw_pt_middle_end
*general
;
143 struct draw_pt_middle_end
*llvm
;
147 struct draw_pt_front_end
*vsplit
;
150 struct pipe_vertex_buffer vertex_buffer
[PIPE_MAX_ATTRIBS
];
151 unsigned nr_vertex_buffers
;
154 * This is the largest legal index value for the current set of
155 * bound vertex buffers. Regardless of any other consideration,
156 * all vertex lookups need to be clamped to 0..max_index to
157 * prevent out-of-bound access.
161 struct pipe_vertex_element vertex_element
[PIPE_MAX_ATTRIBS
];
162 unsigned nr_vertex_elements
;
164 struct pipe_index_buffer index_buffer
;
166 /* user-space vertex data, buffers */
168 /** vertex element/index buffer (ex: glDrawElements) */
170 /** bytes per index (0, 1, 2 or 4) */
177 const void *vbuffer
[PIPE_MAX_ATTRIBS
];
179 /** constant buffers (for vertex/geometry shader) */
180 const void *vs_constants
[PIPE_MAX_CONSTANT_BUFFERS
];
181 unsigned vs_constants_size
[PIPE_MAX_CONSTANT_BUFFERS
];
182 const void *gs_constants
[PIPE_MAX_CONSTANT_BUFFERS
];
183 unsigned gs_constants_size
[PIPE_MAX_CONSTANT_BUFFERS
];
185 /* pointer to planes */
186 float (*planes
)[DRAW_TOTAL_CLIP_PLANES
][4];
189 boolean test_fse
; /* enable FSE even though its not correct (eg for softpipe) */
190 boolean no_fse
; /* disable FSE even when it is correct */
194 boolean bypass_clip_xy
;
195 boolean bypass_clip_z
;
196 boolean guard_band_xy
;
199 boolean flushing
; /**< debugging/sanity */
200 boolean suspend_flushing
; /**< internally set */
202 /* Flags set if API requires clipping in these planes and the
203 * driver doesn't indicate that it can do it for us.
208 boolean guard_band_xy
;
210 boolean force_passthrough
; /**< never clip or shade */
214 double mrd
; /**< minimum resolvable depth value, for polygon offset */
216 /** Current rasterizer state given to us by the driver */
217 const struct pipe_rasterizer_state
*rasterizer
;
218 /** Driver CSO handle for the current rasterizer state */
221 /** Rasterizer CSOs without culling/stipple/etc */
222 void *rasterizer_no_cull
[2][2];
224 struct pipe_viewport_state viewport
;
225 boolean identity_viewport
;
227 /** Vertex shader state */
229 struct draw_vertex_shader
*vertex_shader
;
230 uint num_vs_outputs
; /**< convenience, from vertex_shader */
231 uint position_output
;
232 uint edgeflag_output
;
234 /** TGSI program interpreter runtime state */
235 struct tgsi_exec_machine
*machine
;
238 struct tgsi_sampler
**samplers
;
241 const void *aligned_constants
[PIPE_MAX_CONSTANT_BUFFERS
];
243 const void *aligned_constant_storage
[PIPE_MAX_CONSTANT_BUFFERS
];
244 unsigned const_storage_size
[PIPE_MAX_CONSTANT_BUFFERS
];
247 struct translate
*fetch
;
248 struct translate_cache
*fetch_cache
;
249 struct translate
*emit
;
250 struct translate_cache
*emit_cache
;
253 /** Geometry shader state */
255 struct draw_geometry_shader
*geometry_shader
;
256 uint num_gs_outputs
; /**< convenience, from geometry_shader */
257 uint position_output
;
259 /** TGSI program interpreter runtime state */
260 struct tgsi_exec_machine
*machine
;
263 struct tgsi_sampler
**samplers
;
266 /** Fragment shader state */
268 struct draw_fragment_shader
*fragment_shader
;
271 /** Stream output (vertex feedback) state */
273 struct pipe_stream_output_info state
;
274 void *buffers
[PIPE_MAX_SO_BUFFERS
];
278 /* Clip derived state:
280 float plane
[DRAW_TOTAL_CLIP_PLANES
][4];
284 /* If a prim stage introduces new vertex attributes, they'll be stored here
288 uint semantic_name
[10];
289 uint semantic_index
[10];
291 } extra_shader_outputs
;
293 unsigned reduced_prim
;
295 unsigned instance_id
;
298 struct draw_llvm
*llvm
;
299 struct gallivm_state
*own_gallivm
;
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
;
307 void *driver_private
;
311 struct draw_fetch_info
{
314 const unsigned *elts
;
318 struct draw_vertex_info
{
319 struct vertex_header
*verts
;
320 unsigned vertex_size
;
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
329 struct draw_prim_info
{
338 unsigned *primitive_lengths
;
339 unsigned primitive_count
;
343 /*******************************************************************************
344 * Draw common initialization code
346 boolean
draw_init(struct draw_context
*draw
);
348 /*******************************************************************************
349 * Vertex shader code:
351 boolean
draw_vs_init( struct draw_context
*draw
);
352 void draw_vs_destroy( struct draw_context
*draw
);
354 void draw_vs_set_viewport( struct draw_context
*,
355 const struct pipe_viewport_state
* );
358 draw_vs_set_constants(struct draw_context
*,
360 const void *constants
,
365 /*******************************************************************************
366 * Geometry shading code:
368 boolean
draw_gs_init( struct draw_context
*draw
);
371 draw_gs_set_constants(struct draw_context
*,
373 const void *constants
,
376 void draw_gs_destroy( struct draw_context
*draw
);
378 /*******************************************************************************
379 * Common shading code:
381 uint
draw_current_shader_outputs(const struct draw_context
*draw
);
382 uint
draw_current_shader_position_output(const struct draw_context
*draw
);
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
);
397 /*******************************************************************************
398 * Primitive processing (pipeline) code:
401 boolean
draw_pipeline_init( struct draw_context
*draw
);
402 void draw_pipeline_destroy( struct draw_context
*draw
);
409 * These flags are used by the pipeline when unfilled and/or line stipple modes
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
418 void draw_pipeline_run( struct draw_context
*draw
,
419 const struct draw_vertex_info
*vert
,
420 const struct draw_prim_info
*prim
);
422 void draw_pipeline_run_linear( struct draw_context
*draw
,
423 const struct draw_vertex_info
*vert
,
424 const struct draw_prim_info
*prim
);
429 void draw_pipeline_flush( struct draw_context
*draw
,
434 /*******************************************************************************
438 #define DRAW_FLUSH_STATE_CHANGE 0x8
439 #define DRAW_FLUSH_BACKEND 0x10
442 void draw_do_flush( struct draw_context
*draw
, unsigned flags
);
447 draw_get_rasterizer_no_cull( struct draw_context
*draw
,
452 #endif /* DRAW_PRIVATE_H */