draw: added array element debug / bounds checking code (disabled)
[mesa.git] / src / gallium / auxiliary / draw / draw_context.c
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 * Authors:
30 * Keith Whitwell <keith@tungstengraphics.com>
31 */
32
33
34 #include "pipe/p_context.h"
35 #include "util/u_memory.h"
36 #include "util/u_math.h"
37 #include "draw_context.h"
38 #include "draw_vs.h"
39 #include "draw_gs.h"
40
41 #if HAVE_LLVM
42 #include "gallivm/lp_bld_init.h"
43 #include "draw_llvm.h"
44 #endif
45
46 struct draw_context *draw_create( struct pipe_context *pipe )
47 {
48 struct draw_context *draw = CALLOC_STRUCT( draw_context );
49 if (draw == NULL)
50 goto fail;
51
52 #if HAVE_LLVM
53 lp_build_init();
54 assert(lp_build_engine);
55 draw->engine = lp_build_engine;
56 draw->llvm = draw_llvm_create(draw);
57 #endif
58
59 if (!draw_init(draw))
60 goto fail;
61
62 draw->pipe = pipe;
63
64 return draw;
65
66 fail:
67 draw_destroy( draw );
68 return NULL;
69 }
70
71 boolean draw_init(struct draw_context *draw)
72 {
73 /*
74 * Note that several functions compute the clipmask of the predefined
75 * formats with hardcoded formulas instead of using these. So modifications
76 * here must be reflected there too.
77 */
78
79 ASSIGN_4V( draw->plane[0], -1, 0, 0, 1 );
80 ASSIGN_4V( draw->plane[1], 1, 0, 0, 1 );
81 ASSIGN_4V( draw->plane[2], 0, -1, 0, 1 );
82 ASSIGN_4V( draw->plane[3], 0, 1, 0, 1 );
83 ASSIGN_4V( draw->plane[4], 0, 0, 1, 1 ); /* yes these are correct */
84 ASSIGN_4V( draw->plane[5], 0, 0, -1, 1 ); /* mesa's a bit wonky */
85 draw->nr_planes = 6;
86
87
88 draw->reduced_prim = ~0; /* != any of PIPE_PRIM_x */
89
90
91 if (!draw_pipeline_init( draw ))
92 return FALSE;
93
94 if (!draw_pt_init( draw ))
95 return FALSE;
96
97 if (!draw_vs_init( draw ))
98 return FALSE;
99
100 if (!draw_gs_init( draw ))
101 return FALSE;
102
103 return TRUE;
104 }
105
106
107 void draw_destroy( struct draw_context *draw )
108 {
109 struct pipe_context *pipe;
110 int i, j;
111
112 if (!draw)
113 return;
114
115 pipe = draw->pipe;
116
117 /* free any rasterizer CSOs that we may have created.
118 */
119 for (i = 0; i < 2; i++) {
120 for (j = 0; j < 2; j++) {
121 if (draw->rasterizer_no_cull[i][j]) {
122 pipe->delete_rasterizer_state(pipe, draw->rasterizer_no_cull[i][j]);
123 }
124 }
125 }
126
127 /* Not so fast -- we're just borrowing this at the moment.
128 *
129 if (draw->render)
130 draw->render->destroy( draw->render );
131 */
132
133 draw_pipeline_destroy( draw );
134 draw_pt_destroy( draw );
135 draw_vs_destroy( draw );
136 draw_gs_destroy( draw );
137 #ifdef HAVE_LLVM
138 draw_llvm_destroy( draw->llvm );
139 #endif
140
141 FREE( draw );
142 }
143
144
145
146 void draw_flush( struct draw_context *draw )
147 {
148 draw_do_flush( draw, DRAW_FLUSH_BACKEND );
149 }
150
151
152 /**
153 * Specify the Minimum Resolvable Depth factor for polygon offset.
154 * This factor potentially depends on the number of Z buffer bits,
155 * the rasterization algorithm and the arithmetic performed on Z
156 * values between vertex shading and rasterization. It will vary
157 * from one driver to another.
158 */
159 void draw_set_mrd(struct draw_context *draw, double mrd)
160 {
161 draw->mrd = mrd;
162 }
163
164
165 /**
166 * Register new primitive rasterization/rendering state.
167 * This causes the drawing pipeline to be rebuilt.
168 */
169 void draw_set_rasterizer_state( struct draw_context *draw,
170 const struct pipe_rasterizer_state *raster,
171 void *rast_handle )
172 {
173 if (!draw->suspend_flushing) {
174 draw_do_flush( draw, DRAW_FLUSH_STATE_CHANGE );
175
176 draw->rasterizer = raster;
177 draw->rast_handle = rast_handle;
178
179 draw->bypass_clipping = draw->driver.bypass_clipping;
180 }
181 }
182
183
184 void draw_set_driver_clipping( struct draw_context *draw,
185 boolean bypass_clipping )
186 {
187 draw_do_flush( draw, DRAW_FLUSH_STATE_CHANGE );
188
189 draw->driver.bypass_clipping = bypass_clipping;
190 draw->bypass_clipping = draw->driver.bypass_clipping;
191 }
192
193
194 /**
195 * Plug in the primitive rendering/rasterization stage (which is the last
196 * stage in the drawing pipeline).
197 * This is provided by the device driver.
198 */
199 void draw_set_rasterize_stage( struct draw_context *draw,
200 struct draw_stage *stage )
201 {
202 draw_do_flush( draw, DRAW_FLUSH_STATE_CHANGE );
203
204 draw->pipeline.rasterize = stage;
205 }
206
207
208 /**
209 * Set the draw module's clipping state.
210 */
211 void draw_set_clip_state( struct draw_context *draw,
212 const struct pipe_clip_state *clip )
213 {
214 draw_do_flush( draw, DRAW_FLUSH_STATE_CHANGE );
215
216 assert(clip->nr <= PIPE_MAX_CLIP_PLANES);
217 memcpy(&draw->plane[6], clip->ucp, clip->nr * sizeof(clip->ucp[0]));
218 draw->nr_planes = 6 + clip->nr;
219 }
220
221
222 /**
223 * Set the draw module's viewport state.
224 */
225 void draw_set_viewport_state( struct draw_context *draw,
226 const struct pipe_viewport_state *viewport )
227 {
228 draw_do_flush( draw, DRAW_FLUSH_STATE_CHANGE );
229 draw->viewport = *viewport; /* struct copy */
230 draw->identity_viewport = (viewport->scale[0] == 1.0f &&
231 viewport->scale[1] == 1.0f &&
232 viewport->scale[2] == 1.0f &&
233 viewport->scale[3] == 1.0f &&
234 viewport->translate[0] == 0.0f &&
235 viewport->translate[1] == 0.0f &&
236 viewport->translate[2] == 0.0f &&
237 viewport->translate[3] == 0.0f);
238
239 draw_vs_set_viewport( draw, viewport );
240 }
241
242
243
244 void
245 draw_set_vertex_buffers(struct draw_context *draw,
246 unsigned count,
247 const struct pipe_vertex_buffer *buffers)
248 {
249 assert(count <= PIPE_MAX_ATTRIBS);
250
251 memcpy(draw->pt.vertex_buffer, buffers, count * sizeof(buffers[0]));
252 draw->pt.nr_vertex_buffers = count;
253 }
254
255
256 void
257 draw_set_vertex_elements(struct draw_context *draw,
258 unsigned count,
259 const struct pipe_vertex_element *elements)
260 {
261 assert(count <= PIPE_MAX_ATTRIBS);
262
263 memcpy(draw->pt.vertex_element, elements, count * sizeof(elements[0]));
264 draw->pt.nr_vertex_elements = count;
265 }
266
267
268 /**
269 * Tell drawing context where to find mapped vertex buffers.
270 */
271 void
272 draw_set_mapped_vertex_buffer(struct draw_context *draw,
273 unsigned attr, const void *buffer)
274 {
275 draw->pt.user.vbuffer[attr] = buffer;
276 }
277
278
279 void
280 draw_set_mapped_constant_buffer(struct draw_context *draw,
281 unsigned shader_type,
282 unsigned slot,
283 const void *buffer,
284 unsigned size )
285 {
286 debug_assert(shader_type == PIPE_SHADER_VERTEX ||
287 shader_type == PIPE_SHADER_GEOMETRY);
288 debug_assert(slot < PIPE_MAX_CONSTANT_BUFFERS);
289
290 if (shader_type == PIPE_SHADER_VERTEX) {
291 draw->pt.user.vs_constants[slot] = buffer;
292 draw_vs_set_constants(draw, slot, buffer, size);
293 } else if (shader_type == PIPE_SHADER_GEOMETRY) {
294 draw->pt.user.gs_constants[slot] = buffer;
295 draw_gs_set_constants(draw, slot, buffer, size);
296 }
297 }
298
299
300 /**
301 * Tells the draw module to draw points with triangles if their size
302 * is greater than this threshold.
303 */
304 void
305 draw_wide_point_threshold(struct draw_context *draw, float threshold)
306 {
307 draw_do_flush( draw, DRAW_FLUSH_STATE_CHANGE );
308 draw->pipeline.wide_point_threshold = threshold;
309 }
310
311
312 /**
313 * Should the draw module handle point->quad conversion for drawing sprites?
314 */
315 void
316 draw_wide_point_sprites(struct draw_context *draw, boolean draw_sprite)
317 {
318 draw_do_flush( draw, DRAW_FLUSH_STATE_CHANGE );
319 draw->pipeline.wide_point_sprites = draw_sprite;
320 }
321
322
323 /**
324 * Tells the draw module to draw lines with triangles if their width
325 * is greater than this threshold.
326 */
327 void
328 draw_wide_line_threshold(struct draw_context *draw, float threshold)
329 {
330 draw_do_flush( draw, DRAW_FLUSH_STATE_CHANGE );
331 draw->pipeline.wide_line_threshold = threshold;
332 }
333
334
335 /**
336 * Tells the draw module whether or not to implement line stipple.
337 */
338 void
339 draw_enable_line_stipple(struct draw_context *draw, boolean enable)
340 {
341 draw_do_flush( draw, DRAW_FLUSH_STATE_CHANGE );
342 draw->pipeline.line_stipple = enable;
343 }
344
345
346 /**
347 * Tells draw module whether to convert points to quads for sprite mode.
348 */
349 void
350 draw_enable_point_sprites(struct draw_context *draw, boolean enable)
351 {
352 draw_do_flush( draw, DRAW_FLUSH_STATE_CHANGE );
353 draw->pipeline.point_sprite = enable;
354 }
355
356
357 void
358 draw_set_force_passthrough( struct draw_context *draw, boolean enable )
359 {
360 draw_do_flush( draw, DRAW_FLUSH_STATE_CHANGE );
361 draw->force_passthrough = enable;
362 }
363
364
365 /**
366 * Ask the draw module for the location/slot of the given vertex attribute in
367 * a post-transformed vertex.
368 *
369 * With this function, drivers that use the draw module should have no reason
370 * to track the current vertex/geometry shader.
371 *
372 * Note that the draw module may sometimes generate vertices with extra
373 * attributes (such as texcoords for AA lines). The driver can call this
374 * function to find those attributes.
375 *
376 * Zero is returned if the attribute is not found since this is
377 * a don't care / undefined situtation. Returning -1 would be a bit more
378 * work for the drivers.
379 */
380 int
381 draw_find_shader_output(const struct draw_context *draw,
382 uint semantic_name, uint semantic_index)
383 {
384 const struct draw_vertex_shader *vs = draw->vs.vertex_shader;
385 const struct draw_geometry_shader *gs = draw->gs.geometry_shader;
386 uint i;
387 const struct tgsi_shader_info *info = &vs->info;
388
389 if (gs)
390 info = &gs->info;
391
392 for (i = 0; i < info->num_outputs; i++) {
393 if (info->output_semantic_name[i] == semantic_name &&
394 info->output_semantic_index[i] == semantic_index)
395 return i;
396 }
397
398 /* XXX there may be more than one extra vertex attrib.
399 * For example, simulated gl_FragCoord and gl_PointCoord.
400 */
401 if (draw->extra_shader_outputs.semantic_name == semantic_name &&
402 draw->extra_shader_outputs.semantic_index == semantic_index) {
403 return draw->extra_shader_outputs.slot;
404 }
405
406 return 0;
407 }
408
409
410 /**
411 * Return total number of the shader outputs. This function is similar to
412 * draw_current_shader_outputs() but this function also counts any extra
413 * vertex/geometry output attributes that may be filled in by some draw
414 * stages (such as AA point, AA line).
415 *
416 * If geometry shader is present, its output will be returned,
417 * if not vertex shader is used.
418 */
419 uint
420 draw_num_shader_outputs(const struct draw_context *draw)
421 {
422 uint count = draw->vs.vertex_shader->info.num_outputs;
423
424 /* If a geometry shader is present, its outputs go to the
425 * driver, else the vertex shader's outputs.
426 */
427 if (draw->gs.geometry_shader)
428 count = draw->gs.geometry_shader->info.num_outputs;
429
430 if (draw->extra_shader_outputs.slot > 0)
431 count++;
432 return count;
433 }
434
435
436 /**
437 * Provide TGSI sampler objects for vertex/geometry shaders that use
438 * texture fetches.
439 * This might only be used by software drivers for the time being.
440 */
441 void
442 draw_texture_samplers(struct draw_context *draw,
443 uint shader,
444 uint num_samplers,
445 struct tgsi_sampler **samplers)
446 {
447 if (shader == PIPE_SHADER_VERTEX) {
448 draw->vs.num_samplers = num_samplers;
449 draw->vs.samplers = samplers;
450 } else {
451 debug_assert(shader == PIPE_SHADER_GEOMETRY);
452 draw->gs.num_samplers = num_samplers;
453 draw->gs.samplers = samplers;
454 }
455 }
456
457
458
459
460 void draw_set_render( struct draw_context *draw,
461 struct vbuf_render *render )
462 {
463 draw->render = render;
464 }
465
466
467
468 /**
469 * Tell the drawing context about the index/element buffer to use
470 * (ala glDrawElements)
471 * If no element buffer is to be used (i.e. glDrawArrays) then this
472 * should be called with eltSize=0 and elements=NULL.
473 *
474 * \param draw the drawing context
475 * \param eltSize size of each element (1, 2 or 4 bytes)
476 * \param elements the element buffer ptr
477 */
478 void
479 draw_set_mapped_element_buffer_range( struct draw_context *draw,
480 unsigned eltSize,
481 int eltBias,
482 unsigned min_index,
483 unsigned max_index,
484 const void *elements )
485 {
486 draw->pt.user.elts = elements;
487 draw->pt.user.eltSize = eltSize;
488 draw->pt.user.eltBias = eltBias;
489 draw->pt.user.min_index = min_index;
490 draw->pt.user.max_index = max_index;
491 }
492
493
494 void
495 draw_set_mapped_element_buffer( struct draw_context *draw,
496 unsigned eltSize,
497 int eltBias,
498 const void *elements )
499 {
500 draw->pt.user.elts = elements;
501 draw->pt.user.eltSize = eltSize;
502 draw->pt.user.eltBias = eltBias;
503 draw->pt.user.min_index = 0;
504 draw->pt.user.max_index = 0xffffffff;
505 }
506
507
508 /* Revamp me please:
509 */
510 void draw_do_flush( struct draw_context *draw, unsigned flags )
511 {
512 if (!draw->suspend_flushing)
513 {
514 assert(!draw->flushing); /* catch inadvertant recursion */
515
516 draw->flushing = TRUE;
517
518 draw_pipeline_flush( draw, flags );
519
520 draw->reduced_prim = ~0; /* is reduced_prim needed any more? */
521
522 draw->flushing = FALSE;
523 }
524 }
525
526
527 /**
528 * Return the number of output attributes produced by the geometry
529 * shader, if present. If no geometry shader, return the number of
530 * outputs from the vertex shader.
531 * \sa draw_num_shader_outputs
532 */
533 uint
534 draw_current_shader_outputs(const struct draw_context *draw)
535 {
536 if (draw->gs.geometry_shader)
537 return draw->gs.num_gs_outputs;
538 return draw->vs.num_vs_outputs;
539 }
540
541
542 /**
543 * Return the index of the shader output which will contain the
544 * vertex position.
545 */
546 uint
547 draw_current_shader_position_output(const struct draw_context *draw)
548 {
549 if (draw->gs.geometry_shader)
550 return draw->gs.position_output;
551 return draw->vs.position_output;
552 }
553
554
555 /**
556 * Return a pointer/handle for a driver/CSO rasterizer object which
557 * disabled culling, stippling, unfilled tris, etc.
558 * This is used by some pipeline stages (such as wide_point, aa_line
559 * and aa_point) which convert points/lines into triangles. In those
560 * cases we don't want to accidentally cull the triangles.
561 *
562 * \param scissor should the rasterizer state enable scissoring?
563 * \param flatshade should the rasterizer state use flat shading?
564 * \return rasterizer CSO handle
565 */
566 void *
567 draw_get_rasterizer_no_cull( struct draw_context *draw,
568 boolean scissor,
569 boolean flatshade )
570 {
571 if (!draw->rasterizer_no_cull[scissor][flatshade]) {
572 /* create now */
573 struct pipe_context *pipe = draw->pipe;
574 struct pipe_rasterizer_state rast;
575
576 memset(&rast, 0, sizeof(rast));
577 rast.scissor = scissor;
578 rast.flatshade = flatshade;
579 rast.front_ccw = 1;
580 rast.gl_rasterization_rules = draw->rasterizer->gl_rasterization_rules;
581
582 draw->rasterizer_no_cull[scissor][flatshade] =
583 pipe->create_rasterizer_state(pipe, &rast);
584 }
585 return draw->rasterizer_no_cull[scissor][flatshade];
586 }
587
588 void
589 draw_set_mapped_so_buffers(struct draw_context *draw,
590 void *buffers[PIPE_MAX_SO_BUFFERS],
591 unsigned num_buffers)
592 {
593 int i;
594
595 for (i = 0; i < num_buffers; ++i) {
596 draw->so.buffers[i] = buffers[i];
597 }
598 draw->so.num_buffers = num_buffers;
599 }
600
601 void
602 draw_set_so_state(struct draw_context *draw,
603 struct pipe_stream_output_state *state)
604 {
605 memcpy(&draw->so.state,
606 state,
607 sizeof(struct pipe_stream_output_state));
608 }
609
610 void
611 draw_set_sampler_views(struct draw_context *draw,
612 struct pipe_sampler_view **views,
613 unsigned num)
614 {
615 unsigned i;
616
617 debug_assert(num <= PIPE_MAX_VERTEX_SAMPLERS);
618
619 for (i = 0; i < num; ++i)
620 draw->sampler_views[i] = views[i];
621 for (i = num; i < PIPE_MAX_VERTEX_SAMPLERS; ++i)
622 draw->sampler_views[i] = NULL;
623
624 draw->num_sampler_views = num;
625 }
626
627 void
628 draw_set_samplers(struct draw_context *draw,
629 struct pipe_sampler_state **samplers,
630 unsigned num)
631 {
632 unsigned i;
633
634 debug_assert(num <= PIPE_MAX_VERTEX_SAMPLERS);
635
636 for (i = 0; i < num; ++i)
637 draw->samplers[i] = samplers[i];
638 for (i = num; i < PIPE_MAX_VERTEX_SAMPLERS; ++i)
639 draw->samplers[i] = NULL;
640
641 draw->num_samplers = num;
642 }
643
644 void
645 draw_set_mapped_texture(struct draw_context *draw,
646 unsigned sampler_idx,
647 uint32_t width, uint32_t height, uint32_t depth,
648 uint32_t last_level,
649 uint32_t row_stride[DRAW_MAX_TEXTURE_LEVELS],
650 uint32_t img_stride[DRAW_MAX_TEXTURE_LEVELS],
651 const void *data[DRAW_MAX_TEXTURE_LEVELS])
652 {
653 #ifdef HAVE_LLVM
654 draw_llvm_set_mapped_texture(draw,
655 sampler_idx,
656 width, height, depth, last_level,
657 row_stride, img_stride, data);
658 #endif
659 }