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? */
  41 static inline GLboolean
  42 _mesa_bufferobj_mapped(const struct gl_buffer_object *obj)
  43 {
  44    return obj->Pointer != NULL;
  45 }
  46
  47 /**
  48  * Is the given buffer object a user-created buffer object?
  49  * Mesa uses default buffer objects in several places.  Default buffers
  50  * always have Name==0.  User created buffers have Name!=0.
  51  */
  52 static inline GLboolean
  53 _mesa_is_bufferobj(const struct gl_buffer_object *obj)
  54 {
  55    return obj != NULL && obj->Name != 0;
  56 }
  57
  58
  59 extern void
  60 _mesa_init_buffer_objects( struct gl_context *ctx );
  61
  62 extern void
  63 _mesa_free_buffer_objects( struct gl_context *ctx );
  64
  65 extern bool
  66 _mesa_handle_bind_buffer_gen(struct gl_context *ctx,
  67                              GLenum target,
  68                              GLuint buffer,
  69                              struct gl_buffer_object **buf_handle,
  70                              const char *caller);
  71
  72 extern void
  73 _mesa_update_default_objects_buffer_objects(struct gl_context *ctx);
  74
  75
  76 extern struct gl_buffer_object *
  77 _mesa_lookup_bufferobj(struct gl_context *ctx, GLuint buffer);
  78
  79 extern void
  80 _mesa_initialize_buffer_object( struct gl_context *ctx,
  81                                 struct gl_buffer_object *obj,
  82                                 GLuint name, GLenum target );
  83
  84 extern void
  85 _mesa_reference_buffer_object_(struct gl_context *ctx,
  86                                struct gl_buffer_object **ptr,
  87                                struct gl_buffer_object *bufObj);
  88
  89 static inline void
  90 _mesa_reference_buffer_object(struct gl_context *ctx,
  91                               struct gl_buffer_object **ptr,
  92                               struct gl_buffer_object *bufObj)
  93 {
  94    if (*ptr != bufObj)
  95       _mesa_reference_buffer_object_(ctx, ptr, bufObj);
  96 }
  97
  98 extern GLuint
  99 _mesa_total_buffer_object_memory(struct gl_context *ctx);
 100
 101 extern void
 102 _mesa_init_buffer_object_functions(struct dd_function_table *driver);
 103
 104
 105 /*
 106  * API functions
 107  */
 108
 109 void GLAPIENTRY
 110 _mesa_BindBuffer(GLenum target, GLuint buffer);
 111 void GLAPIENTRY
 112 _mesa_DeleteBuffers(GLsizei n, const GLuint * buffer);
 113 void GLAPIENTRY
 114 _mesa_GenBuffers(GLsizei n, GLuint * buffer);
 115 GLboolean GLAPIENTRY
 116 _mesa_IsBuffer(GLuint buffer);
 117 void GLAPIENTRY
 118 _mesa_BufferData(GLenum target, GLsizeiptrARB size, const GLvoid * data, GLenum usage);
 119 void GLAPIENTRY
 120 _mesa_BufferSubData(GLenum target, GLintptrARB offset, GLsizeiptrARB size, const GLvoid * data);
 121 void GLAPIENTRY
 122 _mesa_GetBufferSubData(GLenum target, GLintptrARB offset, GLsizeiptrARB size, void * data);
 123 void * GLAPIENTRY
 124 _mesa_MapBuffer(GLenum target, GLenum access);
 125 GLboolean GLAPIENTRY
 126 _mesa_UnmapBuffer(GLenum target);
 127 void GLAPIENTRY
 128 _mesa_GetBufferParameteriv(GLenum target, GLenum pname, GLint *params);
 129 void GLAPIENTRY
 130 _mesa_GetBufferParameteri64v(GLenum target, GLenum pname, GLint64 *params);
 131 void GLAPIENTRY
 132 _mesa_GetBufferPointerv(GLenum target, GLenum pname, GLvoid **params);
 133 void GLAPIENTRY
 134 _mesa_CopyBufferSubData(GLenum readTarget, GLenum writeTarget,
 135                         GLintptr readOffset, GLintptr writeOffset,
 136                         GLsizeiptr size);
 137 void * GLAPIENTRY
 138 _mesa_MapBufferRange(GLenum target, GLintptr offset, GLsizeiptr length,
 139                      GLbitfield access);
 140 void GLAPIENTRY
 141 _mesa_FlushMappedBufferRange(GLenum target, GLintptr offset, GLsizeiptr length);
 142 GLenum GLAPIENTRY
 143 _mesa_ObjectPurgeableAPPLE(GLenum objectType, GLuint name, GLenum option);
 144 GLenum GLAPIENTRY
 145 _mesa_ObjectUnpurgeableAPPLE(GLenum objectType, GLuint name, GLenum option);
 146 void GLAPIENTRY
 147 _mesa_GetObjectParameterivAPPLE(GLenum objectType, GLuint name, GLenum pname,
 148                                 GLint* params);
 149 void GLAPIENTRY
 150 _mesa_BindBufferRange(GLenum target, GLuint index,
 151                       GLuint buffer, GLintptr offset, GLsizeiptr size);
 152 void GLAPIENTRY
 153 _mesa_BindBufferBase(GLenum target, GLuint index, GLuint buffer);
 154 void GLAPIENTRY
 155 _mesa_InvalidateBufferSubData(GLuint buffer, GLintptr offset,
 156                               GLsizeiptr length);
 157 void GLAPIENTRY
 158 _mesa_InvalidateBufferData(GLuint buffer);
 159
 160
 161 #endif