1 ##########################################################################
3 # Copyright 2008-2009 VMware, Inc.
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 ##########################################################################/
26 """GLX API description."""
30 from glapi import glapi
32 VisualID = Alias("VisualID", UInt32)
33 Display = Opaque("Display *")
34 Visual = Opaque("Visual *")
35 Font = Alias("Font", UInt32)
36 Pixmap = Alias("Pixmap", UInt32)
37 Window = Alias("Window", UInt32)
39 GLXContext = Opaque("GLXContext")
40 GLXPixmap = Alias("GLXPixmap", UInt32)
41 GLXDrawable = Alias("GLXDrawable", UInt32)
42 GLXFBConfig = Opaque("GLXFBConfig")
43 GLXFBConfigID = Alias("GLXFBConfigID", UInt32)
44 GLXContextID = Alias("GLXContextID", UInt32)
45 GLXWindow = Alias("GLXWindow", UInt32)
46 GLXPbuffer = Alias("GLXPbuffer", UInt32)
48 XVisualInfo = Struct("XVisualInfo", [
50 (VisualID, "visualid"),
55 (ULong, "green_mask"),
57 (Int, "colormap_size"),
58 (Int, "bits_per_rgb"),
61 Bool_ = FakeEnum(Int, [
66 GLXAttrib = FakeEnum(Int, [
81 "GLX_ACCUM_GREEN_SIZE",
82 "GLX_ACCUM_BLUE_SIZE",
83 "GLX_ACCUM_ALPHA_SIZE",
85 "GLX_CONFIG_CAVEAT", # 0x20
86 "GLX_X_VISUAL_TYPE", # 0x22
87 "GLX_TRANSPARENT_TYPE", # 0x23
88 "GLX_TRANSPARENT_INDEX_VALUE", # 0x24
89 "GLX_TRANSPARENT_RED_VALUE", # 0x25
90 "GLX_TRANSPARENT_GREEN_VALUE", # 0x26
91 "GLX_TRANSPARENT_BLUE_VALUE", # 0x27
92 "GLX_TRANSPARENT_ALPHA_VALUE", # 0x28
94 "GLX_BIND_TO_TEXTURE_RGB_EXT", # 0x20D0
95 "GLX_BIND_TO_TEXTURE_RGBA_EXT", # 0x20D1
96 "GLX_BIND_TO_MIPMAP_TEXTURE_EXT", # 0x20D2
97 "GLX_BIND_TO_TEXTURE_TARGETS_EXT", # 0x20D3
98 "GLX_Y_INVERTED_EXT", # 0x20D4
99 "GLX_TEXTURE_FORMAT_EXT", # 0x20D5
100 "GLX_TEXTURE_TARGET_EXT", # 0x20D6
101 "GLX_MIPMAP_TEXTURE_EXT", # 0x20D7
102 "GLX_TEXTURE_FORMAT_NONE_EXT", # 0x20D8
103 "GLX_TEXTURE_FORMAT_RGB_EXT", # 0x20D9
104 "GLX_TEXTURE_FORMAT_RGBA_EXT", # 0x20DA
105 "GLX_TEXTURE_1D_EXT", # 0x20DB
106 "GLX_TEXTURE_2D_EXT", # 0x20DC
107 "GLX_TEXTURE_RECTANGLE_EXT", # 0x20DD
108 "GLX_FRONT_LEFT_EXT", # 0x20DE
109 "GLX_FRONT_RIGHT_EXT", # 0x20DF
110 "GLX_BACK_LEFT_EXT", # 0x20E0
111 "GLX_BACK_RIGHT_EXT", # 0x20E1
112 "GLX_AUX0_EXT", # 0x20E2
113 "GLX_AUX1_EXT", # 0x20E3
114 "GLX_AUX2_EXT", # 0x20E4
115 "GLX_AUX3_EXT", # 0x20E5
116 "GLX_AUX4_EXT", # 0x20E6
117 "GLX_AUX5_EXT", # 0x20E7
118 "GLX_AUX6_EXT", # 0x20E8
119 "GLX_AUX7_EXT", # 0x20E9
120 "GLX_AUX8_EXT", # 0x20EA
121 "GLX_AUX9_EXT", # 0x20EB
124 "GLX_SLOW_CONFIG", # 0x8001
125 "GLX_TRUE_COLOR", # 0x8002
126 "GLX_DIRECT_COLOR", # 0x8003
127 "GLX_PSEUDO_COLOR", # 0x8004
128 "GLX_STATIC_COLOR", # 0x8005
129 "GLX_GRAY_SCALE", # 0x8006
130 "GLX_STATIC_GRAY", # 0x8007
131 "GLX_TRANSPARENT_RGB", # 0x8008
132 "GLX_TRANSPARENT_INDEX", # 0x8009
133 "GLX_VISUAL_ID", # 0x800B
134 "GLX_SCREEN", # 0x800C
135 "GLX_NON_CONFORMANT_CONFIG", # 0x800D
136 "GLX_DRAWABLE_TYPE", # 0x8010
137 "GLX_RENDER_TYPE", # 0x8011
138 "GLX_X_RENDERABLE", # 0x8012
139 "GLX_FBCONFIG_ID", # 0x8013
140 "GLX_RGBA_TYPE", # 0x8014
141 "GLX_COLOR_INDEX_TYPE", # 0x8015
142 "GLX_MAX_PBUFFER_WIDTH", # 0x8016
143 "GLX_MAX_PBUFFER_HEIGHT", # 0x8017
144 "GLX_MAX_PBUFFER_PIXELS", # 0x8018
145 "GLX_PRESERVED_CONTENTS", # 0x801B
146 "GLX_LARGEST_PBUFFER", # 0x801C
147 "GLX_WIDTH", # 0x801D
148 "GLX_HEIGHT", # 0x801E
149 "GLX_EVENT_MASK", # 0x801F
150 "GLX_DAMAGED", # 0x8020
151 "GLX_SAVED", # 0x8021
152 "GLX_WINDOW", # 0x8022
153 "GLX_PBUFFER", # 0x8023
154 "GLX_PBUFFER_HEIGHT", # 0x8040
155 "GLX_PBUFFER_WIDTH", # 0x8041
157 "GLX_SAMPLE_BUFFERS", # 100000
158 "GLX_SAMPLES", # 100001
160 "GLX_DONT_CARE", # 0xFFFFFFFF
163 GLXError = FakeEnum(Int, [
173 GLXname = FakeEnum(Int, [
179 GLXbuffer = Flags(Int, [
183 "GLX_AUX_BUFFERS_BIT",
184 "GLX_FRONT_LEFT_BUFFER_BIT",
185 "GLX_FRONT_RIGHT_BUFFER_BIT",
186 "GLX_BACK_LEFT_BUFFER_BIT",
187 "GLX_BACK_RIGHT_BUFFER_BIT",
188 "GLX_DEPTH_BUFFER_BIT",
189 "GLX_STENCIL_BUFFER_BIT",
190 "GLX_ACCUM_BUFFER_BIT",
193 GLXEnum = FakeEnum(Int, [
202 "GLX_TRANSPARENT_RGB",
203 "GLX_TRANSPARENT_INDEX",
206 "GLX_NON_CONFORMANT_CONFIG",
212 "GLX_COLOR_INDEX_TYPE",
213 "GLX_MAX_PBUFFER_WIDTH",
214 "GLX_MAX_PBUFFER_HEIGHT",
215 "GLX_MAX_PBUFFER_PIXELS",
216 "GLX_PRESERVED_CONTENTS",
217 "GLX_LARGEST_PBUFFER",
225 "GLX_PBUFFER_HEIGHT",
229 GLXbuffer = Flags(Int, [
231 "GLX_COLOR_INDEX_BIT",
232 "GLX_PBUFFER_CLOBBER_MASK",
237 PROC = Opaque("__GLXextFuncPtr")
239 glxapi.add_functions([
241 Function(Pointer(XVisualInfo), "glXChooseVisual", [(Display, "dpy"), (Int, "screen"), (Array(GLXAttrib, "__AttribList_size(attribList)"), "attribList")]),
242 Function(GLXContext, "glXCreateContext", [(Display, "dpy"), (Pointer(XVisualInfo), "vis"), (GLXContext, "shareList"), (Bool_, "direct")]),
243 Function(Void, "glXDestroyContext", [(Display, "dpy"), (GLXContext, "ctx")]),
244 Function(Bool_, "glXMakeCurrent", [(Display, "dpy"), (GLXDrawable, "drawable"), (GLXContext, "ctx")]),
245 Function(Void, "glXCopyContext", [(Display, "dpy"), (GLXContext, "src"), (GLXContext, "dst"),
247 Function(Void, "glXSwapBuffers", [(Display, "dpy"), (GLXDrawable, "drawable")]),
248 Function(GLXPixmap, "glXCreateGLXPixmap", [(Display, "dpy"), (Pointer(XVisualInfo), "visual"),
249 (Pixmap, "pixmap")]),
250 Function(Void, "glXDestroyGLXPixmap", [(Display, "dpy"), (GLXPixmap, "pixmap")]),
251 Function(Bool_, "glXQueryExtension", [(Display, "dpy"), Out(Pointer(Int), "errorb"), Out(Pointer(Int), "event")]),
252 Function(Bool_, "glXQueryVersion", [(Display, "dpy"), Out(Pointer(Int), "maj"), Out(Pointer(Int), "min")]),
253 Function(Bool_, "glXIsDirect", [(Display, "dpy"), (GLXContext, "ctx")]),
254 Function(GLXError, "glXGetConfig", [(Display, "dpy"), (Pointer(XVisualInfo), "visual"),
255 (GLXAttrib, "attrib"), Out(Pointer(Int), "value")]),
256 Function(GLXContext, "glXGetCurrentContext", [], sideeffects=False),
257 Function(GLXDrawable, "glXGetCurrentDrawable", [], sideeffects=False),
258 Function(Void, "glXWaitGL", []),
259 Function(Void, "glXWaitX", []),
260 Function(Void, "glXUseXFont", [(Font, "font"), (Int, "first"), (Int, "count"), (Int, "list")]),
263 Function((Const(String("char *"))), "glXQueryExtensionsString", [(Display, "dpy"), (Int, "screen")]),
264 Function((Const(String("char *"))), "glXQueryServerString", [(Display, "dpy"), (Int, "screen"), (GLXname, "name")]),
265 Function((Const(String("char *"))), "glXGetClientString", [(Display, "dpy"), (GLXname, "name")]),
268 Function(Display, "glXGetCurrentDisplay", [], sideeffects=False),
271 Function(Array(GLXFBConfig, "*nitems"), "glXChooseFBConfig", [(Display, "dpy"), (Int, "screen"), (Const(Array(GLXAttrib, "__AttribList_size(attribList)")), "attribList"), Out(Pointer(Int), "nitems")]),
272 Function(Int, "glXGetFBConfigAttrib", [(Display, "dpy"), (GLXFBConfig, "config"), (GLXAttrib, "attribute"), Out(Pointer(Int), "value")]),
273 Function(Array(GLXFBConfig, "*nelements"), "glXGetFBConfigs", [(Display, "dpy"), (Int, "screen"),
274 Out(Pointer(Int), "nelements")]),
275 Function(Pointer(XVisualInfo), "glXGetVisualFromFBConfig", [(Display, "dpy"),
276 (GLXFBConfig, "config")]),
277 Function(GLXWindow, "glXCreateWindow", [(Display, "dpy"), (GLXFBConfig, "config"),
278 (Window, "win"), (Const(Array(Int, "__AttribList_size(attribList)")), "attribList")]),
279 Function(Void, "glXDestroyWindow", [(Display, "dpy"), (GLXWindow, "window")]),
280 Function(GLXPixmap, "glXCreatePixmap", [(Display, "dpy"), (GLXFBConfig, "config"),
281 (Pixmap, "pixmap"), (Const(Array(Int, "__AttribList_size(attribList)")), "attribList")]),
282 Function(Void, "glXDestroyPixmap", [(Display, "dpy"), (GLXPixmap, "pixmap")]),
283 Function(GLXPbuffer, "glXCreatePbuffer", [(Display, "dpy"), (GLXFBConfig, "config"),
284 (Const(Array(GLXEnum, "__AttribList_size(attribList)")), "attribList")]),
285 Function(Void, "glXDestroyPbuffer", [(Display, "dpy"), (GLXPbuffer, "pbuf")]),
286 Function(Void, "glXQueryDrawable", [(Display, "dpy"), (GLXDrawable, "draw"), (GLXEnum, "attribute"),
287 Out(Pointer(UInt), "value")]),
288 Function(GLXContext, "glXCreateNewContext", [(Display, "dpy"), (GLXFBConfig, "config"),
289 (GLXEnum, "renderType"), (GLXContext, "shareList"),
291 Function(Bool_, "glXMakeContextCurrent", [(Display, "dpy"), (GLXDrawable, "draw"),
292 (GLXDrawable, "read"), (GLXContext, "ctx")]),
293 Function(GLXDrawable, "glXGetCurrentReadDrawable", []),
294 Function(Int, "glXQueryContext", [(Display, "dpy"), (GLXContext, "ctx"), (GLXEnum, "attribute"),
295 Out(Pointer(Int), "value")]),
296 Function(Void, "glXSelectEvent", [(Display, "dpy"), (GLXDrawable, "drawable"),
298 Function(Void, "glXGetSelectedEvent", [(Display, "dpy"), (GLXDrawable, "drawable"),
299 Out(Pointer(ULong), "mask")]),
301 # EXT_texture_from_pixmap
302 Function(Void, "glXBindTexImageEXT", [(Display, "display"), (GLXDrawable, "drawable"), (Int, "buffer"), (Const(Array(Int, "__AttribList_size(attrib_list)")), "attrib_list")]),
303 Function(Void, "glXReleaseTexImageEXT", [(Display, "display"), (GLXDrawable, "drawable"), (Int, "buffer")]),
305 # TODO: more extensions
308 Function(PROC, "glXGetProcAddressARB", [(Alias("const GLubyte *", CString), "procName")]),
309 Function(PROC, "glXGetProcAddress", [(Alias("const GLubyte *", CString), "procName")]),