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_storage(struct gl_context *ctx, struct gl_buffer_object *bufObj,
 137                      GLenum target, GLsizeiptr size, const GLvoid *data,
 138                      GLbitfield flags, const char *func);
 139
 140 extern void
 141 _mesa_buffer_data(struct gl_context *ctx, struct gl_buffer_object *bufObj,
 142                   GLenum target, GLsizeiptr size, const GLvoid *data,
 143                   GLenum usage, const char *func);
 144
 145 extern void
 146 _mesa_buffer_sub_data(struct gl_context *ctx, struct gl_buffer_object *bufObj,
 147                       GLintptr offset, GLsizeiptr size, const GLvoid *data,
 148                       const char *func);
 149
 150 extern void
 151 _mesa_buffer_unmap_all_mappings(struct gl_context *ctx,
 152                                 struct gl_buffer_object *bufObj);
 153
 154 extern void
 155 _mesa_copy_buffer_sub_data(struct gl_context *ctx,
 156                            struct gl_buffer_object *src,
 157                            struct gl_buffer_object *dst,
 158                            GLintptr readOffset, GLintptr writeOffset,
 159                            GLsizeiptr size, const char *func);
 160
 161 extern void
 162 _mesa_flush_mapped_buffer_range(struct gl_context *ctx,
 163                                 struct gl_buffer_object *bufObj,
 164                                 GLintptr offset, GLsizeiptr length,
 165                                 const char *func);
 166
 167 extern void
 168 _mesa_ClearBufferSubData_sw(struct gl_context *ctx,
 169                             GLintptr offset, GLsizeiptr size,
 170                             const GLvoid *clearValue,
 171                             GLsizeiptr clearValueSize,
 172                             struct gl_buffer_object *bufObj);
 173
 174 extern void
 175 _mesa_clear_buffer_sub_data(struct gl_context *ctx,
 176                             struct gl_buffer_object *bufObj,
 177                             GLenum internalformat,
 178                             GLintptr offset, GLsizeiptr size,
 179                             GLenum format, GLenum type,
 180                             const GLvoid *data,
 181                             const char *func, bool subdata);
 182
 183 extern GLboolean
 184 _mesa_unmap_buffer(struct gl_context *ctx, struct gl_buffer_object *bufObj,
 185                    const char *func);
 186
 187 /*
 188  * API functions
 189  */
 190 void GLAPIENTRY
 191 _mesa_BindBuffer(GLenum target, GLuint buffer);
 192
 193 void GLAPIENTRY
 194 _mesa_DeleteBuffers(GLsizei n, const GLuint * buffer);
 195
 196 void GLAPIENTRY
 197 _mesa_GenBuffers(GLsizei n, GLuint *buffers);
 198
 199 void GLAPIENTRY
 200 _mesa_CreateBuffers(GLsizei n, GLuint *buffers);
 201
 202 GLboolean GLAPIENTRY
 203 _mesa_IsBuffer(GLuint buffer);
 204
 205 void GLAPIENTRY
 206 _mesa_BufferStorage(GLenum target, GLsizeiptr size, const GLvoid *data,
 207                     GLbitfield flags);
 208
 209 void GLAPIENTRY
 210 _mesa_NamedBufferStorage(GLuint buffer, GLsizeiptr size, const GLvoid *data,
 211                          GLbitfield flags);
 212
 213 void GLAPIENTRY
 214 _mesa_BufferData(GLenum target, GLsizeiptr size,
 215                  const GLvoid *data, GLenum usage);
 216
 217 void GLAPIENTRY
 218 _mesa_NamedBufferData(GLuint buffer, GLsizeiptr size,
 219                       const GLvoid *data, GLenum usage);
 220
 221 void GLAPIENTRY
 222 _mesa_BufferSubData(GLenum target, GLintptr offset,
 223                     GLsizeiptr size, const GLvoid *data);
 224
 225 void GLAPIENTRY
 226 _mesa_NamedBufferSubData(GLuint buffer, GLintptr offset,
 227                          GLsizeiptr size, const GLvoid *data);
 228
 229 void GLAPIENTRY
 230 _mesa_GetBufferSubData(GLenum target, GLintptr offset,
 231                        GLsizeiptr size, GLvoid *data);
 232
 233 void GLAPIENTRY
 234 _mesa_GetNamedBufferSubData(GLuint buffer, GLintptr offset,
 235                             GLsizeiptr size, GLvoid *data);
 236
 237 void GLAPIENTRY
 238 _mesa_ClearBufferData(GLenum target, GLenum internalformat,
 239                       GLenum format, GLenum type,
 240                       const GLvoid *data);
 241
 242 void GLAPIENTRY
 243 _mesa_ClearNamedBufferData(GLuint buffer, GLenum internalformat,
 244                            GLenum format, GLenum type,
 245                            const GLvoid *data);
 246
 247 void GLAPIENTRY
 248 _mesa_ClearBufferSubData(GLenum target, GLenum internalformat,
 249                          GLintptr offset, GLsizeiptr size,
 250                          GLenum format, GLenum type,
 251                          const GLvoid *data);
 252
 253 void GLAPIENTRY
 254 _mesa_ClearNamedBufferSubData(GLuint buffer, GLenum internalformat,
 255                               GLintptr offset, GLsizeiptr size,
 256                               GLenum format, GLenum type,
 257                               const GLvoid *data);
 258
 259 GLboolean GLAPIENTRY
 260 _mesa_UnmapBuffer(GLenum target);
 261
 262 GLboolean GLAPIENTRY
 263 _mesa_UnmapNamedBuffer(GLuint buffer);
 264
 265 void GLAPIENTRY
 266 _mesa_GetBufferParameteriv(GLenum target, GLenum pname, GLint *params);
 267
 268 void GLAPIENTRY
 269 _mesa_GetBufferParameteri64v(GLenum target, GLenum pname, GLint64 *params);
 270
 271 void GLAPIENTRY
 272 _mesa_GetNamedBufferParameteriv(GLuint buffer, GLenum pname, GLint *params);
 273
 274 void GLAPIENTRY
 275 _mesa_GetNamedBufferParameteri64v(GLuint buffer, GLenum pname,
 276                                   GLint64 *params);
 277
 278 void GLAPIENTRY
 279 _mesa_GetBufferPointerv(GLenum target, GLenum pname, GLvoid **params);
 280
 281 void GLAPIENTRY
 282 _mesa_GetNamedBufferPointerv(GLuint buffer, GLenum pname, GLvoid **params);
 283
 284
 285 void GLAPIENTRY
 286 _mesa_CopyBufferSubData(GLenum readTarget, GLenum writeTarget,
 287                         GLintptr readOffset, GLintptr writeOffset,
 288                         GLsizeiptr size);
 289
 290 void GLAPIENTRY
 291 _mesa_CopyNamedBufferSubData(GLuint readBuffer, GLuint writeBuffer,
 292                              GLintptr readOffset, GLintptr writeOffset,
 293                              GLsizeiptr size);
 294
 295 void * GLAPIENTRY
 296 _mesa_MapBufferRange_no_error(GLenum target, GLintptr offset,
 297                               GLsizeiptr length, GLbitfield access);
 298 void * GLAPIENTRY
 299 _mesa_MapBufferRange(GLenum target, GLintptr offset, GLsizeiptr length,
 300                      GLbitfield access);
 301
 302 void * GLAPIENTRY
 303 _mesa_MapNamedBufferRange_no_error(GLuint buffer, GLintptr offset,
 304                                    GLsizeiptr length, GLbitfield access);
 305 void * GLAPIENTRY
 306 _mesa_MapNamedBufferRange(GLuint buffer, GLintptr offset, GLsizeiptr length,
 307                           GLbitfield access);
 308
 309 void * GLAPIENTRY
 310 _mesa_MapBuffer_no_error(GLenum target, GLenum access);
 311 void * GLAPIENTRY
 312 _mesa_MapBuffer(GLenum target, GLenum access);
 313
 314 void * GLAPIENTRY
 315 _mesa_MapNamedBuffer_no_error(GLuint buffer, GLenum access);
 316 void * GLAPIENTRY
 317 _mesa_MapNamedBuffer(GLuint buffer, GLenum access);
 318
 319
 320 void GLAPIENTRY
 321 _mesa_FlushMappedBufferRange(GLenum target,
 322                              GLintptr offset, GLsizeiptr length);
 323
 324 void GLAPIENTRY
 325 _mesa_FlushMappedNamedBufferRange(GLuint buffer, GLintptr offset,
 326                                   GLsizeiptr length);
 327
 328 void GLAPIENTRY
 329 _mesa_BindBufferRange(GLenum target, GLuint index,
 330                       GLuint buffer, GLintptr offset, GLsizeiptr size);
 331
 332 void GLAPIENTRY
 333 _mesa_BindBufferBase(GLenum target, GLuint index, GLuint buffer);
 334
 335 void GLAPIENTRY
 336 _mesa_BindBuffersRange(GLenum target, GLuint first, GLsizei count,
 337                        const GLuint *buffers,
 338                        const GLintptr *offsets, const GLsizeiptr *sizes);
 339 void GLAPIENTRY
 340 _mesa_BindBuffersBase(GLenum target, GLuint first, GLsizei count,
 341                       const GLuint *buffers);
 342 void GLAPIENTRY
 343 _mesa_InvalidateBufferSubData(GLuint buffer, GLintptr offset,
 344                               GLsizeiptr length);
 345
 346 void GLAPIENTRY
 347 _mesa_InvalidateBufferData(GLuint buffer);
 348
 349 void GLAPIENTRY
 350 _mesa_BufferPageCommitmentARB(GLenum target, GLintptr offset, GLsizeiptr size,
 351                               GLboolean commit);
 352
 353 void GLAPIENTRY
 354 _mesa_NamedBufferPageCommitmentARB(GLuint buffer, GLintptr offset,
 355                                    GLsizeiptr size, GLboolean commit);
 356
 357 #endif