src/mesa/main/bufferobj.h

   1 /*
   2  * Mesa 3-D graphics library
   3  * Version:  7.6
   4  *
   5  * Copyright (C) 1999-2008  Brian Paul   All Rights Reserved.
   6  * Copyright (C) 2009  VMware, Inc.  All Rights Reserved.
   7  *
   8  * Permission is hereby granted, free of charge, to any person obtaining a
   9  * copy of this software and associated documentation files (the "Software"),
  10  * to deal in the Software without restriction, including without limitation
  11  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  12  * and/or sell copies of the Software, and to permit persons to whom the
  13  * Software is furnished to do so, subject to the following conditions:
  14  *
  15  * The above copyright notice and this permission notice shall be included
  16  * in all copies or substantial portions of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  19  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  21  * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
  22  * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  23  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  24  */
  25
  26
  27
  28 #ifndef BUFFEROBJ_H
  29 #define BUFFEROBJ_H
  30
  31
  32 #include "mfeatures.h"
  33 #include "mtypes.h"
  34
  35
  36 /*
  37  * Internal functions
  38  */
  39
  40
  41 /** Is the given buffer object currently mapped? */
  42 static INLINE GLboolean
  43 _mesa_bufferobj_mapped(const struct gl_buffer_object *obj)
  44 {
  45    return obj->Pointer != NULL;
  46 }
  47
  48 /**
  49  * Is the given buffer object a user-created buffer object?
  50  * Mesa uses default buffer objects in several places.  Default buffers
  51  * always have Name==0.  User created buffers have Name!=0.
  52  */
  53 static INLINE GLboolean
  54 _mesa_is_bufferobj(const struct gl_buffer_object *obj)
  55 {
  56    return obj->Name != 0;
  57 }
  58
  59
  60 extern void
  61 _mesa_init_buffer_objects( struct gl_context *ctx );
  62
  63 extern void
  64 _mesa_free_buffer_objects( struct gl_context *ctx );
  65
  66 extern void
  67 _mesa_update_default_objects_buffer_objects(struct gl_context *ctx);
  68
  69
  70 extern struct gl_buffer_object *
  71 _mesa_lookup_bufferobj(struct gl_context *ctx, GLuint buffer);
  72
  73 extern void
  74 _mesa_initialize_buffer_object( struct gl_buffer_object *obj,
  75                                 GLuint name, GLenum target );
  76
  77 extern void
  78 _mesa_reference_buffer_object(struct gl_context *ctx,
  79                               struct gl_buffer_object **ptr,
  80                               struct gl_buffer_object *bufObj);
  81
  82 extern void
  83 _mesa_init_buffer_object_functions(struct dd_function_table *driver);
  84
  85
  86 /*
  87  * API functions
  88  */
  89
  90 extern void GLAPIENTRY
  91 _mesa_BindBufferARB(GLenum target, GLuint buffer);
  92
  93 extern void GLAPIENTRY
  94 _mesa_DeleteBuffersARB(GLsizei n, const GLuint * buffer);
  95
  96 extern void GLAPIENTRY
  97 _mesa_GenBuffersARB(GLsizei n, GLuint * buffer);
  98
  99 extern GLboolean GLAPIENTRY
 100 _mesa_IsBufferARB(GLuint buffer);
 101
 102 extern void GLAPIENTRY
 103 _mesa_BufferDataARB(GLenum target, GLsizeiptrARB size, const GLvoid * data, GLenum usage);
 104
 105 extern void GLAPIENTRY
 106 _mesa_BufferSubDataARB(GLenum target, GLintptrARB offset, GLsizeiptrARB size, const GLvoid * data);
 107
 108 extern void GLAPIENTRY
 109 _mesa_GetBufferSubDataARB(GLenum target, GLintptrARB offset, GLsizeiptrARB size, void * data);
 110
 111 extern void * GLAPIENTRY
 112 _mesa_MapBufferARB(GLenum target, GLenum access);
 113
 114 extern GLboolean GLAPIENTRY
 115 _mesa_UnmapBufferARB(GLenum target);
 116
 117 extern void GLAPIENTRY
 118 _mesa_GetBufferParameterivARB(GLenum target, GLenum pname, GLint *params);
 119
 120 extern void GLAPIENTRY
 121 _mesa_GetBufferParameteri64v(GLenum target, GLenum pname, GLint64 *params);
 122
 123 extern void GLAPIENTRY
 124 _mesa_GetBufferPointervARB(GLenum target, GLenum pname, GLvoid **params);
 125
 126 extern void GLAPIENTRY
 127 _mesa_CopyBufferSubData(GLenum readTarget, GLenum writeTarget,
 128                         GLintptr readOffset, GLintptr writeOffset,
 129                         GLsizeiptr size);
 130
 131 extern void * GLAPIENTRY
 132 _mesa_MapBufferRange(GLenum target, GLintptr offset, GLsizeiptr length,
 133                      GLbitfield access);
 134
 135 extern void GLAPIENTRY
 136 _mesa_FlushMappedBufferRange(GLenum target, GLintptr offset, GLsizeiptr length);
 137
 138 #if FEATURE_APPLE_object_purgeable
 139 extern GLenum GLAPIENTRY
 140 _mesa_ObjectPurgeableAPPLE(GLenum objectType, GLuint name, GLenum option);
 141
 142 extern GLenum GLAPIENTRY
 143 _mesa_ObjectUnpurgeableAPPLE(GLenum objectType, GLuint name, GLenum option);
 144
 145 extern void GLAPIENTRY
 146 _mesa_GetObjectParameterivAPPLE(GLenum objectType, GLuint name, GLenum pname, GLint* params);
 147 #endif
 148
 149 #endif