bufferobj.h revision 3464ebd5 
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? */
42static 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 */
53static INLINE GLboolean
54_mesa_is_bufferobj(const struct gl_buffer_object *obj)
55{
56   return obj->Name != 0;
57}
58
59
60extern void
61_mesa_init_buffer_objects( struct gl_context *ctx );
62
63extern void
64_mesa_free_buffer_objects( struct gl_context *ctx );
65
66extern void
67_mesa_update_default_objects_buffer_objects(struct gl_context *ctx);
68
69
70extern struct gl_buffer_object *
71_mesa_lookup_bufferobj(struct gl_context *ctx, GLuint buffer);
72
73extern void
74_mesa_initialize_buffer_object( struct gl_buffer_object *obj,
75				GLuint name, GLenum target );
76
77extern void
78_mesa_reference_buffer_object(struct gl_context *ctx,
79                              struct gl_buffer_object **ptr,
80                              struct gl_buffer_object *bufObj);
81
82extern void
83_mesa_init_buffer_object_functions(struct dd_function_table *driver);
84
85
86/*
87 * API functions
88 */
89
90extern void GLAPIENTRY
91_mesa_BindBufferARB(GLenum target, GLuint buffer);
92
93extern void GLAPIENTRY
94_mesa_DeleteBuffersARB(GLsizei n, const GLuint * buffer);
95
96extern void GLAPIENTRY
97_mesa_GenBuffersARB(GLsizei n, GLuint * buffer);
98
99extern GLboolean GLAPIENTRY
100_mesa_IsBufferARB(GLuint buffer);
101
102extern void GLAPIENTRY
103_mesa_BufferDataARB(GLenum target, GLsizeiptrARB size, const GLvoid * data, GLenum usage);
104
105extern void GLAPIENTRY
106_mesa_BufferSubDataARB(GLenum target, GLintptrARB offset, GLsizeiptrARB size, const GLvoid * data);
107
108extern void GLAPIENTRY
109_mesa_GetBufferSubDataARB(GLenum target, GLintptrARB offset, GLsizeiptrARB size, void * data);
110
111extern void * GLAPIENTRY
112_mesa_MapBufferARB(GLenum target, GLenum access);
113
114extern GLboolean GLAPIENTRY
115_mesa_UnmapBufferARB(GLenum target);
116
117extern void GLAPIENTRY
118_mesa_GetBufferParameterivARB(GLenum target, GLenum pname, GLint *params);
119
120extern void GLAPIENTRY
121_mesa_GetBufferParameteri64v(GLenum target, GLenum pname, GLint64 *params);
122
123extern void GLAPIENTRY
124_mesa_GetBufferPointervARB(GLenum target, GLenum pname, GLvoid **params);
125
126extern void GLAPIENTRY
127_mesa_CopyBufferSubData(GLenum readTarget, GLenum writeTarget,
128                        GLintptr readOffset, GLintptr writeOffset,
129                        GLsizeiptr size);
130
131extern void * GLAPIENTRY
132_mesa_MapBufferRange(GLenum target, GLintptr offset, GLsizeiptr length,
133                     GLbitfield access);
134
135extern void GLAPIENTRY
136_mesa_FlushMappedBufferRange(GLenum target, GLintptr offset, GLsizeiptr length);
137
138#if FEATURE_APPLE_object_purgeable
139extern GLenum GLAPIENTRY
140_mesa_ObjectPurgeableAPPLE(GLenum objectType, GLuint name, GLenum option);
141
142extern GLenum GLAPIENTRY
143_mesa_ObjectUnpurgeableAPPLE(GLenum objectType, GLuint name, GLenum option);
144
145extern void GLAPIENTRY
146_mesa_GetObjectParameterivAPPLE(GLenum objectType, GLuint name, GLenum pname, GLint* params);
147#endif
148
149#endif
150