draw_vbuf.h revision 395edbc5151b2ce9dd77a22d104ce886e9326354 
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 * \file
30 * Vertex buffer drawing stage.
31 *
32 * \author Keith Whitwell <keith@tungstengraphics.com>
33 * \author Jose Fonseca <jrfonsec@tungstengraphics.com>
34 */
35
36#ifndef DRAW_VBUF_H_
37#define DRAW_VBUF_H_
38
39
40
41struct pipe_rasterizer_state;
42struct draw_context;
43struct vertex_info;
44
45
46/**
47 * Interface for hardware vertex buffer rendering.
48 */
49struct vbuf_render {
50
51   /**
52    * Driver limits.  May be tuned lower to improve cache hits on
53    * index list.
54    */
55   unsigned max_indices;
56   unsigned max_vertex_buffer_bytes;
57
58   /**
59    * Query if the hardware driver needs assistance for a particular
60    * combination of rasterizer state and primitive.
61    *
62    * Currently optional.
63    */
64   boolean (*need_pipeline)(const struct vbuf_render *render,
65                            const struct pipe_rasterizer_state *rasterizer,
66                            unsigned int prim );
67
68
69   /**
70    * Get the hardware vertex format.
71    *
72    * XXX: have this in draw_context instead?
73    */
74   const struct vertex_info *(*get_vertex_info)( struct vbuf_render * );
75
76   /**
77    * Request a destination for vertices.
78    * Hardware renderers will use ttm memory, others will just malloc
79    * something.
80    */
81   void *(*allocate_vertices)( struct vbuf_render *,
82			       ushort vertex_size,
83			       ushort nr_vertices );
84
85   /**
86    * Notify the renderer of the current primitive when it changes.
87    * Must succeed for TRIANGLES, LINES and POINTS.  Other prims at
88    * the discretion of the driver, for the benefit of the passthrough
89    * path.
90    */
91   boolean (*set_primitive)( struct vbuf_render *, unsigned prim );
92
93   /**
94    * DrawElements, note indices are ushort.  The driver must complete
95    * this call, if necessary splitting the index list itself.
96    */
97   void (*draw)( struct vbuf_render *,
98		 const ushort *indices,
99		 uint nr_indices );
100
101   /* Draw Arrays path too.
102    */
103   void (*draw_arrays)( struct vbuf_render *,
104			unsigned start,
105			uint nr );
106
107   /**
108    * Called when vbuf is done with this set of vertices:
109    */
110   void (*release_vertices)( struct vbuf_render *,
111			     void *vertices,
112			     unsigned vertex_size,
113			     unsigned vertices_used );
114
115   void (*destroy)( struct vbuf_render * );
116};
117
118
119
120struct draw_stage *
121draw_vbuf_stage( struct draw_context *draw,
122                 struct vbuf_render *render );
123
124
125#endif /*DRAW_VBUF_H_*/
126