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 /** Can we not use this buffer while mapped? */
  49 static inline GLboolean
  50 _mesa_check_disallowed_mapping(const struct gl_buffer_object *obj)
  51 {
  52    return _mesa_bufferobj_mapped(obj, MAP_USER) &&
  53           !(obj->Mappings[MAP_USER].AccessFlags &
  54             GL_MAP_PERSISTENT_BIT);
  55 }
  56
  57 /**
  58  * Is the given buffer object a user-created buffer object?
  59  * Mesa uses default buffer objects in several places.  Default buffers
  60  * always have Name==0.  User created buffers have Name!=0.
  61  */
  62 static inline GLboolean
  63 _mesa_is_bufferobj(const struct gl_buffer_object *obj)
  64 {
  65    return obj != NULL && obj->Name != 0;
  66 }
  67
  68
  69 extern void
  70 _mesa_init_buffer_objects(struct gl_context *ctx);
  71
  72 extern void
  73 _mesa_free_buffer_objects(struct gl_context *ctx);
  74
  75 extern bool
  76 _mesa_handle_bind_buffer_gen(struct gl_context *ctx,
  77                              GLuint buffer,
  78                              struct gl_buffer_object **buf_handle,
  79                              const char *caller);
  80
  81 extern void
  82 _mesa_update_default_objects_buffer_objects(struct gl_context *ctx);
  83
  84
  85 extern struct gl_buffer_object *
  86 _mesa_lookup_bufferobj(struct gl_context *ctx, GLuint buffer);
  87
  88 extern struct gl_buffer_object *
  89 _mesa_lookup_bufferobj_locked(struct gl_context *ctx, GLuint buffer);
  90
  91 extern struct gl_buffer_object *
  92 _mesa_lookup_bufferobj_err(struct gl_context *ctx, GLuint buffer,
  93                            const char *caller);
  94
  95 extern void
  96 _mesa_begin_bufferobj_lookups(struct gl_context *ctx);
  97
  98 extern void
  99 _mesa_end_bufferobj_lookups(struct gl_context *ctx);
 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_map_buffer_range(struct gl_context *ctx,
 163                        struct gl_buffer_object *bufObj,
 164                        GLintptr offset, GLsizeiptr length,
 165                        GLbitfield access, const char *func);
 166
 167 extern void
 168 _mesa_flush_mapped_buffer_range(struct gl_context *ctx,
 169                                 struct gl_buffer_object *bufObj,
 170                                 GLintptr offset, GLsizeiptr length,
 171                                 const char *func);
 172
 173 extern void
 174 _mesa_ClearBufferSubData_sw(struct gl_context *ctx,
 175                             GLintptr offset, GLsizeiptr size,
 176                             const GLvoid *clearValue,
 177                             GLsizeiptr clearValueSize,
 178                             struct gl_buffer_object *bufObj);
 179
 180 extern void
 181 _mesa_clear_buffer_sub_data(struct gl_context *ctx,
 182                             struct gl_buffer_object *bufObj,
 183                             GLenum internalformat,
 184                             GLintptr offset, GLsizeiptr size,
 185                             GLenum format, GLenum type,
 186                             const GLvoid *data,
 187                             const char *func, bool subdata);
 188
 189 extern GLboolean
 190 _mesa_unmap_buffer(struct gl_context *ctx, struct gl_buffer_object *bufObj,
 191                    const char *func);
 192
 193 /*
 194  * API functions
 195  */
 196 void GLAPIENTRY
 197 _mesa_BindBuffer(GLenum target, GLuint buffer);
 198
 199 void GLAPIENTRY
 200 _mesa_DeleteBuffers(GLsizei n, const GLuint * buffer);
 201
 202 void GLAPIENTRY
 203 _mesa_GenBuffers(GLsizei n, GLuint *buffers);
 204
 205 void GLAPIENTRY
 206 _mesa_CreateBuffers(GLsizei n, GLuint *buffers);
 207
 208 GLboolean GLAPIENTRY
 209 _mesa_IsBuffer(GLuint buffer);
 210
 211 void GLAPIENTRY
 212 _mesa_BufferStorage(GLenum target, GLsizeiptr size, const GLvoid *data,
 213                     GLbitfield flags);
 214
 215 void GLAPIENTRY
 216 _mesa_NamedBufferStorage(GLuint buffer, GLsizeiptr size, const GLvoid *data,
 217                          GLbitfield flags);
 218
 219 void GLAPIENTRY
 220 _mesa_BufferData(GLenum target, GLsizeiptr size,
 221                  const GLvoid *data, GLenum usage);
 222
 223 void GLAPIENTRY
 224 _mesa_NamedBufferData(GLuint buffer, GLsizeiptr size,
 225                       const GLvoid *data, GLenum usage);
 226
 227 void GLAPIENTRY
 228 _mesa_BufferSubData(GLenum target, GLintptr offset,
 229                     GLsizeiptr size, const GLvoid *data);
 230
 231 void GLAPIENTRY
 232 _mesa_NamedBufferSubData(GLuint buffer, GLintptr offset,
 233                          GLsizeiptr size, const GLvoid *data);
 234
 235 void GLAPIENTRY
 236 _mesa_GetBufferSubData(GLenum target, GLintptr offset,
 237                        GLsizeiptr size, GLvoid *data);
 238
 239 void GLAPIENTRY
 240 _mesa_GetNamedBufferSubData(GLuint buffer, GLintptr offset,
 241                             GLsizeiptr size, GLvoid *data);
 242
 243 void GLAPIENTRY
 244 _mesa_ClearBufferData(GLenum target, GLenum internalformat,
 245                       GLenum format, GLenum type,
 246                       const GLvoid *data);
 247
 248 void GLAPIENTRY
 249 _mesa_ClearNamedBufferData(GLuint buffer, GLenum internalformat,
 250                            GLenum format, GLenum type,
 251                            const GLvoid *data);
 252
 253 void GLAPIENTRY
 254 _mesa_ClearBufferSubData(GLenum target, GLenum internalformat,
 255                          GLintptr offset, GLsizeiptr size,
 256                          GLenum format, GLenum type,
 257                          const GLvoid *data);
 258
 259 void GLAPIENTRY
 260 _mesa_ClearNamedBufferSubData(GLuint buffer, GLenum internalformat,
 261                               GLintptr offset, GLsizeiptr size,
 262                               GLenum format, GLenum type,
 263                               const GLvoid *data);
 264
 265 GLboolean GLAPIENTRY
 266 _mesa_UnmapBuffer(GLenum target);
 267
 268 GLboolean GLAPIENTRY
 269 _mesa_UnmapNamedBuffer(GLuint buffer);
 270
 271 void GLAPIENTRY
 272 _mesa_GetBufferParameteriv(GLenum target, GLenum pname, GLint *params);
 273
 274 void GLAPIENTRY
 275 _mesa_GetBufferParameteri64v(GLenum target, GLenum pname, GLint64 *params);
 276
 277 void GLAPIENTRY
 278 _mesa_GetNamedBufferParameteriv(GLuint buffer, GLenum pname, GLint *params);
 279
 280 void GLAPIENTRY
 281 _mesa_GetNamedBufferParameteri64v(GLuint buffer, GLenum pname,
 282                                   GLint64 *params);
 283
 284 void GLAPIENTRY
 285 _mesa_GetBufferPointerv(GLenum target, GLenum pname, GLvoid **params);
 286
 287 void GLAPIENTRY
 288 _mesa_GetNamedBufferPointerv(GLuint buffer, GLenum pname, GLvoid **params);
 289
 290
 291 void GLAPIENTRY
 292 _mesa_CopyBufferSubData(GLenum readTarget, GLenum writeTarget,
 293                         GLintptr readOffset, GLintptr writeOffset,
 294                         GLsizeiptr size);
 295
 296 void GLAPIENTRY
 297 _mesa_CopyNamedBufferSubData(GLuint readBuffer, GLuint writeBuffer,
 298                              GLintptr readOffset, GLintptr writeOffset,
 299                              GLsizeiptr size);
 300
 301 void * GLAPIENTRY
 302 _mesa_MapBufferRange(GLenum target, GLintptr offset, GLsizeiptr length,
 303                      GLbitfield access);
 304
 305 void * GLAPIENTRY
 306 _mesa_MapNamedBufferRange(GLuint buffer, GLintptr offset, GLsizeiptr length,
 307                           GLbitfield access);
 308
 309 void * GLAPIENTRY
 310 _mesa_MapBuffer(GLenum target, GLenum access);
 311
 312 void * GLAPIENTRY
 313 _mesa_MapNamedBuffer(GLuint buffer, GLenum access);
 314
 315
 316 void GLAPIENTRY
 317 _mesa_FlushMappedBufferRange(GLenum target,
 318                              GLintptr offset, GLsizeiptr length);
 319
 320 void GLAPIENTRY
 321 _mesa_FlushMappedNamedBufferRange(GLuint buffer, GLintptr offset,
 322                                   GLsizeiptr length);
 323
 324 void GLAPIENTRY
 325 _mesa_BindBufferRange(GLenum target, GLuint index,
 326                       GLuint buffer, GLintptr offset, GLsizeiptr size);
 327
 328 void GLAPIENTRY
 329 _mesa_BindBufferBase(GLenum target, GLuint index, GLuint buffer);
 330
 331 void GLAPIENTRY
 332 _mesa_BindBuffersRange(GLenum target, GLuint first, GLsizei count,
 333                        const GLuint *buffers,
 334                        const GLintptr *offsets, const GLsizeiptr *sizes);
 335 void GLAPIENTRY
 336 _mesa_BindBuffersBase(GLenum target, GLuint first, GLsizei count,
 337                       const GLuint *buffers);
 338 void GLAPIENTRY
 339 _mesa_InvalidateBufferSubData(GLuint buffer, GLintptr offset,
 340                               GLsizeiptr length);
 341
 342 void GLAPIENTRY
 343 _mesa_InvalidateBufferData(GLuint buffer);
 344
 345
 346 #endif