1 ##########################################################################
3 # Copyright 2008-2010 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 ##########################################################################/
27 """WGL API description"""
35 wglapi = Module("WGL")
38 HGLRC = Alias("HGLRC", HANDLE)
50 "PFD_NEED_SYSTEM_PALETTE",
53 "PFD_SWAP_LAYER_BUFFERS",
54 "PFD_GENERIC_ACCELERATED",
55 "PFD_SUPPORT_DIRECTDRAW",
56 "PFD_SUPPORT_COMPOSITION",
58 "PFD_DOUBLEBUFFER_DONTCARE",
59 "PFD_STEREO_DONTCARE",
62 PIXELFORMATDESCRIPTOR = Struct("PIXELFORMATDESCRIPTOR", [
71 (BYTE, "cGreenShift"),
75 (BYTE, "cAlphaShift"),
77 (BYTE, "cAccumRedBits"),
78 (BYTE, "cAccumGreenBits"),
79 (BYTE, "cAccumBlueBits"),
80 (BYTE, "cAccumAlphaBits"),
82 (BYTE, "cStencilBits"),
83 (BYTE, "cAuxBuffers"),
86 (DWORD, "dwLayerMask"),
87 (DWORD, "dwVisibleMask"),
88 (DWORD, "dwDamageMask"),
91 POINTFLOAT = Struct("POINTFLOAT", [
96 GLYPHMETRICSFLOAT = Struct("GLYPHMETRICSFLOAT", [
97 (FLOAT, "gmfBlackBoxX"),
98 (FLOAT, "gmfBlackBoxY"),
99 (POINTFLOAT, "gmfptGlyphOrigin"),
100 (FLOAT, "gmfCellIncX"),
101 (FLOAT, "gmfCellIncY"),
103 LPGLYPHMETRICSFLOAT = Pointer(GLYPHMETRICSFLOAT)
105 COLORREF = Alias("COLORREF", DWORD)
108 LAYERPLANEDESCRIPTOR = Struct("LAYERPLANEDESCRIPTOR", [
112 (BYTE, "iPixelType"),
113 (BYTE, "cColorBits"),
116 (BYTE, "cGreenBits"),
117 (BYTE, "cGreenShift"),
119 (BYTE, "cBlueShift"),
120 (BYTE, "cAlphaBits"),
121 (BYTE, "cAlphaShift"),
122 (BYTE, "cAccumBits"),
123 (BYTE, "cAccumRedBits"),
124 (BYTE, "cAccumGreenBits"),
125 (BYTE, "cAccumBlueBits"),
126 (BYTE, "cAccumAlphaBits"),
127 (BYTE, "cDepthBits"),
128 (BYTE, "cStencilBits"),
129 (BYTE, "cAuxBuffers"),
130 (BYTE, "iLayerPlane"),
132 (COLORREF, "crTransparent"),
134 LPLAYERPLANEDESCRIPTOR = Pointer(LAYERPLANEDESCRIPTOR)
136 WGLSWAP = Struct("WGLSWAP", [
141 WGLContextAttribs = AttribArray(WGLenum, [
142 ('WGL_CONTEXT_MAJOR_VERSION_ARB', Int),
143 ('WGL_CONTEXT_MINOR_VERSION_ARB', Int),
144 ('WGL_CONTEXT_LAYER_PLANE_ARB', Int),
145 ('WGL_CONTEXT_FLAGS_ARB', Flags(Int, ["WGL_CONTEXT_DEBUG_BIT_ARB", "WGL_CONTEXT_FORWARD_COMPATIBLE_BIT_ARB"])),
146 ('WGL_CONTEXT_PROFILE_MASK_ARB', Flags(Int, ["WGL_CONTEXT_CORE_PROFILE_BIT_ARB", "WGL_CONTEXT_COMPATIBILITY_PROFILE_BIT_ARB"]))
149 WGLPixelFormatARBAttribsList = [
150 ('WGL_DRAW_TO_WINDOW_ARB', BOOL),
151 ('WGL_DRAW_TO_BITMAP_ARB', BOOL),
152 ('WGL_ACCELERATION_ARB', FakeEnum(Int, ['WGL_NO_ACCELERATION_ARB', 'WGL_GENERIC_ACCELERATION_ARB', 'WGL_FULL_ACCELERATION_ARB'])),
153 ('WGL_NEED_PALETTE_ARB', BOOL),
154 ('WGL_NEED_SYSTEM_PALETTE_ARB', BOOL),
155 ('WGL_SWAP_LAYER_BUFFERS_ARB', BOOL),
156 ('WGL_SWAP_METHOD_ARB', FakeEnum(Int, ['WGL_SWAP_EXCHANGE_ARB', 'WGL_SWAP_COPY_ARB', 'WGL_SWAP_UNDEFINED_ARB'])),
157 ('WGL_NUMBER_OVERLAYS_ARB', Int),
158 ('WGL_NUMBER_UNDERLAYS_ARB', Int),
159 ('WGL_SHARE_DEPTH_ARB', BOOL),
160 ('WGL_SHARE_STENCIL_ARB', BOOL),
161 ('WGL_SHARE_ACCUM_ARB', BOOL),
162 ('WGL_SUPPORT_GDI_ARB', BOOL),
163 ('WGL_SUPPORT_OPENGL_ARB', BOOL),
164 ('WGL_DOUBLE_BUFFER_ARB', BOOL),
165 ('WGL_STEREO_ARB', BOOL),
166 ('WGL_PIXEL_TYPE_ARB', FakeEnum(Int, ['WGL_TYPE_RGBA_ARB', 'WGL_TYPE_COLORINDEX_ARB'])),
167 ('WGL_COLOR_BITS_ARB', Int),
168 ('WGL_RED_BITS_ARB', Int),
169 ('WGL_GREEN_BITS_ARB', Int),
170 ('WGL_BLUE_BITS_ARB', Int),
171 ('WGL_ALPHA_BITS_ARB', Int),
172 ('WGL_ACCUM_BITS_ARB', Int),
173 ('WGL_ACCUM_RED_BITS_ARB', Int),
174 ('WGL_ACCUM_GREEN_BITS_ARB', Int),
175 ('WGL_ACCUM_BLUE_BITS_ARB', Int),
176 ('WGL_ACCUM_ALPHA_BITS_ARB', Int),
177 ('WGL_DEPTH_BITS_ARB', Int),
178 ('WGL_STENCIL_BITS_ARB', Int),
179 ('WGL_AUX_BUFFERS_ARB', Int)
182 WGLPixelFormatARBAttribs = AttribArray(WGLenum, WGLPixelFormatARBAttribsList)
183 WGLPixelFormatARBFloatAttribs = AttribArray(WGLenum, WGLPixelFormatARBAttribsList, punType = FLOAT)
185 WGLPixelFormatEXTAttribsList = [
186 # ('WGL_NUMBER_PIXEL_FORMATS_EXT', Int), # not in ...ARB # only allowed in wglGetPixelFormatAttribiv
187 ('WGL_DRAW_TO_WINDOW_ARB', BOOL),
188 ('WGL_DRAW_TO_BITMAP_ARB', BOOL),
189 ('WGL_ACCELERATION_ARB', FakeEnum(Int, ['WGL_NO_ACCELERATION_ARB', 'WGL_GENERIC_ACCELERATION_ARB', 'WGL_FULL_ACCELERATION_ARB'])),
190 ('WGL_NEED_PALETTE_ARB', BOOL),
191 ('WGL_NEED_SYSTEM_PALETTE_ARB', BOOL),
192 ('WGL_SWAP_LAYER_BUFFERS_ARB', BOOL),
193 ('WGL_SWAP_METHOD_ARB', FakeEnum(Int, ['WGL_SWAP_EXCHANGE_ARB', 'WGL_SWAP_COPY_ARB', 'WGL_SWAP_UNDEFINED_ARB'])),
194 ('WGL_NUMBER_OVERLAYS_ARB', Int),
195 ('WGL_NUMBER_UNDERLAYS_ARB', Int),
196 ('WGL_TRANSPARENT_EXT', BOOL), # not in ...ARB
197 ('WGL_TRANSPARENT_VALUE_EXT', Int), # not in ...ARB
198 ('WGL_SHARE_DEPTH_ARB', BOOL),
199 ('WGL_SHARE_STENCIL_ARB', BOOL),
200 ('WGL_SHARE_ACCUM_ARB', BOOL),
201 ('WGL_SUPPORT_GDI_ARB', BOOL),
202 ('WGL_SUPPORT_OPENGL_ARB', BOOL),
203 ('WGL_DOUBLE_BUFFER_ARB', BOOL),
204 ('WGL_STEREO_ARB', BOOL),
205 ('WGL_PIXEL_TYPE_ARB', FakeEnum(Int, ['WGL_TYPE_RGBA_ARB', 'WGL_TYPE_COLORINDEX_ARB'])),
206 ('WGL_COLOR_BITS_ARB', Int),
207 ('WGL_RED_BITS_ARB', Int),
208 ('WGL_RED_SHIFT_EXT', Int), # not in ...ARB
209 ('WGL_GREEN_BITS_ARB', Int),
210 ('WGL_GREEN_SHIFT_EXT', Int), # not in ...ARB
211 ('WGL_BLUE_BITS_ARB', Int),
212 ('WGL_BLUE_SHIFT_EXT', Int), # not in ...ARB
213 ('WGL_ALPHA_BITS_ARB', Int),
214 ('WGL_ALPHA_SHIFT_EXT', Int), # not in ...ARB
215 ('WGL_ACCUM_BITS_ARB', Int),
216 ('WGL_ACCUM_RED_BITS_ARB', Int),
217 ('WGL_ACCUM_GREEN_BITS_ARB', Int),
218 ('WGL_ACCUM_BLUE_BITS_ARB', Int),
219 ('WGL_ACCUM_ALPHA_BITS_ARB', Int),
220 ('WGL_DEPTH_BITS_ARB', Int),
221 ('WGL_STENCIL_BITS_ARB', Int),
222 ('WGL_AUX_BUFFERS_ARB', Int)
225 WGLPixelFormatEXTAttribs = AttribArray(WGLenum, WGLPixelFormatEXTAttribsList)
226 WGLPixelFormatEXTFloatAttribs = AttribArray(WGLenum, WGLPixelFormatEXTAttribsList, punType = FLOAT)
228 WGLCreatePbufferARBAttribs = AttribArray(WGLenum, [
229 ('WGL_PBUFFER_LARGEST_ARB', Int)
232 CubeFaceEnum = FakeEnum(Int, [
233 'WGL_TEXTURE_CUBE_MAP_POSITIVE_X_ARB',
234 'WGL_TEXTURE_CUBE_MAP_NEGATIVE_X_ARB',
235 'WGL_TEXTURE_CUBE_MAP_POSITIVE_Y_ARB',
236 'WGL_TEXTURE_CUBE_MAP_NEGATIVE_Y_ARB',
237 'WGL_TEXTURE_CUBE_MAP_POSITIVE_Z_ARB',
238 'WGL_TEXTURE_CUBE_MAP_NEGATIVE_Z_ARB'
241 WGLSetPbufferARBAttribs = AttribArray(WGLenum, [
242 ('WGL_MIPMAP_LEVEL_ARB', Int),
243 ('WGL_CUBE_MAP_FACE_ARB', CubeFaceEnum)
246 HPBUFFERARB = Alias("HPBUFFERARB", HANDLE)
249 wglapi.addFunctions([
251 StdFunction(HGLRC, "wglCreateContext", [(HDC, "hdc")]),
252 StdFunction(BOOL, "wglDeleteContext", [(HGLRC, "hglrc")]),
253 StdFunction(HGLRC, "wglGetCurrentContext", [], sideeffects=False),
254 StdFunction(BOOL, "wglMakeCurrent", [(HDC, "hdc"), (HGLRC, "hglrc")]),
255 StdFunction(BOOL, "wglCopyContext", [(HGLRC, "hglrcSrc"), (HGLRC, "hglrcDst"), (UINT, "mask")]),
256 StdFunction(Int, "wglChoosePixelFormat", [(HDC, "hdc"), (Pointer(Const(PIXELFORMATDESCRIPTOR)), "ppfd")]),
257 StdFunction(Int, "wglDescribePixelFormat", [(HDC, "hdc"), (Int, "iPixelFormat"), (UINT, "nBytes"), Out(Pointer(PIXELFORMATDESCRIPTOR), "ppfd")]),
258 StdFunction(HDC, "wglGetCurrentDC", [], sideeffects=False),
259 StdFunction(PROC, "wglGetDefaultProcAddress", [(LPCSTR, "lpszProc")], sideeffects=False),
260 StdFunction(Int, "wglGetPixelFormat", [(HDC, "hdc")], sideeffects=False),
261 StdFunction(BOOL, "wglSetPixelFormat", [(HDC, "hdc"), (Int, "iPixelFormat"), (Pointer(Const(PIXELFORMATDESCRIPTOR)), "ppfd")]),
262 StdFunction(BOOL, "wglSwapBuffers", [(HDC, "hdc")]),
263 StdFunction(BOOL, "wglShareLists", [(HGLRC, "hglrc1"), (HGLRC, "hglrc2")]),
264 StdFunction(HGLRC, "wglCreateLayerContext", [(HDC, "hdc"), (Int, "iLayerPlane")]),
265 StdFunction(BOOL, "wglDescribeLayerPlane", [(HDC, "hdc"), (Int, "iPixelFormat"), (Int, "iLayerPlane"), (UINT, "nBytes"), Out(Pointer(LAYERPLANEDESCRIPTOR), "plpd")]),
266 StdFunction(Int, "wglSetLayerPaletteEntries", [(HDC, "hdc"), (Int, "iLayerPlane"), (Int, "iStart"), (Int, "cEntries"), (Array(Const(COLORREF), "cEntries"), "pcr")]),
267 StdFunction(Int, "wglGetLayerPaletteEntries", [(HDC, "hdc"), (Int, "iLayerPlane"), (Int, "iStart"), (Int, "cEntries"), Out(Array(COLORREF, "cEntries"), "pcr")], sideeffects=False),
268 StdFunction(BOOL, "wglRealizeLayerPalette", [(HDC, "hdc"), (Int, "iLayerPlane"), (BOOL, "bRealize")]),
269 StdFunction(BOOL, "wglSwapLayerBuffers", [(HDC, "hdc"), (UINT, "fuPlanes")]),
270 StdFunction(BOOL, "wglUseFontBitmapsA", [(HDC, "hdc"), (DWORD, "first"), (DWORD, "count"), (DWORD, "listBase")]),
271 StdFunction(BOOL, "wglUseFontBitmapsW", [(HDC, "hdc"), (DWORD, "first"), (DWORD, "count"), (DWORD, "listBase")]),
272 StdFunction(DWORD, "wglSwapMultipleBuffers", [(UINT, "n"), (Array(Const(WGLSWAP), "n"), "ps")]),
273 StdFunction(BOOL, "wglUseFontOutlinesA", [(HDC, "hdc"), (DWORD, "first"), (DWORD, "count"), (DWORD, "listBase"), (FLOAT, "deviation"), (FLOAT, "extrusion"), (Int, "format"), (LPGLYPHMETRICSFLOAT, "lpgmf")]),
274 StdFunction(BOOL, "wglUseFontOutlinesW", [(HDC, "hdc"), (DWORD, "first"), (DWORD, "count"), (DWORD, "listBase"), (FLOAT, "deviation"), (FLOAT, "extrusion"), (Int, "format"), (LPGLYPHMETRICSFLOAT, "lpgmf")]),
276 # WGL_ARB_buffer_region
277 StdFunction(HANDLE, "wglCreateBufferRegionARB", [(HDC, "hDC"), (Int, "iLayerPlane"), (UINT, "uType")]),
278 StdFunction(VOID, "wglDeleteBufferRegionARB", [(HANDLE, "hRegion")]),
279 StdFunction(BOOL, "wglSaveBufferRegionARB", [(HANDLE, "hRegion"), (Int, "x"), (Int, "y"), (Int, "width"), (Int, "height")]),
280 StdFunction(BOOL, "wglRestoreBufferRegionARB", [(HANDLE, "hRegion"), (Int, "x"), (Int, "y"), (Int, "width"), (Int, "height"), (Int, "xSrc"), (Int, "ySrc")]),
282 # WGL_ARB_extensions_string
283 StdFunction(ConstCString, "wglGetExtensionsStringARB", [(HDC, "hdc")], sideeffects=False),
285 # WGL_ARB_pixel_format
286 StdFunction(BOOL, "wglGetPixelFormatAttribivARB", [(HDC, "hdc"), (Int, "iPixelFormat"), (Int, "iLayerPlane"), (UINT, "nAttributes"), (Array(WGLenum, "nAttributes"), "piAttributes"), Out(Array(Int, "nAttributes"), "piValues")], sideeffects=False),
287 StdFunction(BOOL, "wglGetPixelFormatAttribfvARB", [(HDC, "hdc"), (Int, "iPixelFormat"), (Int, "iLayerPlane"), (UINT, "nAttributes"), (Array(WGLenum, "nAttributes"), "piAttributes"), Out(Array(FLOAT, "nAttributes"), "pfValues")], sideeffects=False),
288 StdFunction(BOOL, "wglChoosePixelFormatARB", [(HDC, "hdc"), (WGLPixelFormatARBAttribs, "piAttribIList"), (WGLPixelFormatARBFloatAttribs, "pfAttribFList"), (UINT, "nMaxFormats"), Out(Array(Int, "(*nNumFormats)"), "piFormats"), Out(Pointer(UINT), "nNumFormats")]),
290 # WGL_ARB_make_current_read
291 StdFunction(BOOL, "wglMakeContextCurrentARB", [(HDC, "hDrawDC"), (HDC, "hReadDC"), (HGLRC, "hglrc")]),
292 StdFunction(HDC, "wglGetCurrentReadDCARB", [], sideeffects=False),
295 StdFunction(HPBUFFERARB, "wglCreatePbufferARB", [(HDC, "hDC"), (Int, "iPixelFormat"), (Int, "iWidth"), (Int, "iHeight"), (WGLCreatePbufferARBAttribs, "piAttribList")]),
296 StdFunction(HDC, "wglGetPbufferDCARB", [(HPBUFFERARB, "hPbuffer")]),
297 StdFunction(Int, "wglReleasePbufferDCARB", [(HPBUFFERARB, "hPbuffer"), (HDC, "hDC")]),
298 StdFunction(BOOL, "wglDestroyPbufferARB", [(HPBUFFERARB, "hPbuffer")]),
299 StdFunction(BOOL, "wglQueryPbufferARB", [(HPBUFFERARB, "hPbuffer"), (WGLenum, "iAttribute"), Out(Pointer(Int), "piValue")], sideeffects=False),
301 # WGL_ARB_render_texture
302 StdFunction(BOOL, "wglBindTexImageARB", [(HPBUFFERARB, "hPbuffer"), (Int, "iBuffer")]),
303 StdFunction(BOOL, "wglReleaseTexImageARB", [(HPBUFFERARB, "hPbuffer"), (Int, "iBuffer")]),
304 StdFunction(BOOL, "wglSetPbufferAttribARB", [(HPBUFFERARB, "hPbuffer"), (WGLSetPbufferARBAttribs, "piAttribList")]),
306 # WGL_ARB_create_context
307 StdFunction(HGLRC, "wglCreateContextAttribsARB", [(HDC, "hDC"), (HGLRC, "hShareContext"), (WGLContextAttribs, "attribList")]),
309 # WGL_EXT_extensions_string
310 StdFunction(ConstCString, "wglGetExtensionsStringEXT", [], sideeffects=False),
312 # WGL_EXT_make_current_read
313 StdFunction(BOOL, "wglMakeContextCurrentEXT", [(HDC, "hDrawDC"), (HDC, "hReadDC"), (HGLRC, "hglrc")]),
314 StdFunction(HDC, "wglGetCurrentReadDCEXT", [], sideeffects=False),
316 # WGL_EXT_pixel_format
317 StdFunction(BOOL, "wglGetPixelFormatAttribivEXT", [(HDC, "hdc"), (Int, "iPixelFormat"), (Int, "iLayerPlane"), (UINT, "nAttributes"), (Array(WGLenum, "nAttributes"), "piAttributes"), Out(Array(Int, "nAttributes"), "piValues")], sideeffects=False),
318 StdFunction(BOOL, "wglGetPixelFormatAttribfvEXT", [(HDC, "hdc"), (Int, "iPixelFormat"), (Int, "iLayerPlane"), (UINT, "nAttributes"), (Array(WGLenum, "nAttributes"), "piAttributes"), Out(Array(FLOAT, "nAttributes"), "pfValues")], sideeffects=False),
319 StdFunction(BOOL, "wglChoosePixelFormatEXT", [(HDC, "hdc"), (WGLPixelFormatEXTAttribs, "piAttribIList"), (WGLPixelFormatEXTFloatAttribs, "pfAttribFList"), (UINT, "nMaxFormats"), Out(Array(Int, "*nNumFormats"), "piFormats"), Out(Pointer(UINT), "nNumFormats")]),
321 # WGL_EXT_swap_control
322 StdFunction(BOOL, "wglSwapIntervalEXT", [(Int, "interval")]),
323 StdFunction(Int, "wglGetSwapIntervalEXT", [], sideeffects=False),
325 # WGL_NV_vertex_array_range
326 StdFunction(OpaquePointer(Void), "wglAllocateMemoryNV", [(GLsizei, "size"), (GLfloat, "readfreq"), (GLfloat, "writefreq"), (GLfloat, "priority")]),
327 StdFunction(Void, "wglFreeMemoryNV", [(OpaquePointer(Void), "pointer")]),
330 StdFunction(PROC, "wglGetProcAddress", [(LPCSTR, "lpszProc")]),