decoder "width" parameter represents "stride-in-pixels"
[mesa.git] / src / mesa / main / bufferobj.h
1 /*
2 * Mesa 3-D graphics library
3 * Version: 6.1
4 *
5 * Copyright (C) 1999-2004 Brian Paul 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 * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
21 * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23 */
24
25
26
27 #ifndef BUFFEROBJ_H
28 #define BUFFEROBJ_H
29
30
31 #include "context.h"
32
33
34 /*
35 * Internal functions
36 */
37
38 extern void
39 _mesa_init_buffer_objects( GLcontext *ctx );
40
41 extern struct gl_buffer_object *
42 _mesa_new_buffer_object( GLcontext *ctx, GLuint name, GLenum target );
43
44 extern void
45 _mesa_delete_buffer_object( GLcontext *ctx, struct gl_buffer_object *bufObj );
46
47 extern void
48 _mesa_initialize_buffer_object( struct gl_buffer_object *obj,
49 GLuint name, GLenum target );
50
51 extern void
52 _mesa_save_buffer_object( GLcontext *ctx, struct gl_buffer_object *obj );
53
54 extern void
55 _mesa_remove_buffer_object( GLcontext *ctx, struct gl_buffer_object *bufObj );
56
57 extern void
58 _mesa_buffer_data( GLcontext *ctx, GLenum target, GLsizeiptrARB size,
59 const GLvoid * data, GLenum usage,
60 struct gl_buffer_object * bufObj );
61
62 extern void
63 _mesa_buffer_subdata( GLcontext *ctx, GLenum target, GLintptrARB offset,
64 GLsizeiptrARB size, const GLvoid * data,
65 struct gl_buffer_object * bufObj );
66
67 extern void
68 _mesa_buffer_get_subdata( GLcontext *ctx, GLenum target, GLintptrARB offset,
69 GLsizeiptrARB size, GLvoid * data,
70 struct gl_buffer_object * bufObj );
71
72 extern void *
73 _mesa_buffer_map( GLcontext *ctx, GLenum target, GLenum access,
74 struct gl_buffer_object * bufObj );
75
76
77 extern GLboolean
78 _mesa_validate_pbo_access(const struct gl_pixelstore_attrib *pack,
79 GLsizei width, GLsizei height, GLsizei depth,
80 GLenum format, GLenum type, const GLvoid *ptr);
81
82
83 /*
84 * API functions
85 */
86
87 extern void GLAPIENTRY
88 _mesa_BindBufferARB(GLenum target, GLuint buffer);
89
90 extern void GLAPIENTRY
91 _mesa_DeleteBuffersARB(GLsizei n, const GLuint * buffer);
92
93 extern void GLAPIENTRY
94 _mesa_GenBuffersARB(GLsizei n, GLuint * buffer);
95
96 extern GLboolean GLAPIENTRY
97 _mesa_IsBufferARB(GLuint buffer);
98
99 extern void GLAPIENTRY
100 _mesa_BufferDataARB(GLenum target, GLsizeiptrARB size, const GLvoid * data, GLenum usage);
101
102 extern void GLAPIENTRY
103 _mesa_BufferSubDataARB(GLenum target, GLintptrARB offset, GLsizeiptrARB size, const GLvoid * data);
104
105 extern void GLAPIENTRY
106 _mesa_GetBufferSubDataARB(GLenum target, GLintptrARB offset, GLsizeiptrARB size, void * data);
107
108 extern void * GLAPIENTRY
109 _mesa_MapBufferARB(GLenum target, GLenum access);
110
111 extern GLboolean GLAPIENTRY
112 _mesa_UnmapBufferARB(GLenum target);
113
114 extern void GLAPIENTRY
115 _mesa_GetBufferParameterivARB(GLenum target, GLenum pname, GLint *params);
116
117 extern void GLAPIENTRY
118 _mesa_GetBufferPointervARB(GLenum target, GLenum pname, GLvoid **params);
119
120 #endif