mesa: create validate_buffer_sub_data() helper
[mesa.git] / src / mesa / main / bufferobj.h
1 /*
2 * Mesa 3-D graphics library
3 *
4 * Copyright (C) 1999-2008 Brian Paul All Rights Reserved.
5 * Copyright (C) 2009 VMware, Inc. 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 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
11 * and/or sell copies of the Software, and to permit persons to whom the
12 * Software is furnished to do so, subject to the following conditions:
13 *
14 * The above copyright notice and this permission notice shall be included
15 * in all copies or substantial portions of the Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
21 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
22 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
23 * OTHER DEALINGS IN THE SOFTWARE.
24 */
25
26
27
28 #ifndef BUFFEROBJ_H
29 #define BUFFEROBJ_H
30
31 #include <stdbool.h>
32 #include "mtypes.h"
33
34
35 /*
36 * Internal functions
37 */
38
39
40 /** Is the given buffer object currently mapped by the GL user? */
41 static inline GLboolean
42 _mesa_bufferobj_mapped(const struct gl_buffer_object *obj,
43 gl_map_buffer_index index)
44 {
45 return obj->Mappings[index].Pointer != NULL;
46 }
47
48 /**
49 * Check whether the given buffer object is illegally mapped prior to
50 * drawing from (or reading back to) the buffer.
51 * Note that it's legal for a buffer to be mapped at draw/readback time
52 * if it was mapped persistently (See GL_ARB_buffer_storage spec).
53 * \return true if the buffer is illegally mapped, false otherwise
54 */
55 static inline bool
56 _mesa_check_disallowed_mapping(const struct gl_buffer_object *obj)
57 {
58 return _mesa_bufferobj_mapped(obj, MAP_USER) &&
59 !(obj->Mappings[MAP_USER].AccessFlags &
60 GL_MAP_PERSISTENT_BIT);
61 }
62
63 /**
64 * Is the given buffer object a user-created buffer object?
65 * Mesa uses default buffer objects in several places. Default buffers
66 * always have Name==0. User created buffers have Name!=0.
67 */
68 static inline GLboolean
69 _mesa_is_bufferobj(const struct gl_buffer_object *obj)
70 {
71 return obj != NULL && obj->Name != 0;
72 }
73
74
75 extern void
76 _mesa_init_buffer_objects(struct gl_context *ctx);
77
78 extern void
79 _mesa_free_buffer_objects(struct gl_context *ctx);
80
81 extern bool
82 _mesa_handle_bind_buffer_gen(struct gl_context *ctx,
83 GLuint buffer,
84 struct gl_buffer_object **buf_handle,
85 const char *caller);
86
87 extern void
88 _mesa_update_default_objects_buffer_objects(struct gl_context *ctx);
89
90
91 extern struct gl_buffer_object *
92 _mesa_lookup_bufferobj(struct gl_context *ctx, GLuint buffer);
93
94 extern struct gl_buffer_object *
95 _mesa_lookup_bufferobj_locked(struct gl_context *ctx, GLuint buffer);
96
97 extern struct gl_buffer_object *
98 _mesa_lookup_bufferobj_err(struct gl_context *ctx, GLuint buffer,
99 const char *caller);
100
101 extern struct gl_buffer_object *
102 _mesa_multi_bind_lookup_bufferobj(struct gl_context *ctx,
103 const GLuint *buffers,
104 GLuint index, const char *caller);
105
106 extern void
107 _mesa_initialize_buffer_object(struct gl_context *ctx,
108 struct gl_buffer_object *obj,
109 GLuint name);
110
111 extern void
112 _mesa_delete_buffer_object(struct gl_context *ctx,
113 struct gl_buffer_object *bufObj);
114
115 extern void
116 _mesa_reference_buffer_object_(struct gl_context *ctx,
117 struct gl_buffer_object **ptr,
118 struct gl_buffer_object *bufObj);
119
120 static inline void
121 _mesa_reference_buffer_object(struct gl_context *ctx,
122 struct gl_buffer_object **ptr,
123 struct gl_buffer_object *bufObj)
124 {
125 if (*ptr != bufObj)
126 _mesa_reference_buffer_object_(ctx, ptr, bufObj);
127 }
128
129 extern GLuint
130 _mesa_total_buffer_object_memory(struct gl_context *ctx);
131
132 extern void
133 _mesa_init_buffer_object_functions(struct dd_function_table *driver);
134
135 extern void
136 _mesa_buffer_data(struct gl_context *ctx, struct gl_buffer_object *bufObj,
137 GLenum target, GLsizeiptr size, const GLvoid *data,
138 GLenum usage, const char *func);
139
140 extern void
141 _mesa_buffer_sub_data(struct gl_context *ctx, struct gl_buffer_object *bufObj,
142 GLintptr offset, GLsizeiptr size, const GLvoid *data);
143
144 extern void
145 _mesa_buffer_unmap_all_mappings(struct gl_context *ctx,
146 struct gl_buffer_object *bufObj);
147
148 extern void
149 _mesa_ClearBufferSubData_sw(struct gl_context *ctx,
150 GLintptr offset, GLsizeiptr size,
151 const GLvoid *clearValue,
152 GLsizeiptr clearValueSize,
153 struct gl_buffer_object *bufObj);
154
155 /*
156 * API functions
157 */
158 void GLAPIENTRY
159 _mesa_BindBuffer(GLenum target, GLuint buffer);
160
161 void GLAPIENTRY
162 _mesa_DeleteBuffers(GLsizei n, const GLuint * buffer);
163
164 void GLAPIENTRY
165 _mesa_GenBuffers(GLsizei n, GLuint *buffers);
166
167 void GLAPIENTRY
168 _mesa_CreateBuffers(GLsizei n, GLuint *buffers);
169
170 GLboolean GLAPIENTRY
171 _mesa_IsBuffer(GLuint buffer);
172
173 void GLAPIENTRY
174 _mesa_BufferStorage_no_error(GLenum target, GLsizeiptr size,
175 const GLvoid *data, GLbitfield flags);
176 void GLAPIENTRY
177 _mesa_BufferStorage(GLenum target, GLsizeiptr size, const GLvoid *data,
178 GLbitfield flags);
179
180 void GLAPIENTRY
181 _mesa_NamedBufferStorage_no_error(GLuint buffer, GLsizeiptr size,
182 const GLvoid *data, GLbitfield flags);
183 void GLAPIENTRY
184 _mesa_NamedBufferStorage(GLuint buffer, GLsizeiptr size, const GLvoid *data,
185 GLbitfield flags);
186
187 void GLAPIENTRY
188 _mesa_BufferData(GLenum target, GLsizeiptr size,
189 const GLvoid *data, GLenum usage);
190
191 void GLAPIENTRY
192 _mesa_NamedBufferData(GLuint buffer, GLsizeiptr size,
193 const GLvoid *data, GLenum usage);
194
195 void GLAPIENTRY
196 _mesa_BufferSubData(GLenum target, GLintptr offset,
197 GLsizeiptr size, const GLvoid *data);
198
199 void GLAPIENTRY
200 _mesa_NamedBufferSubData(GLuint buffer, GLintptr offset,
201 GLsizeiptr size, const GLvoid *data);
202
203 void GLAPIENTRY
204 _mesa_GetBufferSubData(GLenum target, GLintptr offset,
205 GLsizeiptr size, GLvoid *data);
206
207 void GLAPIENTRY
208 _mesa_GetNamedBufferSubData(GLuint buffer, GLintptr offset,
209 GLsizeiptr size, GLvoid *data);
210
211 void GLAPIENTRY
212 _mesa_ClearBufferData(GLenum target, GLenum internalformat,
213 GLenum format, GLenum type,
214 const GLvoid *data);
215
216 void GLAPIENTRY
217 _mesa_ClearNamedBufferData(GLuint buffer, GLenum internalformat,
218 GLenum format, GLenum type,
219 const GLvoid *data);
220
221 void GLAPIENTRY
222 _mesa_ClearBufferSubData(GLenum target, GLenum internalformat,
223 GLintptr offset, GLsizeiptr size,
224 GLenum format, GLenum type,
225 const GLvoid *data);
226
227 void GLAPIENTRY
228 _mesa_ClearNamedBufferSubData(GLuint buffer, GLenum internalformat,
229 GLintptr offset, GLsizeiptr size,
230 GLenum format, GLenum type,
231 const GLvoid *data);
232
233 GLboolean GLAPIENTRY
234 _mesa_UnmapBuffer_no_error(GLenum target);
235 GLboolean GLAPIENTRY
236 _mesa_UnmapBuffer(GLenum target);
237
238 GLboolean GLAPIENTRY
239 _mesa_UnmapNamedBuffer_no_error(GLuint buffer);
240 GLboolean GLAPIENTRY
241 _mesa_UnmapNamedBuffer(GLuint buffer);
242
243 void GLAPIENTRY
244 _mesa_GetBufferParameteriv(GLenum target, GLenum pname, GLint *params);
245
246 void GLAPIENTRY
247 _mesa_GetBufferParameteri64v(GLenum target, GLenum pname, GLint64 *params);
248
249 void GLAPIENTRY
250 _mesa_GetNamedBufferParameteriv(GLuint buffer, GLenum pname, GLint *params);
251
252 void GLAPIENTRY
253 _mesa_GetNamedBufferParameteri64v(GLuint buffer, GLenum pname,
254 GLint64 *params);
255
256 void GLAPIENTRY
257 _mesa_GetBufferPointerv(GLenum target, GLenum pname, GLvoid **params);
258
259 void GLAPIENTRY
260 _mesa_GetNamedBufferPointerv(GLuint buffer, GLenum pname, GLvoid **params);
261
262 void GLAPIENTRY
263 _mesa_CopyBufferSubData_no_error(GLenum readTarget, GLenum writeTarget,
264 GLintptr readOffset, GLintptr writeOffset,
265 GLsizeiptr size);
266 void GLAPIENTRY
267 _mesa_CopyBufferSubData(GLenum readTarget, GLenum writeTarget,
268 GLintptr readOffset, GLintptr writeOffset,
269 GLsizeiptr size);
270
271 void GLAPIENTRY
272 _mesa_CopyNamedBufferSubData_no_error(GLuint readBuffer, GLuint writeBuffer,
273 GLintptr readOffset,
274 GLintptr writeOffset, GLsizeiptr size);
275 void GLAPIENTRY
276 _mesa_CopyNamedBufferSubData(GLuint readBuffer, GLuint writeBuffer,
277 GLintptr readOffset, GLintptr writeOffset,
278 GLsizeiptr size);
279
280 void * GLAPIENTRY
281 _mesa_MapBufferRange_no_error(GLenum target, GLintptr offset,
282 GLsizeiptr length, GLbitfield access);
283 void * GLAPIENTRY
284 _mesa_MapBufferRange(GLenum target, GLintptr offset, GLsizeiptr length,
285 GLbitfield access);
286
287 void * GLAPIENTRY
288 _mesa_MapNamedBufferRange_no_error(GLuint buffer, GLintptr offset,
289 GLsizeiptr length, GLbitfield access);
290 void * GLAPIENTRY
291 _mesa_MapNamedBufferRange(GLuint buffer, GLintptr offset, GLsizeiptr length,
292 GLbitfield access);
293
294 void * GLAPIENTRY
295 _mesa_MapBuffer_no_error(GLenum target, GLenum access);
296 void * GLAPIENTRY
297 _mesa_MapBuffer(GLenum target, GLenum access);
298
299 void * GLAPIENTRY
300 _mesa_MapNamedBuffer_no_error(GLuint buffer, GLenum access);
301 void * GLAPIENTRY
302 _mesa_MapNamedBuffer(GLuint buffer, GLenum access);
303
304 void GLAPIENTRY
305 _mesa_FlushMappedBufferRange_no_error(GLenum target, GLintptr offset,
306 GLsizeiptr length);
307 void GLAPIENTRY
308 _mesa_FlushMappedBufferRange(GLenum target,
309 GLintptr offset, GLsizeiptr length);
310
311 void GLAPIENTRY
312 _mesa_FlushMappedNamedBufferRange_no_error(GLuint buffer, GLintptr offset,
313 GLsizeiptr length);
314 void GLAPIENTRY
315 _mesa_FlushMappedNamedBufferRange(GLuint buffer, GLintptr offset,
316 GLsizeiptr length);
317
318 void GLAPIENTRY
319 _mesa_BindBufferRange(GLenum target, GLuint index,
320 GLuint buffer, GLintptr offset, GLsizeiptr size);
321
322 void GLAPIENTRY
323 _mesa_BindBufferBase(GLenum target, GLuint index, GLuint buffer);
324
325 void GLAPIENTRY
326 _mesa_BindBuffersRange(GLenum target, GLuint first, GLsizei count,
327 const GLuint *buffers,
328 const GLintptr *offsets, const GLsizeiptr *sizes);
329 void GLAPIENTRY
330 _mesa_BindBuffersBase(GLenum target, GLuint first, GLsizei count,
331 const GLuint *buffers);
332 void GLAPIENTRY
333 _mesa_InvalidateBufferSubData(GLuint buffer, GLintptr offset,
334 GLsizeiptr length);
335
336 void GLAPIENTRY
337 _mesa_InvalidateBufferData(GLuint buffer);
338
339 void GLAPIENTRY
340 _mesa_BufferPageCommitmentARB(GLenum target, GLintptr offset, GLsizeiptr size,
341 GLboolean commit);
342
343 void GLAPIENTRY
344 _mesa_NamedBufferPageCommitmentARB(GLuint buffer, GLintptr offset,
345 GLsizeiptr size, GLboolean commit);
346
347 #endif