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_buffer_clear_subdata(struct gl_context *ctx,
 160                            GLintptr offset, GLsizeiptr size,
 161                            const GLvoid *clearValue,
 162                            GLsizeiptr clearValueSize,
 163                            struct gl_buffer_object *bufObj);
 164
 165 /*
 166  * API functions
 167  */
 168 void GLAPIENTRY
 169 _mesa_BindBuffer(GLenum target, GLuint buffer);
 170
 171 void GLAPIENTRY
 172 _mesa_DeleteBuffers(GLsizei n, const GLuint * buffer);
 173
 174 void GLAPIENTRY
 175 _mesa_GenBuffers(GLsizei n, GLuint *buffers);
 176
 177 void GLAPIENTRY
 178 _mesa_CreateBuffers(GLsizei n, GLuint *buffers);
 179
 180 GLboolean GLAPIENTRY
 181 _mesa_IsBuffer(GLuint buffer);
 182
 183 void GLAPIENTRY
 184 _mesa_BufferStorage(GLenum target, GLsizeiptr size, const GLvoid *data,
 185                     GLbitfield flags);
 186
 187 void GLAPIENTRY
 188 _mesa_NamedBufferStorage(GLuint buffer, GLsizeiptr size, const GLvoid *data,
 189                          GLbitfield flags);
 190
 191 void GLAPIENTRY
 192 _mesa_BufferData(GLenum target, GLsizeiptr size,
 193                  const GLvoid *data, GLenum usage);
 194
 195 void GLAPIENTRY
 196 _mesa_NamedBufferData(GLuint buffer, GLsizeiptr size,
 197                       const GLvoid *data, GLenum usage);
 198
 199 void GLAPIENTRY
 200 _mesa_BufferSubData(GLenum target, GLintptr offset,
 201                     GLsizeiptr size, const GLvoid *data);
 202
 203 void GLAPIENTRY
 204 _mesa_NamedBufferSubData(GLuint buffer, GLintptr offset,
 205                          GLsizeiptr size, const GLvoid *data);
 206
 207 void GLAPIENTRY
 208 _mesa_GetBufferSubData(GLenum target, GLintptrARB offset,
 209                        GLsizeiptrARB size, void * 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_ClearBufferSubData(GLenum target, GLenum internalformat,
 218                          GLintptr offset, GLsizeiptr size,
 219                          GLenum format, GLenum type,
 220                          const GLvoid * data);
 221
 222 void * GLAPIENTRY
 223 _mesa_MapBuffer(GLenum target, GLenum access);
 224
 225 GLboolean GLAPIENTRY
 226 _mesa_UnmapBuffer(GLenum target);
 227
 228 void GLAPIENTRY
 229 _mesa_GetBufferParameteriv(GLenum target, GLenum pname, GLint *params);
 230
 231 void GLAPIENTRY
 232 _mesa_GetBufferParameteri64v(GLenum target, GLenum pname, GLint64 *params);
 233
 234 void GLAPIENTRY
 235 _mesa_GetBufferPointerv(GLenum target, GLenum pname, GLvoid **params);
 236
 237 void GLAPIENTRY
 238 _mesa_CopyBufferSubData(GLenum readTarget, GLenum writeTarget,
 239                         GLintptr readOffset, GLintptr writeOffset,
 240                         GLsizeiptr size);
 241
 242 void GLAPIENTRY
 243 _mesa_CopyNamedBufferSubData(GLuint readBuffer, GLuint writeBuffer,
 244                              GLintptr readOffset, GLintptr writeOffset,
 245                              GLsizeiptr size);
 246
 247 void * GLAPIENTRY
 248 _mesa_MapBufferRange(GLenum target, GLintptr offset, GLsizeiptr length,
 249                      GLbitfield access);
 250
 251 void GLAPIENTRY
 252 _mesa_FlushMappedBufferRange(GLenum target,
 253                              GLintptr offset, GLsizeiptr length);
 254
 255 GLenum GLAPIENTRY
 256 _mesa_ObjectPurgeableAPPLE(GLenum objectType, GLuint name, GLenum option);
 257
 258 GLenum GLAPIENTRY
 259 _mesa_ObjectUnpurgeableAPPLE(GLenum objectType, GLuint name, GLenum option);
 260
 261 void GLAPIENTRY
 262 _mesa_GetObjectParameterivAPPLE(GLenum objectType, GLuint name,
 263                                 GLenum pname, GLint* params);
 264
 265 void GLAPIENTRY
 266 _mesa_BindBufferRange(GLenum target, GLuint index,
 267                       GLuint buffer, GLintptr offset, GLsizeiptr size);
 268
 269 void GLAPIENTRY
 270 _mesa_BindBufferBase(GLenum target, GLuint index, GLuint buffer);
 271
 272 void GLAPIENTRY
 273 _mesa_BindBuffersRange(GLenum target, GLuint first, GLsizei count,
 274                        const GLuint *buffers,
 275                        const GLintptr *offsets, const GLsizeiptr *sizes);
 276 void GLAPIENTRY
 277 _mesa_BindBuffersBase(GLenum target, GLuint first, GLsizei count,
 278                       const GLuint *buffers);
 279 void GLAPIENTRY
 280 _mesa_InvalidateBufferSubData(GLuint buffer, GLintptr offset,
 281                               GLsizeiptr length);
 282
 283 void GLAPIENTRY
 284 _mesa_InvalidateBufferData(GLuint buffer);
 285
 286
 287 #endif