1 ##########################################################################
3 # Copyright 2011 Jose Fonseca
6 # Permission is hereby granted, free of charge, to any person obtaining a copy
7 # of this software and associated documentation files (the "Software"), to deal
8 # in the Software without restriction, including without limitation the rights
9 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 # copies of the Software, and to permit persons to whom the Software is
11 # furnished to do so, subject to the following conditions:
13 # The above copyright notice and this permission notice shall be included in
14 # all copies or substantial portions of the Software.
16 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 ##########################################################################/
27 '''Describe GL types.'''
35 GLboolean = Enum("GLboolean", [
40 GLvoid = Alias("GLvoid", Void)
41 GLbyte = Alias("GLbyte", SChar)
42 GLshort = Alias("GLshort", Short)
43 GLint = Alias("GLint", Int)
44 GLint64 = Alias("GLint64", Int64)
45 GLubyte = Alias("GLubyte", UChar)
46 GLushort = Alias("GLushort", UShort)
47 GLuint = Alias("GLuint", UInt)
48 GLuint64 = Alias("GLuint64", UInt64)
49 GLsizei = Alias("GLsizei", Int)
50 GLintptr = Alias("GLintptr", Int)
51 GLsizeiptr = Alias("GLsizeiptr", Int)
52 GLfloat = Alias("GLfloat", Float)
53 GLclampf = Alias("GLclampf", Float)
54 GLdouble = Alias("GLdouble", Double)
55 GLclampd = Alias("GLclampd", Double)
56 GLchar = Alias("GLchar", SChar)
57 GLstring = String("GLchar *")
59 GLcharARB = Alias("GLcharARB", SChar)
60 GLstringARB = String("GLcharARB *")
61 GLintptrARB = Alias("GLintptrARB", Int)
62 GLsizeiptrARB = Alias("GLsizeiptrARB", Int)
63 GLhandleARB = Handle("handleARB", Alias("GLhandleARB", UInt))
64 GLhalfARB = Alias("GLhalfARB", UShort)
65 GLhalfNV = Alias("GLhalfNV", UShort)
66 GLint64EXT = Alias("GLint64EXT", Int64)
67 GLuint64EXT = Alias("GLuint64EXT", UInt64)
68 GLDEBUGPROCARB = Opaque("GLDEBUGPROCARB")
69 GLDEBUGPROCAMD = Opaque("GLDEBUGPROCAMD")
71 GLpointer = OpaquePointer(GLvoid)
72 GLpointerConst = OpaquePointer(Const(GLvoid))
74 GLlist = Handle("list", GLuint)
75 GLtexture = Handle("texture", GLuint)
76 GLbuffer = Handle("buffer", GLuint)
77 GLquery = Handle("query", GLuint)
78 GLfenceNV = Handle("fenceNV", GLuint)
79 GLprogram = Handle("program", GLuint)
80 GLshader = Handle("shader", GLuint)
82 # Share the same mapping table for uniform locations of both core and
83 # GL_ARB_shader_objects programs. For a combination of reasons:
85 # - all OpenGL implementations appear to alias the names for both kind of
88 # - most applications will use only one kind of shader programs;
90 # - some applications actually mix glUniformXxx calls with
91 # GL_ARB_shader_objects programs and glUniformXxxARB calls with core
92 # programs, and therefore, rely on a joint implementation.
94 # We use GLhandleARB as program key, since it is wider (void *) on MacOSX.
96 GLlocation = Handle("location", GLint, key=('program', GLhandleARB))
97 GLlocationARB = Handle("location", GLint, key=('programObj', GLhandleARB))
99 GLprogramARB = Handle("programARB", GLuint)
100 GLframebuffer = Handle("framebuffer", GLuint)
101 GLrenderbuffer = Handle("renderbuffer", GLuint)
102 GLfragmentShaderATI = Handle("fragmentShaderATI", GLuint)
103 GLarray = Handle("array", GLuint)
104 GLregion = Handle("region", GLuint)
105 GLpipeline = Handle("pipeline", GLuint)
106 GLsampler = Handle("sampler", GLuint)
107 GLfeedback = Handle("feedback", GLuint)
109 # GL mappings are pointers to linear memory regions.
111 # The map length is not always available in the function prototype, and must be
112 # reconstructed from other state.
113 GLmap = LinearPointer(GLvoid, "length")
115 GLsync = Handle("sync", IntPointer("GLsync"))
117 GLenum = Enum("GLenum", [
118 # Parameters are added later from glparams.py's parameter table
121 # Some functions take GLenum disguised as GLint, and need special treatment so
122 # that symbolic names are traced correctly.
123 GLenum_int = Alias("GLint", GLenum)
125 GLenum_mode = FakeEnum(GLenum, [
126 "GL_POINTS", # 0x0000
128 "GL_LINE_LOOP", # 0x0002
129 "GL_LINE_STRIP", # 0x0003
130 "GL_TRIANGLES", # 0x0004
131 "GL_TRIANGLE_STRIP", # 0x0005
132 "GL_TRIANGLE_FAN", # 0x0006
134 "GL_QUAD_STRIP", # 0x0008
135 "GL_POLYGON", # 0x0009
136 "GL_LINES_ADJACENCY", # 0x000A
137 "GL_LINE_STRIP_ADJACENCY", # 0x000B
138 "GL_TRIANGLES_ADJACENCY", # 0x000C
139 "GL_TRIANGLE_STRIP_ADJACENCY", # 0x000D
140 "GL_PATCHES", # 0x000E
143 GLenum_error = FakeEnum(GLenum, [
145 "GL_INVALID_ENUM", # 0x0500
146 "GL_INVALID_VALUE", # 0x0501
147 "GL_INVALID_OPERATION", # 0x0502
148 "GL_STACK_OVERFLOW", # 0x0503
149 "GL_STACK_UNDERFLOW", # 0x0504
150 "GL_OUT_OF_MEMORY", # 0x0505
151 "GL_INVALID_FRAMEBUFFER_OPERATION", # 0x0506
152 "GL_TABLE_TOO_LARGE", # 0x8031
155 GLbitfield = Alias("GLbitfield", UInt)
157 GLbitfield_attrib = Flags(GLbitfield, [
158 "GL_ALL_ATTRIB_BITS", # 0x000FFFFF
159 "GL_CURRENT_BIT", # 0x00000001
160 "GL_POINT_BIT", # 0x00000002
161 "GL_LINE_BIT", # 0x00000004
162 "GL_POLYGON_BIT", # 0x00000008
163 "GL_POLYGON_STIPPLE_BIT", # 0x00000010
164 "GL_PIXEL_MODE_BIT", # 0x00000020
165 "GL_LIGHTING_BIT", # 0x00000040
166 "GL_FOG_BIT", # 0x00000080
167 "GL_DEPTH_BUFFER_BIT", # 0x00000100
168 "GL_ACCUM_BUFFER_BIT", # 0x00000200
169 "GL_STENCIL_BUFFER_BIT", # 0x00000400
170 "GL_VIEWPORT_BIT", # 0x00000800
171 "GL_TRANSFORM_BIT", # 0x00001000
172 "GL_ENABLE_BIT", # 0x00002000
173 "GL_COLOR_BUFFER_BIT", # 0x00004000
174 "GL_HINT_BIT", # 0x00008000
175 "GL_EVAL_BIT", # 0x00010000
176 "GL_LIST_BIT", # 0x00020000
177 "GL_TEXTURE_BIT", # 0x00040000
178 "GL_SCISSOR_BIT", # 0x00080000
179 "GL_MULTISAMPLE_BIT", # 0x20000000
182 GLbitfield_client_attrib = Flags(GLbitfield, [
183 "GL_CLIENT_ALL_ATTRIB_BITS", # 0xFFFFFFFF
184 "GL_CLIENT_PIXEL_STORE_BIT", # 0x00000001
185 "GL_CLIENT_VERTEX_ARRAY_BIT", # 0x00000002
188 GLbitfield_shader = Flags(GLbitfield, [
189 "GL_ALL_SHADER_BITS", # 0xFFFFFFFF
190 "GL_VERTEX_SHADER_BIT", # 0x00000001
191 "GL_FRAGMENT_SHADER_BIT", # 0x00000002
192 "GL_GEOMETRY_SHADER_BIT", # 0x00000004
193 "GL_TESS_CONTROL_SHADER_BIT", # 0x00000008
194 "GL_TESS_EVALUATION_SHADER_BIT", # 0x00000010
197 GLbitfield_access = Flags(GLbitfield, [
198 "GL_MAP_READ_BIT", # 0x0001
199 "GL_MAP_WRITE_BIT", # 0x0002
200 "GL_MAP_INVALIDATE_RANGE_BIT", # 0x0004
201 "GL_MAP_INVALIDATE_BUFFER_BIT", # 0x0008
202 "GL_MAP_FLUSH_EXPLICIT_BIT", # 0x0010
203 "GL_MAP_UNSYNCHRONIZED_BIT", # 0x0020
206 GLbitfield_sync_flush = Flags(GLbitfield, [
207 "GL_SYNC_FLUSH_COMMANDS_BIT", # 0x00000001
210 GLbitfield_barrier = Flags(GLbitfield, [
211 "GL_ALL_BARRIER_BITS", # 0xFFFFFFFF
212 "GL_VERTEX_ATTRIB_ARRAY_BARRIER_BIT", # 0x00000001
213 "GL_ELEMENT_ARRAY_BARRIER_BIT", # 0x00000002
214 "GL_UNIFORM_BARRIER_BIT", # 0x00000004
215 "GL_TEXTURE_FETCH_BARRIER_BIT", # 0x00000008
216 "GL_SHADER_GLOBAL_ACCESS_BARRIER_BIT_NV", # 0x00000010
217 "GL_SHADER_IMAGE_ACCESS_BARRIER_BIT", # 0x00000020
218 "GL_COMMAND_BARRIER_BIT", # 0x00000040
219 "GL_PIXEL_BUFFER_BARRIER_BIT", # 0x00000080
220 "GL_TEXTURE_UPDATE_BARRIER_BIT", # 0x00000100
221 "GL_BUFFER_UPDATE_BARRIER_BIT", # 0x00000200
222 "GL_FRAMEBUFFER_BARRIER_BIT", # 0x00000400
223 "GL_TRANSFORM_FEEDBACK_BARRIER_BIT", # 0x00000800
224 "GL_ATOMIC_COUNTER_BARRIER_BIT", # 0x00001000