1 /**************************************************************************
2
3 Copyright 2002 VMware, Inc.
4
5 All Rights Reserved.
6
7 Permission is hereby granted, free of charge, to any person obtaining a
8 copy of this software and associated documentation files (the "Software"),
9 to deal in the Software without restriction, including without limitation
10 on the rights to use, copy, modify, merge, publish, distribute, sub
11 license, and/or sell copies of the Software, and to permit persons to whom
12 the Software is furnished to do so, subject to the following conditions:
13
14 The above copyright notice and this permission notice (including the next
15 paragraph) shall be included in all copies or substantial portions of the
16 Software.
17
18 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
21 VMWARE AND/OR THEIR SUPPLIERS BE LIABLE FOR ANY CLAIM,
22 DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
23 OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
24 USE OR OTHER DEALINGS IN THE SOFTWARE.
25
26 **************************************************************************/
27
28 /*
29 * Authors:
30 * Keith Whitwell <keithw@vmware.com>
31 *
32 */
33
34 #ifndef VBO_SAVE_H
35 #define VBO_SAVE_H
36
37 #include "main/mtypes.h"
38 #include "vbo.h"
39 #include "vbo_attrib.h"
40
41
42 struct vbo_save_copied_vtx {
43 fi_type buffer[VBO_ATTRIB_MAX * 4 * VBO_MAX_COPIED_VERTS];
44 GLuint nr;
45 };
46
47
48 /* For display lists, this structure holds a run of vertices of the
49 * same format, and a strictly well-formed set of begin/end pairs,
50 * starting on the first vertex and ending at the last. Vertex
51 * copying on buffer breaks is precomputed according to these
52 * primitives, though there are situations where the copying will need
53 * correction at execute-time, perhaps by replaying the list as
54 * immediate mode commands.
55 *
56 * On executing this list, the 'current' values may be updated with
57 * the values of the final vertex, and often no fixup of the start of
58 * the vertex list is required.
59 *
60 * Eval and other commands that don't fit into these vertex lists are
61 * compiled using the fallback opcode mechanism provided by dlist.c.
62 */
63 struct vbo_save_vertex_list {
64 GLbitfield64 enabled; /**< mask of enabled vbo arrays. */
65 GLubyte attrsz[VBO_ATTRIB_MAX];
66 GLenum attrtype[VBO_ATTRIB_MAX];
67 GLuint vertex_size; /**< size in GLfloats */
68
69 /* Copy of the final vertex from node->vertex_store->bufferobj.
70 * Keep this in regular (non-VBO) memory to avoid repeated
71 * map/unmap of the VBO when updating GL current data.
72 */
73 fi_type *current_data;
74 GLuint current_size;
75
76 GLuint buffer_offset; /**< in bytes */
77 GLuint start_vertex; /**< first vertex used by any primitive */
78 GLuint vertex_count; /**< number of vertices in this list */
79 GLuint wrap_count; /* number of copied vertices at start */
80 GLboolean dangling_attr_ref; /* current attr implicitly referenced
81 outside the list */
82
83 struct _mesa_prim *prims;
84 GLuint prim_count;
85
86 struct vbo_save_vertex_store *vertex_store;
87 struct vbo_save_primitive_store *prim_store;
88 };
89
90
91 /**
92 * Is the vertex lists's buffer offset an exact multiple of the
93 * vertex size (in bytes)? This is used to check for a vertex array /
94 * drawing optimization.
95 */
96 static inline bool
aligned_vertex_buffer_offset(const struct vbo_save_vertex_list * node)97 aligned_vertex_buffer_offset(const struct vbo_save_vertex_list *node)
98 {
99 unsigned vertex_size = node->vertex_size * sizeof(GLfloat); /* in bytes */
100 return vertex_size != 0 && node->buffer_offset % vertex_size == 0;
101 }
102
103
104 /* These buffers should be a reasonable size to support upload to
105 * hardware. Current vbo implementation will re-upload on any
106 * changes, so don't make too big or apps which dynamically create
107 * dlists and use only a few times will suffer.
108 *
109 * Consider stategy of uploading regions from the VBO on demand in the
110 * case of dynamic vbos. Then make the dlist code signal that
111 * likelyhood as it occurs. No reason we couldn't change usage
112 * internally even though this probably isn't allowed for client VBOs?
113 */
114 #define VBO_SAVE_BUFFER_SIZE (256*1024) /* dwords */
115 #define VBO_SAVE_PRIM_SIZE 128
116 #define VBO_SAVE_PRIM_MODE_MASK 0x3f
117 #define VBO_SAVE_PRIM_WEAK 0x40
118 #define VBO_SAVE_PRIM_NO_CURRENT_UPDATE 0x80
119
120 #define VBO_SAVE_FALLBACK 0x10000000
121
122 /* Storage to be shared among several vertex_lists.
123 */
124 struct vbo_save_vertex_store {
125 struct gl_buffer_object *bufferobj;
126 fi_type *buffer_map;
127 GLuint used;
128 GLuint refcount;
129 };
130
131 struct vbo_save_primitive_store {
132 struct _mesa_prim prims[VBO_SAVE_PRIM_SIZE];
133 GLuint used;
134 GLuint refcount;
135 };
136
137
138 struct vbo_save_context {
139 struct gl_context *ctx;
140 GLvertexformat vtxfmt;
141 GLvertexformat vtxfmt_noop; /**< Used if out_of_memory is true */
142 struct gl_vertex_array arrays[VBO_ATTRIB_MAX];
143 const struct gl_vertex_array *inputs[VBO_ATTRIB_MAX];
144
145 GLbitfield64 enabled; /**< mask of enabled vbo arrays. */
146 GLubyte attrsz[VBO_ATTRIB_MAX]; /**< 1, 2, 3 or 4 */
147 GLenum attrtype[VBO_ATTRIB_MAX]; /**< GL_FLOAT, GL_INT, etc */
148 GLubyte active_sz[VBO_ATTRIB_MAX]; /**< 1, 2, 3 or 4 */
149 GLuint vertex_size; /**< size in GLfloats */
150
151 GLboolean out_of_memory; /**< True if last VBO allocation failed */
152
153 GLuint wrap_count;
154 GLbitfield replay_flags;
155
156 struct _mesa_prim *prims;
157 GLuint prim_count, prim_max;
158
159 struct vbo_save_vertex_store *vertex_store;
160 struct vbo_save_primitive_store *prim_store;
161
162 fi_type *buffer_map; /**< Mapping of vertex_store's buffer */
163 fi_type *buffer_ptr; /**< cursor, points into buffer_map */
164 fi_type vertex[VBO_ATTRIB_MAX*4]; /* current values */
165 fi_type *attrptr[VBO_ATTRIB_MAX];
166 GLuint vert_count;
167 GLuint max_vert;
168 GLboolean dangling_attr_ref;
169
170 GLuint opcode_vertex_list;
171
172 struct vbo_save_copied_vtx copied;
173
174 fi_type *current[VBO_ATTRIB_MAX]; /* points into ctx->ListState */
175 GLubyte *currentsz[VBO_ATTRIB_MAX];
176 };
177
178 void vbo_save_init(struct gl_context *ctx);
179 void vbo_save_destroy(struct gl_context *ctx);
180 void vbo_save_fallback(struct gl_context *ctx, GLboolean fallback);
181
182 /* save_loopback.c:
183 */
184 void vbo_loopback_vertex_list(struct gl_context *ctx,
185 const GLfloat *buffer,
186 const GLubyte *attrsz,
187 const struct _mesa_prim *prim,
188 GLuint prim_count,
189 GLuint wrap_count,
190 GLuint vertex_size);
191
192 /* Callbacks:
193 */
194 void
195 vbo_save_playback_vertex_list(struct gl_context *ctx, void *data);
196
197 void
198 vbo_save_api_init(struct vbo_save_context *save);
199
200 fi_type *
201 vbo_save_map_vertex_store(struct gl_context *ctx,
202 struct vbo_save_vertex_store *vertex_store);
203
204 void
205 vbo_save_unmap_vertex_store(struct gl_context *ctx,
206 struct vbo_save_vertex_store *vertex_store);
207
208 #endif /* VBO_SAVE_H */
209