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