]> git.cworth.org Git - apitrace/blob - specs/eglapi.py
5266207f9404f387246b47ae3ef2a5fb35da3b22
[apitrace] / specs / eglapi.py
1 ##########################################################################
2 #
3 # Copyright 2011 LunarG, Inc.
4 # All Rights Reserved.
5 #
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:
12 #
13 # The above copyright notice and this permission notice shall be included in
14 # all copies or substantial portions of the Software.
15 #
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
22 # THE SOFTWARE.
23 #
24 ##########################################################################/
25
26 """EGL API description."""
27
28
29 from stdapi import *
30
31 EGLNativeDisplayType = Opaque("EGLNativeDisplayType")
32 EGLNativeWindowType = Opaque("EGLNativeWindowType")
33 EGLNativePixmapType = Opaque("EGLNativePixmapType")
34
35 EGLDisplay = Opaque("EGLDisplay")
36 EGLConfig = Opaque("EGLConfig")
37 EGLContext = Opaque("EGLContext")
38 EGLSurface = Opaque("EGLSurface")
39
40 EGLClientBuffer = Opaque("EGLClientBuffer")
41
42 _EGLBoolean = Alias("EGLBoolean", UInt)
43 EGLBoolean = FakeEnum(_EGLBoolean, [
44     "EGL_FALSE",
45     "EGL_TRUE",
46 ])
47
48 EGLint = Alias("EGLint", Int32)
49 EGLenum = Alias("EGLenum", UInt)
50
51 EGLError = FakeEnum(EGLint, [
52     "EGL_SUCCESS",                  # 0x3000
53     "EGL_NOT_INITIALIZED",          # 0x3001
54     "EGL_BAD_ACCESS",               # 0x3002
55     "EGL_BAD_ALLOC",                # 0x3003
56     "EGL_BAD_ATTRIBUTE",            # 0x3004
57     "EGL_BAD_CONFIG",               # 0x3005
58     "EGL_BAD_CONTEXT",              # 0x3006
59     "EGL_BAD_CURRENT_SURFACE",      # 0x3007
60     "EGL_BAD_DISPLAY",              # 0x3008
61     "EGL_BAD_MATCH",                # 0x3009
62     "EGL_BAD_NATIVE_PIXMAP",        # 0x300A
63     "EGL_BAD_NATIVE_WINDOW",        # 0x300B
64     "EGL_BAD_PARAMETER",            # 0x300C
65     "EGL_BAD_SURFACE",              # 0x300D
66     "EGL_CONTEXT_LOST",             # 0x300E  /* EGL 1.1 - IMG_power_management */
67 ])
68
69 EGLConfigAttrib = FakeEnum(EGLint, [
70     "EGL_BUFFER_SIZE",              # 0x3020
71     "EGL_ALPHA_SIZE",               # 0x3021
72     "EGL_BLUE_SIZE",                # 0x3022
73     "EGL_GREEN_SIZE",               # 0x3023
74     "EGL_RED_SIZE",                 # 0x3024
75     "EGL_DEPTH_SIZE",               # 0x3025
76     "EGL_STENCIL_SIZE",             # 0x3026
77     "EGL_CONFIG_CAVEAT",            # 0x3027
78     "EGL_CONFIG_ID",                # 0x3028
79     "EGL_LEVEL",                    # 0x3029
80     "EGL_MAX_PBUFFER_HEIGHT",       # 0x302A
81     "EGL_MAX_PBUFFER_PIXELS",       # 0x302B
82     "EGL_MAX_PBUFFER_WIDTH",        # 0x302C
83     "EGL_NATIVE_RENDERABLE",        # 0x302D
84     "EGL_NATIVE_VISUAL_ID",         # 0x302E
85     "EGL_NATIVE_VISUAL_TYPE",       # 0x302F
86     "EGL_SAMPLES",                  # 0x3031
87     "EGL_SAMPLE_BUFFERS",           # 0x3032
88     "EGL_SURFACE_TYPE",             # 0x3033
89     "EGL_TRANSPARENT_TYPE",         # 0x3034
90     "EGL_TRANSPARENT_BLUE_VALUE",   # 0x3035
91     "EGL_TRANSPARENT_GREEN_VALUE",  # 0x3036
92     "EGL_TRANSPARENT_RED_VALUE",    # 0x3037
93     "EGL_NONE",                     # 0x3038  /* Attrib list terminator */
94     "EGL_BIND_TO_TEXTURE_RGB",      # 0x3039
95     "EGL_BIND_TO_TEXTURE_RGBA",     # 0x303A
96     "EGL_MIN_SWAP_INTERVAL",        # 0x303B
97     "EGL_MAX_SWAP_INTERVAL",        # 0x303C
98     "EGL_LUMINANCE_SIZE",           # 0x303D
99     "EGL_ALPHA_MASK_SIZE",          # 0x303E
100     "EGL_COLOR_BUFFER_TYPE",        # 0x303F
101     "EGL_RENDERABLE_TYPE",          # 0x3040
102     "EGL_MATCH_NATIVE_PIXMAP",      # 0x3041  /* Pseudo-attribute (not queryable) */
103     "EGL_CONFORMANT",               # 0x3042
104
105     # EGL_KHR_lock_surface
106     "EGL_MATCH_FORMAT_KHR",         # 0x3043
107
108     # EGL_NV_coverage_sample
109     "EGL_COVERAGE_BUFFERS_NV",      # 0x30E0
110     "EGL_COVERAGE_SAMPLES_NV",      # 0x30E1
111
112     # EGL_NV_depth_nonlinear
113     "EGL_DEPTH_ENCODING_NV",        # 0x30E2
114
115     # EGL_HI_colorformats
116     "EGL_COLOR_FORMAT_HI",          # 0x8F70
117 ])
118
119 EGLName = FakeEnum(EGLint, [
120     "EGL_VENDOR",                   # 0x3053
121     "EGL_VERSION",                  # 0x3054
122     "EGL_EXTENSIONS",               # 0x3055
123     "EGL_CLIENT_APIS",              # 0x308D
124 ])
125
126 EGLSurfaceAttrib = FakeEnum(EGLint, [
127     "EGL_HEIGHT",                   # 0x3056
128     "EGL_WIDTH",                    # 0x3057
129     "EGL_LARGEST_PBUFFER",          # 0x3058
130     "EGL_TEXTURE_FORMAT",           # 0x3080
131     "EGL_TEXTURE_TARGET",           # 0x3081
132     "EGL_MIPMAP_TEXTURE",           # 0x3082
133     "EGL_MIPMAP_LEVEL",             # 0x3083
134     "EGL_RENDER_BUFFER",            # 0x3086
135     "EGL_VG_COLORSPACE",            # 0x3087
136     "EGL_VG_ALPHA_FORMAT",          # 0x3088
137     "EGL_HORIZONTAL_RESOLUTION",    # 0x3090
138     "EGL_VERTICAL_RESOLUTION",      # 0x3091
139     "EGL_PIXEL_ASPECT_RATIO",       # 0x3092
140     "EGL_SWAP_BEHAVIOR",            # 0x3093
141     "EGL_MULTISAMPLE_RESOLVE",      # 0x3099
142     "EGL_NONE",
143
144     # EGL_KHR_lock_surface
145     "EGL_BITMAP_POINTER_KHR",                   # 0x30C6
146     "EGL_BITMAP_PITCH_KHR",                     # 0x30C7
147     "EGL_BITMAP_ORIGIN_KHR",                    # 0x30C8
148     "EGL_BITMAP_PIXEL_RED_OFFSET_KHR",          # 0x30C9
149     "EGL_BITMAP_PIXEL_GREEN_OFFSET_KHR",        # 0x30CA
150     "EGL_BITMAP_PIXEL_BLUE_OFFSET_KHR",         # 0x30CB
151     "EGL_BITMAP_PIXEL_ALPHA_OFFSET_KHR",        # 0x30CC
152     "EGL_BITMAP_PIXEL_LUMINANCE_OFFSET_KHR",    # 0x30CD
153     # EGL_KHR_lock_surface2
154     "EGL_BITMAP_PIXEL_SIZE_KHR",                # 0x3110
155
156     # EGL_HI_clientpixmap
157     "EGL_CLIENT_PIXMAP_POINTER_HI",             # 0x8F74
158 ])
159
160 EGLContextAttrib = FakeEnum(EGLint, [
161     "EGL_CONTEXT_CLIENT_TYPE",      # 0x3097
162     "EGL_CONTEXT_CLIENT_VERSION",   # 0x3098
163
164     # EGL_IMG_context_priority
165     "EGL_CONTEXT_PRIORITY_LEVEL_IMG",   # 0x3100
166
167     "EGL_NONE",
168 ])
169
170 EGLAPI = FakeEnum(EGLenum, [
171     "EGL_OPENGL_ES_API",            # 0x30A0
172     "EGL_OPENVG_API",               # 0x30A1
173     "EGL_OPENGL_API",               # 0x30A2
174 ])
175
176 EGLClientBufferType = FakeEnum(EGLenum, [
177     "EGL_OPENVG_IMAGE",             # 0x3096
178 ])
179
180 EGLBufferType = FakeEnum(EGLint, [
181     "EGL_BACK_BUFFER",              # 0x3084
182     "EGL_SINGLE_BUFFER",            # 0x3085
183 ])
184
185 EGLEngine = FakeEnum(EGLint, [
186     "EGL_CORE_NATIVE_ENGINE",       # 0x305B
187 ])
188
189 # EGL_KHR_lock_surface
190 EGLLockSurfaceAttrib = FakeEnum(EGLint, [
191     "EGL_MAP_PRESERVE_PIXELS_KHR",  # 0x30C4
192     "EGL_LOCK_USAGE_HINT_KHR",      # 0x30C5
193 ])
194
195 # EGL_KHR_image_base
196 EGLImageKHR = Opaque("EGLImageKHR")
197
198 EGLImageKHRAttrib = FakeEnum(EGLint, [
199     "EGL_IMAGE_PRESERVED_KHR",      # 0x30D2
200
201     # EGL_KHR_gl_*_image
202     "EGL_GL_TEXTURE_LEVEL_KHR",     # 0x30BC
203     "EGL_GL_TEXTURE_ZOFFSET_KHR",   # 0x30BD
204
205     "EGL_NONE",
206 ])
207
208 EGLImageKHRTarget = FakeEnum(EGLenum, [
209     # EGL_KHR_image_pixmap
210     "EGL_NATIVE_PIXMAP_KHR",                    # 0x30B0
211
212     # EGL_KHR_vg_parent_image
213     "EGL_VG_PARENT_IMAGE_KHR",                  # 0x30BA
214
215     # EGL_KHR_gl_*_image
216     "EGL_GL_TEXTURE_2D_KHR",                    # 0x30B1
217     "EGL_GL_TEXTURE_3D_KHR",                    # 0x30B2
218     "EGL_GL_TEXTURE_CUBE_MAP_POSITIVE_X_KHR",   # 0x30B3
219     "EGL_GL_TEXTURE_CUBE_MAP_NEGATIVE_X_KHR",   # 0x30B4
220     "EGL_GL_TEXTURE_CUBE_MAP_POSITIVE_Y_KHR",   # 0x30B5
221     "EGL_GL_TEXTURE_CUBE_MAP_NEGATIVE_Y_KHR",   # 0x30B6
222     "EGL_GL_TEXTURE_CUBE_MAP_POSITIVE_Z_KHR",   # 0x30B7
223     "EGL_GL_TEXTURE_CUBE_MAP_NEGATIVE_Z_KHR",   # 0x30B8
224     "EGL_GL_RENDERBUFFER_KHR",                  # 0x30B9
225
226     # EGL_MESA_drm_image
227     "EGL_DRM_BUFFER_MESA",                      # 0x31D3
228 ])
229
230 # EGL_KHR_reusable_sync
231 EGLSyncKHR = Opaque("EGLSyncKHR")
232 EGLTimeKHR = Alias("EGLTimeKHR", UInt64)
233
234 EGLSyncKHRType = FakeEnum(EGLenum, [
235     "EGL_SYNC_REUSABLE_KHR",        # 0x30FA
236
237     # EGL_KHR_fence_sync
238     "EGL_SYNC_FENCE_KHR",           # 0x30F9
239 ])
240
241 EGLSyncKHRAttrib = FakeEnum(EGLint, [
242     "EGL_SYNC_STATUS_KHR",          # 0x30F1
243     "EGL_SYNC_TYPE_KHR",            # 0x30F7
244
245     # EGL_KHR_fence_sync
246     "EGL_SYNC_CONDITION_KHR",       # 0x30F8
247
248     "EGL_NONE",
249 ])
250
251 EGLSyncKHRMode = FakeEnum(EGLenum, [
252     "EGL_SIGNALED_KHR",             # 0x30F2
253     "EGL_UNSIGNALED_KHR",           # 0x30F3
254 ])
255
256 # EGL_NV_sync
257 EGLSyncNV = Alias("EGLSyncNV", EGLSyncKHR)
258 EGLTimeNV = Alias("EGLTimeKHR", EGLTimeKHR)
259
260 # EGL_HI_clientpixmap
261 EGLClientPixmapHI = Struct("struct EGLClientPixmapHI", [
262   (OpaquePointer(Void), "pData"),
263   (EGLint, "iWidth"),
264   (EGLint, "iHeight"),
265   (EGLint, "iStride"),
266 ])
267
268 # EGL_MESA_drm_image
269 EGLCreateDRMImageAttrib = FakeEnum(EGLint, [
270     "EGL_DRM_BUFFER_FORMAT_MESA",   # 0x31D1
271     "EGL_DRM_BUFFER_USE_MESA",      # 0x31D2
272     "EGL_DRM_BUFFER_STRIDE_MESA",   # 0x31D4
273
274     "EGL_WIDTH",
275     "EGL_HEIGHT",
276     "EGL_NONE",
277 ])
278
279 eglapi = API("EGL")
280
281 PROC = Opaque("__eglMustCastToProperFunctionPointerType")
282
283 eglapi.add_functions([
284     # EGL 1.4
285     Function(EGLError, "eglGetError", [], sideeffects=False),
286
287     Function(EGLDisplay, "eglGetDisplay", [(EGLNativeDisplayType, "display_id")]),
288     Function(EGLBoolean, "eglInitialize", [(EGLDisplay, "dpy"), Out(Pointer(EGLint), "major"), Out(Pointer(EGLint), "minor")]),
289     Function(EGLBoolean, "eglTerminate", [(EGLDisplay, "dpy")]),
290
291     Function(Const(String("char *")), "eglQueryString", [(EGLDisplay, "dpy"), (EGLName, "name")], sideeffects=False),
292
293     Function(EGLBoolean, "eglGetConfigs", [(EGLDisplay, "dpy"), (Array(EGLConfig, "config_size"), "configs"), (EGLint, "config_size"), Out(Pointer(EGLint), "num_config")]),
294     Function(EGLBoolean, "eglChooseConfig", [(EGLDisplay, "dpy"), (Array(Const(EGLConfigAttrib), "__AttribList_size(attrib_list, EGL_NONE)"), "attrib_list"), (Array(EGLConfig, "config_size"), "configs"), (EGLint, "config_size"), Out(Pointer(EGLint), "num_config")]),
295     Function(EGLBoolean, "eglGetConfigAttrib", [(EGLDisplay, "dpy"), (EGLConfig, "config"), (EGLConfigAttrib, "attribute"), Out(Pointer(EGLint), "value")], sideeffects=False),
296
297     Function(EGLSurface, "eglCreateWindowSurface", [(EGLDisplay, "dpy"), (EGLConfig, "config"), (EGLNativeWindowType, "win"), (Array(Const(EGLSurfaceAttrib), "__AttribList_size(attrib_list, EGL_NONE)"), "attrib_list")]),
298     Function(EGLSurface, "eglCreatePbufferSurface", [(EGLDisplay, "dpy"), (EGLConfig, "config"), (Array(Const(EGLSurfaceAttrib), "__AttribList_size(attrib_list, EGL_NONE)"), "attrib_list")]),
299     Function(EGLSurface, "eglCreatePixmapSurface", [(EGLDisplay, "dpy"), (EGLConfig, "config"), (EGLNativePixmapType, "pixmap"), (Array(Const(EGLSurfaceAttrib), "__AttribList_size(attrib_list, EGL_NONE)"), "attrib_list")]),
300     Function(EGLBoolean, "eglDestroySurface", [(EGLDisplay, "dpy"), (EGLSurface, "surface")]),
301     Function(EGLBoolean, "eglQuerySurface", [(EGLDisplay, "dpy"), (EGLSurface, "surface"), (EGLSurfaceAttrib, "attribute"), Out(Pointer(EGLint), "value")], sideeffects=False),
302
303     Function(EGLBoolean, "eglBindAPI", [(EGLAPI, "api")]),
304     Function(EGLAPI, "eglQueryAPI", [], sideeffects=False),
305
306     Function(EGLBoolean, "eglWaitClient", []),
307
308     Function(EGLBoolean, "eglReleaseThread", []),
309
310     Function(EGLSurface, "eglCreatePbufferFromClientBuffer", [(EGLDisplay, "dpy"), (EGLClientBufferType, "buftype"), (EGLClientBuffer, "buffer"), (EGLConfig, "config"), (Array(Const(EGLSurfaceAttrib), "__AttribList_size(attrib_list, EGL_NONE)"), "attrib_list")]),
311
312     Function(EGLBoolean, "eglSurfaceAttrib", [(EGLDisplay, "dpy"), (EGLSurface, "surface"), (EGLSurfaceAttrib, "attribute"), (EGLint, "value")]),
313     Function(EGLBoolean, "eglBindTexImage", [(EGLDisplay, "dpy"), (EGLSurface, "surface"), (EGLBufferType, "buffer")]),
314     Function(EGLBoolean, "eglReleaseTexImage", [(EGLDisplay, "dpy"), (EGLSurface, "surface"), (EGLBufferType, "buffer")]),
315
316     Function(EGLBoolean, "eglSwapInterval", [(EGLDisplay, "dpy"), (EGLint, "interval")]),
317
318     Function(EGLContext, "eglCreateContext", [(EGLDisplay, "dpy"), (EGLConfig, "config"), (EGLContext, "share_context"), (Array(Const(EGLContextAttrib), "__AttribList_size(attrib_list, EGL_NONE)"), "attrib_list")]),
319     Function(EGLBoolean, "eglDestroyContext", [(EGLDisplay, "dpy"), (EGLContext, "ctx")]),
320     Function(EGLBoolean, "eglMakeCurrent", [(EGLDisplay, "dpy"), (EGLSurface, "draw"), (EGLSurface, "read"), (EGLContext, "ctx")]),
321
322     Function(EGLContext, "eglGetCurrentContext", [], sideeffects=False),
323     Function(EGLSurface, "eglGetCurrentSurface", [(EGLBufferType, "readdraw")], sideeffects=False),
324     Function(EGLDisplay, "eglGetCurrentDisplay", [], sideeffects=False),
325
326     Function(EGLBoolean, "eglQueryContext", [(EGLDisplay, "dpy"), (EGLContext, "ctx"), (EGLContextAttrib, "attribute"), Out(Pointer(EGLint), "value")], sideeffects=False),
327
328     Function(EGLBoolean, "eglWaitGL", []),
329     Function(EGLBoolean, "eglWaitNative", [(EGLEngine, "engine")]),
330     Function(EGLBoolean, "eglSwapBuffers", [(EGLDisplay, "dpy"), (EGLSurface, "surface")]),
331     Function(EGLBoolean, "eglCopyBuffers", [(EGLDisplay, "dpy"), (EGLSurface, "surface"), (EGLNativePixmapType, "target")]),
332
333     Function(PROC, "eglGetProcAddress", [(Const(CString), "procname")]),
334
335     # EGL_KHR_lock_surface
336     Function(EGLBoolean, "eglLockSurfaceKHR", [(EGLDisplay, "display"), (EGLSurface, "surface"), (Array(Const(EGLLockSurfaceAttrib), "__AttribList_size(attrib_list, EGL_NONE)"), "attrib_list")]),
337     Function(EGLBoolean, "eglUnlockSurfaceKHR", [(EGLDisplay, "display"), (EGLSurface, "surface")]),
338
339     # EGL_KHR_image_base
340     Function(EGLImageKHR, "eglCreateImageKHR", [(EGLDisplay, "dpy"), (EGLContext, "ctx"), (EGLImageKHRTarget, "target"), (EGLClientBuffer, "buffer"), (Array(Const(EGLImageKHRAttrib), "__AttribList_size(attrib_list, EGL_NONE)"), "attrib_list")]),
341     Function(EGLBoolean, "eglDestroyImageKHR", [(EGLDisplay, "dpy"), (EGLImageKHR, "image")]),
342
343     # EGL_KHR_reusable_sync
344     Function(EGLSyncKHR, "eglCreateSyncKHR", [(EGLDisplay, "dpy"), (EGLSyncKHRType, "type"), (Array(Const(EGLSyncKHRAttrib), "__AttribList_size(attrib_list, EGL_NONE)"), "attrib_list")]),
345     Function(EGLBoolean, "eglDestroySyncKHR", [(EGLDisplay, "dpy"), (EGLSyncKHR, "sync")]),
346     Function(EGLint, "eglClientWaitSyncKHR", [(EGLDisplay, "dpy"), (EGLSyncKHR, "sync"), (EGLint, "flags"), (EGLTimeKHR, "timeout")]),
347     Function(EGLBoolean, "eglSignalSyncKHR", [(EGLDisplay, "dpy"), (EGLSyncKHR, "sync"), (EGLSyncKHRMode, "mode")]),
348     Function(EGLBoolean, "eglGetSyncAttribKHR", [(EGLDisplay, "dpy"), (EGLSyncKHR, "sync"), (EGLSyncKHRAttrib, "attribute"), Out(Pointer(EGLint), "value")], sideeffects=False),
349
350     # EGL_NV_sync
351     Function(EGLSyncNV, "eglCreateFenceSyncNV", [(EGLDisplay, "dpy"), (EGLenum, "condition"), (Array(Const(EGLint), "__AttribList_size(attrib_list, EGL_NONE)"), "attrib_list")]),
352     Function(EGLBoolean, "eglDestroySyncNV", [(EGLSyncNV, "sync")]),
353     Function(EGLBoolean, "eglFenceNV", [(EGLSyncNV, "sync")]),
354     Function(EGLint, "eglClientWaitSyncNV", [(EGLSyncNV, "sync"), (EGLint, "flags"), (EGLTimeNV, "timeout")]),
355     Function(EGLBoolean, "eglSignalSyncNV", [(EGLSyncNV, "sync"), (EGLenum, "mode")]),
356     Function(EGLBoolean, "eglGetSyncAttribNV", [(EGLSyncNV, "sync"), (EGLint, "attribute"), Out(Pointer(EGLint), "value")], sideeffects=False),
357
358     # EGL_HI_clientpixmap
359     Function(EGLSurface, "eglCreatePixmapSurfaceHI", [(EGLDisplay, "dpy"), (EGLConfig, "config"), (Pointer(EGLClientPixmapHI), "pixmap")]),
360
361     # EGL_MESA_drm_image
362     Function(EGLImageKHR, "eglCreateDRMImageMESA", [(EGLDisplay, "dpy"), (Array(Const(EGLCreateDRMImageAttrib), "__AttribList_size(attrib_list, EGL_NONE)"), "attrib_list")]),
363     Function(EGLBoolean, "eglExportDRMImageMESA", [(EGLDisplay, "dpy"), (EGLImageKHR, "image"), Out(Pointer(EGLint), "name"), Out(Pointer(EGLint), "handle"), Out(Pointer(EGLint), "stride")]),
364 ])