mesa: new _mesa_bufferobj_mapped() helper function
[mesa.git] / 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 "context.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(struct gl_buffer_object *obj)
43 {
44 return obj->Pointer != NULL;
45 }
46
47 extern void
48 _mesa_init_buffer_objects( GLcontext *ctx );
49
50 extern void
51 _mesa_update_default_objects_buffer_objects(GLcontext *ctx);
52
53
54 extern struct gl_buffer_object *
55 _mesa_lookup_bufferobj(GLcontext *ctx, GLuint buffer);
56
57 extern void
58 _mesa_initialize_buffer_object( struct gl_buffer_object *obj,
59 GLuint name, GLenum target );
60
61 extern void
62 _mesa_reference_buffer_object(GLcontext *ctx,
63 struct gl_buffer_object **ptr,
64 struct gl_buffer_object *bufObj);
65
66 extern GLboolean
67 _mesa_validate_pbo_access(GLuint dimensions,
68 const struct gl_pixelstore_attrib *pack,
69 GLsizei width, GLsizei height, GLsizei depth,
70 GLenum format, GLenum type, const GLvoid *ptr);
71
72 extern const GLubyte *
73 _mesa_map_bitmap_pbo(GLcontext *ctx,
74 const struct gl_pixelstore_attrib *unpack,
75 const GLubyte *bitmap);
76
77 extern void
78 _mesa_unmap_bitmap_pbo(GLcontext *ctx,
79 const struct gl_pixelstore_attrib *unpack);
80
81 extern const GLvoid *
82 _mesa_map_drawpix_pbo(GLcontext *ctx,
83 const struct gl_pixelstore_attrib *unpack,
84 const GLvoid *pixels);
85
86 extern void
87 _mesa_unmap_drawpix_pbo(GLcontext *ctx,
88 const struct gl_pixelstore_attrib *unpack);
89
90 extern void *
91 _mesa_map_readpix_pbo(GLcontext *ctx,
92 const struct gl_pixelstore_attrib *pack,
93 GLvoid *dest);
94
95 extern void
96 _mesa_unmap_readpix_pbo(GLcontext *ctx,
97 const struct gl_pixelstore_attrib *pack);
98
99
100 extern void
101 _mesa_init_buffer_object_functions(struct dd_function_table *driver);
102
103
104 /*
105 * API functions
106 */
107
108 extern void GLAPIENTRY
109 _mesa_BindBufferARB(GLenum target, GLuint buffer);
110
111 extern void GLAPIENTRY
112 _mesa_DeleteBuffersARB(GLsizei n, const GLuint * buffer);
113
114 extern void GLAPIENTRY
115 _mesa_GenBuffersARB(GLsizei n, GLuint * buffer);
116
117 extern GLboolean GLAPIENTRY
118 _mesa_IsBufferARB(GLuint buffer);
119
120 extern void GLAPIENTRY
121 _mesa_BufferDataARB(GLenum target, GLsizeiptrARB size, const GLvoid * data, GLenum usage);
122
123 extern void GLAPIENTRY
124 _mesa_BufferSubDataARB(GLenum target, GLintptrARB offset, GLsizeiptrARB size, const GLvoid * data);
125
126 extern void GLAPIENTRY
127 _mesa_GetBufferSubDataARB(GLenum target, GLintptrARB offset, GLsizeiptrARB size, void * data);
128
129 extern void * GLAPIENTRY
130 _mesa_MapBufferARB(GLenum target, GLenum access);
131
132 extern GLboolean GLAPIENTRY
133 _mesa_UnmapBufferARB(GLenum target);
134
135 extern void GLAPIENTRY
136 _mesa_GetBufferParameterivARB(GLenum target, GLenum pname, GLint *params);
137
138 extern void GLAPIENTRY
139 _mesa_GetBufferPointervARB(GLenum target, GLenum pname, GLvoid **params);
140
141 extern void GLAPIENTRY
142 _mesa_CopyBufferSubData(GLenum readTarget, GLenum writeTarget,
143 GLintptr readOffset, GLintptr writeOffset,
144 GLsizeiptr size);
145
146 extern void * GLAPIENTRY
147 _mesa_MapBufferRange(GLenum target, GLintptr offset, GLsizeiptr length,
148 GLbitfield access);
149
150 extern void GLAPIENTRY
151 _mesa_FlushMappedBufferRange(GLenum target, GLintptr offset, GLsizeiptr length);
152
153 #endif