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