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                              GLenum target,
  78                              GLuint buffer,
  79                              struct gl_buffer_object **buf_handle,
  80                              const char *caller);
  81
  82 extern void
  83 _mesa_update_default_objects_buffer_objects(struct gl_context *ctx);
  84
  85
  86 extern struct gl_buffer_object *
  87 _mesa_lookup_bufferobj(struct gl_context *ctx, GLuint buffer);
  88
  89 extern struct gl_buffer_object *
  90 _mesa_lookup_bufferobj_locked(struct gl_context *ctx, GLuint buffer);
  91
  92 extern struct gl_buffer_object *
  93 _mesa_lookup_bufferobj_err(struct gl_context *ctx, GLuint buffer,
  94                            const char *caller);
  95
  96 extern void
  97 _mesa_begin_bufferobj_lookups(struct gl_context *ctx);
  98
  99 extern void
 100 _mesa_end_bufferobj_lookups(struct gl_context *ctx);
 101
 102 extern struct gl_buffer_object *
 103 _mesa_multi_bind_lookup_bufferobj(struct gl_context *ctx,
 104                                   const GLuint *buffers,
 105                                   GLuint index, const char *caller);
 106
 107 extern void
 108 _mesa_initialize_buffer_object(struct gl_context *ctx,
 109                                struct gl_buffer_object *obj,
 110                                GLuint name);
 111
 112 extern void
 113 _mesa_reference_buffer_object_(struct gl_context *ctx,
 114                                struct gl_buffer_object **ptr,
 115                                struct gl_buffer_object *bufObj);
 116
 117 static inline void
 118 _mesa_reference_buffer_object(struct gl_context *ctx,
 119                               struct gl_buffer_object **ptr,
 120                               struct gl_buffer_object *bufObj)
 121 {
 122    if (*ptr != bufObj)
 123       _mesa_reference_buffer_object_(ctx, ptr, bufObj);
 124 }
 125
 126 extern GLuint
 127 _mesa_total_buffer_object_memory(struct gl_context *ctx);
 128
 129 extern void
 130 _mesa_init_buffer_object_functions(struct dd_function_table *driver);
 131
 132 extern void
 133 _mesa_buffer_storage(struct gl_context *ctx, struct gl_buffer_object *bufObj,
 134                      GLenum target, GLsizeiptr size, const GLvoid *data,
 135                      GLbitfield flags, const char *func);
 136
 137 extern void
 138 _mesa_buffer_data(struct gl_context *ctx, struct gl_buffer_object *bufObj,
 139                   GLenum target, GLsizeiptr size, const GLvoid *data,
 140                   GLenum usage, const char *func);
 141
 142 extern void
 143 _mesa_buffer_sub_data(struct gl_context *ctx, struct gl_buffer_object *bufObj,
 144                       GLintptr offset, GLsizeiptr size, const GLvoid *data,
 145                       const char *func);
 146
 147 extern void
 148 _mesa_buffer_unmap_all_mappings(struct gl_context *ctx,
 149                                 struct gl_buffer_object *bufObj);
 150
 151 extern void
 152 _mesa_copy_buffer_sub_data(struct gl_context *ctx,
 153                            struct gl_buffer_object *src,
 154                            struct gl_buffer_object *dst,
 155                            GLintptr readOffset, GLintptr writeOffset,
 156                            GLsizeiptr size, const char *func);
 157
 158 extern void *
 159 _mesa_map_buffer_range(struct gl_context *ctx,
 160                        struct gl_buffer_object *bufObj,
 161                        GLintptr offset, GLsizeiptr length,
 162                        GLbitfield access, const char *func);
 163
 164 extern void
 165 _mesa_ClearBufferSubData_sw(struct gl_context *ctx,
 166                             GLintptr offset, GLsizeiptr size,
 167                             const GLvoid *clearValue,
 168                             GLsizeiptr clearValueSize,
 169                             struct gl_buffer_object *bufObj);
 170
 171 extern void
 172 _mesa_clear_buffer_sub_data(struct gl_context *ctx,
 173                             struct gl_buffer_object *bufObj,
 174                             GLenum internalformat,
 175                             GLintptr offset, GLsizeiptr size,
 176                             GLenum format, GLenum type,
 177                             const GLvoid *data,
 178                             const char *func, bool subdata);
 179
 180 /*
 181  * API functions
 182  */
 183 void GLAPIENTRY
 184 _mesa_BindBuffer(GLenum target, GLuint buffer);
 185
 186 void GLAPIENTRY
 187 _mesa_DeleteBuffers(GLsizei n, const GLuint * buffer);
 188
 189 void GLAPIENTRY
 190 _mesa_GenBuffers(GLsizei n, GLuint *buffers);
 191
 192 void GLAPIENTRY
 193 _mesa_CreateBuffers(GLsizei n, GLuint *buffers);
 194
 195 GLboolean GLAPIENTRY
 196 _mesa_IsBuffer(GLuint buffer);
 197
 198 void GLAPIENTRY
 199 _mesa_BufferStorage(GLenum target, GLsizeiptr size, const GLvoid *data,
 200                     GLbitfield flags);
 201
 202 void GLAPIENTRY
 203 _mesa_NamedBufferStorage(GLuint buffer, GLsizeiptr size, const GLvoid *data,
 204                          GLbitfield flags);
 205
 206 void GLAPIENTRY
 207 _mesa_BufferData(GLenum target, GLsizeiptr size,
 208                  const GLvoid *data, GLenum usage);
 209
 210 void GLAPIENTRY
 211 _mesa_NamedBufferData(GLuint buffer, GLsizeiptr size,
 212                       const GLvoid *data, GLenum usage);
 213
 214 void GLAPIENTRY
 215 _mesa_BufferSubData(GLenum target, GLintptr offset,
 216                     GLsizeiptr size, const GLvoid *data);
 217
 218 void GLAPIENTRY
 219 _mesa_NamedBufferSubData(GLuint buffer, GLintptr offset,
 220                          GLsizeiptr size, const GLvoid *data);
 221
 222 void GLAPIENTRY
 223 _mesa_GetBufferSubData(GLenum target, GLintptrARB offset,
 224                        GLsizeiptrARB size, void * data);
 225
 226 void GLAPIENTRY
 227 _mesa_ClearBufferData(GLenum target, GLenum internalformat,
 228                       GLenum format, GLenum type,
 229                       const GLvoid *data);
 230
 231 void GLAPIENTRY
 232 _mesa_ClearNamedBufferData(GLuint buffer, GLenum internalformat,
 233                            GLenum format, GLenum type,
 234                            const GLvoid *data);
 235
 236 void GLAPIENTRY
 237 _mesa_ClearBufferSubData(GLenum target, GLenum internalformat,
 238                          GLintptr offset, GLsizeiptr size,
 239                          GLenum format, GLenum type,
 240                          const GLvoid *data);
 241
 242 void GLAPIENTRY
 243 _mesa_ClearNamedBufferSubData(GLuint buffer, GLenum internalformat,
 244                               GLintptr offset, GLsizeiptr size,
 245                               GLenum format, GLenum type,
 246                               const GLvoid *data);
 247
 248 void * GLAPIENTRY
 249 _mesa_MapBuffer(GLenum target, GLenum access);
 250
 251 GLboolean GLAPIENTRY
 252 _mesa_UnmapBuffer(GLenum target);
 253
 254 void GLAPIENTRY
 255 _mesa_GetBufferParameteriv(GLenum target, GLenum pname, GLint *params);
 256
 257 void GLAPIENTRY
 258 _mesa_GetBufferParameteri64v(GLenum target, GLenum pname, GLint64 *params);
 259
 260 void GLAPIENTRY
 261 _mesa_GetBufferPointerv(GLenum target, GLenum pname, GLvoid **params);
 262
 263 void GLAPIENTRY
 264 _mesa_CopyBufferSubData(GLenum readTarget, GLenum writeTarget,
 265                         GLintptr readOffset, GLintptr writeOffset,
 266                         GLsizeiptr size);
 267
 268 void GLAPIENTRY
 269 _mesa_CopyNamedBufferSubData(GLuint readBuffer, GLuint writeBuffer,
 270                              GLintptr readOffset, GLintptr writeOffset,
 271                              GLsizeiptr size);
 272
 273 void * GLAPIENTRY
 274 _mesa_MapBufferRange(GLenum target, GLintptr offset, GLsizeiptr length,
 275                      GLbitfield access);
 276
 277 void GLAPIENTRY
 278 _mesa_FlushMappedBufferRange(GLenum target,
 279                              GLintptr offset, GLsizeiptr length);
 280
 281 GLenum GLAPIENTRY
 282 _mesa_ObjectPurgeableAPPLE(GLenum objectType, GLuint name, GLenum option);
 283
 284 GLenum GLAPIENTRY
 285 _mesa_ObjectUnpurgeableAPPLE(GLenum objectType, GLuint name, GLenum option);
 286
 287 void GLAPIENTRY
 288 _mesa_GetObjectParameterivAPPLE(GLenum objectType, GLuint name,
 289                                 GLenum pname, GLint* params);
 290
 291 void GLAPIENTRY
 292 _mesa_BindBufferRange(GLenum target, GLuint index,
 293                       GLuint buffer, GLintptr offset, GLsizeiptr size);
 294
 295 void GLAPIENTRY
 296 _mesa_BindBufferBase(GLenum target, GLuint index, GLuint buffer);
 297
 298 void GLAPIENTRY
 299 _mesa_BindBuffersRange(GLenum target, GLuint first, GLsizei count,
 300                        const GLuint *buffers,
 301                        const GLintptr *offsets, const GLsizeiptr *sizes);
 302 void GLAPIENTRY
 303 _mesa_BindBuffersBase(GLenum target, GLuint first, GLsizei count,
 304                       const GLuint *buffers);
 305 void GLAPIENTRY
 306 _mesa_InvalidateBufferSubData(GLuint buffer, GLintptr offset,
 307                               GLsizeiptr length);
 308
 309 void GLAPIENTRY
 310 _mesa_InvalidateBufferData(GLuint buffer);
 311
 312
 313 #endif