1 /**************************************************************************
2  *
3  * Copyright 2007 VMware, Inc.
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 VMWARE 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 <keithw@vmware.com>
33  * \author Jose Fonseca <jfonseca@vmware.com>
34  */
35 
36 #ifndef DRAW_VBUF_H_
37 #define DRAW_VBUF_H_
38 
39 
40 #include "pipe/p_compiler.h"
41 #include "pipe/p_defines.h"
42 
43 
44 struct pipe_rasterizer_state;
45 struct draw_context;
46 struct vertex_info;
47 struct pipe_query_data_pipeline_statistics;
48 
49 
50 /**
51  * Interface for hardware vertex buffer rendering.
52  */
53 struct vbuf_render {
54 
55    /**
56     * Driver limits.  May be tuned lower to improve cache hits on
57     * index list.
58     */
59    unsigned max_indices;
60    unsigned max_vertex_buffer_bytes;
61 
62    /**
63     * Query if the hardware driver needs assistance for a particular
64     * combination of rasterizer state and primitive.
65     *
66     * Currently optional.
67     */
68    boolean (*need_pipeline)(const struct vbuf_render *render,
69                             const struct pipe_rasterizer_state *rasterizer,
70                             unsigned int prim );
71 
72 
73    /**
74     * Get the hardware vertex format.
75     *
76     * XXX: have this in draw_context instead?
77     */
78    const struct vertex_info *(*get_vertex_info)( struct vbuf_render * );
79 
80    /**
81     * Request a destination for vertices.
82     * Hardware renderers will use ttm memory, others will just malloc
83     * something.
84     */
85    boolean (*allocate_vertices)( struct vbuf_render *,
86                                  ushort vertex_size,
87                                  ushort nr_vertices );
88 
89    void *(*map_vertices)( struct vbuf_render * );
90    void (*unmap_vertices)( struct vbuf_render *,
91                            ushort min_index,
92                            ushort max_index );
93 
94    /**
95     * Notify the renderer of the current primitive when it changes.
96     * Must succeed for TRIANGLES, LINES and POINTS.  Other prims at
97     * the discretion of the driver, for the benefit of the passthrough
98     * path.
99     */
100    void (*set_primitive)( struct vbuf_render *, enum pipe_prim_type prim );
101 
102    /**
103     * Notify the renderer of the current view index.
104     */
105    void (*set_view_index)( struct vbuf_render *, unsigned view_index );
106 
107    /**
108     * Draw indexed primitives.  Note that indices are ushort.  The driver
109     * must complete this call, if necessary splitting the index list itself.
110     */
111    void (*draw_elements)( struct vbuf_render *,
112                           const ushort *indices,
113                           uint nr_indices );
114 
115    /* Draw non-indexed primitives.
116     */
117    void (*draw_arrays)( struct vbuf_render *,
118 			unsigned start,
119 			uint nr );
120 
121    /**
122     * Called when vbuf is done with this set of vertices:
123     */
124    void (*release_vertices)( struct vbuf_render * );
125 
126    void (*destroy)( struct vbuf_render * );
127 
128 
129    /**
130     * Called after writing data to the stream out buffers
131     */
132    void (*set_stream_output_info)( struct vbuf_render *vbufr,
133                                    unsigned stream,
134                                    unsigned primitive_count,
135                                    unsigned primitive_generated );
136 
137    /**
138     * Called after all relevant statistics have been accumulated.
139     */
140    void (*pipeline_statistics)(
141       struct vbuf_render *vbufr,
142       const struct pipe_query_data_pipeline_statistics *stats );
143 };
144 
145 
146 
147 struct draw_stage *
148 draw_vbuf_stage( struct draw_context *draw,
149                  struct vbuf_render *render );
150 
151 
152 #endif /*DRAW_VBUF_H_*/
153