git.cworth.org Git - apitrace/blob - 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 from gltypes import *
  31 from eglenum import *
  32
  33 EGLNativeDisplayType = Opaque("EGLNativeDisplayType")
  34 EGLNativeWindowType = Opaque("EGLNativeWindowType")
  35 EGLNativePixmapType = Opaque("EGLNativePixmapType")
  36
  37 EGLDisplay = Opaque("EGLDisplay")
  38 EGLConfig = Opaque("EGLConfig")
  39 EGLContext = Opaque("EGLContext")
  40 EGLSurface = Opaque("EGLSurface")
  41
  42 EGLClientBuffer = Opaque("EGLClientBuffer")
  43
  44 EGLBoolean = Enum("EGLBoolean", [
  45     "EGL_FALSE",
  46     "EGL_TRUE",
  47 ])
  48
  49 EGLint = Alias("EGLint", Int32)
  50
  51 # an alias of EGLenum
  52 EGLint_enum = Alias("EGLint", EGLenum)
  53 EGLattrib = EGLint_enum
  54
  55 # EGL_KHR_image_base
  56 EGLImageKHR = Opaque("EGLImageKHR")
  57
  58 # EGL_KHR_reusable_sync
  59 EGLSyncKHR = Opaque("EGLSyncKHR")
  60 EGLTimeKHR = Alias("EGLTimeKHR", UInt64)
  61
  62 # EGL_NV_sync
  63 EGLSyncNV = Alias("EGLSyncNV", EGLSyncKHR)
  64 EGLTimeNV = Alias("EGLTimeNV", EGLTimeKHR)
  65
  66 # EGL_HI_clientpixmap
  67 EGLClientPixmapHI = Struct("struct EGLClientPixmapHI", [
  68   (OpaquePointer(Void), "pData"),
  69   (EGLint, "iWidth"),
  70   (EGLint, "iHeight"),
  71   (EGLint, "iStride"),
  72 ])
  73
  74 # EGL_NV_system_time
  75 EGLuint64NV = Alias("EGLuint64NV", UInt64)
  76
  77 eglapi = Module("EGL")
  78
  79 EGLSurfaceFlags = Flags(Int, [
  80     'EGL_MULTISAMPLE_RESOLVE_BOX_BIT',
  81     'EGL_PBUFFER_BIT',
  82     'EGL_PIXMAP_BIT',
  83     'EGL_SWAP_BEHAVIOR_PRESERVED_BIT',
  84     'EGL_VG_ALPHA_FORMAT_PRE_BIT',
  85     'EGL_VG_COLORSPACE_LINEAR_BIT',
  86     'EGL_WINDOW_BIT'
  87 ])
  88
  89 EGLConformantFlags = Flags(Int, ['EGL_OPENGL_BIT','EGL_OPENGL_ES_BIT', 'EGL_OPENGL_ES2_BIT', 'EGL_OPENVG_BIT'])
  90
  91 EGLVGAlphaFormat = FakeEnum(Int, ['EGL_VG_ALPHA_FORMAT_NONPRE', 'EGL_VG_ALPHA_FORMAT_PRE'])
  92 EGLVGColorspace = FakeEnum(Int, ['EGL_VG_COLORSPACE_sRGB', 'EGL_VG_COLORSPACE_LINEAR'])
  93 EGLTextureFormat = FakeEnum(Int, ['EGL_NO_TEXTURE', 'EGL_TEXTURE_RGB', 'EGL_TEXTURE_RGBA'])
  94 EGLTextureTarget = FakeEnum(Int, ['EGL_TEXTURE_2D', 'EGL_NO_TEXTURE'])
  95
  96 def EGLAttribArray(values):
  97     return AttribArray(Const(EGLint_enum), values, terminator = 'EGL_NONE')
  98
  99 EGLConfigAttribs = EGLAttribArray([
 100     ('EGL_ALPHA_MASK_SIZE', UInt),
 101     ('EGL_ALPHA_SIZE', UInt),
 102     ('EGL_BIND_TO_TEXTURE_RGB', EGLBoolean),
 103     ('EGL_BIND_TO_TEXTURE_RGBA', EGLBoolean),
 104     ('EGL_BLUE_SIZE', UInt),
 105     ('EGL_BUFFER_SIZE', UInt),
 106     ('EGL_COLOR_BUFFER_TYPE', FakeEnum(Int, ['EGL_RGB_BUFFER', 'EGL_LUMINANCE_BUFFER'])),
 107     ('EGL_CONFIG_CAVEAT', FakeEnum(Int, ['EGL_DONT_CARE', 'EGL_NONE', 'EGL_SLOW_CONFIG', 'EGL_NON_CONFORMANT_CONFIG'])),
 108     ('EGL_CONFIG_ID', Int),
 109     ('EGL_CONFORMANT', EGLConformantFlags),
 110     ('EGL_DEPTH_SIZE', Int),
 111     ('EGL_GREEN_SIZE', UInt),
 112     ('EGL_LEVEL', Int),
 113     ('EGL_LUMINANCE_SIZE', UInt),
 114     ('EGL_MATCH_NATIVE_PIXMAP', Int),
 115     ('EGL_NATIVE_RENDERABLE', FakeEnum(Int, ['EGL_DONT_CARE', 'EGL_TRUE', 'EGL_FALSE'])),
 116     ('EGL_MAX_SWAP_INTERVAL', Int),
 117     ('EGL_MIN_SWAP_INTERVAL', Int),
 118     ('EGL_RED_SIZE', UInt),
 119     ('EGL_SAMPLE_BUFFERS', Int),
 120     ('EGL_SAMPLES', Int),
 121     ('EGL_STENCIL_SIZE', UInt),
 122     ('EGL_RENDERABLE_TYPE', EGLConformantFlags),
 123     ('EGL_SURFACE_TYPE', EGLSurfaceFlags),
 124     ('EGL_TRANSPARENT_TYPE', FakeEnum(Int, ['EGL_NONE', 'EGL_TRANSPARENT_RGB'])),
 125     ('EGL_TRANSPARENT_RED_VALUE', Int),
 126     ('EGL_TRANSPARENT_GREEN_VALUE', Int),
 127     ('EGL_TRANSPARENT_BLUE_VALUE ', Int)
 128 ])
 129
 130 EGLWindowsSurfaceAttribs = EGLAttribArray([
 131     ('EGL_RENDER_BUFFER', FakeEnum(Int, ['EGL_SINGLE_BUFFER', 'EGL_BACK_BUFFER'])),
 132     ('EGL_VG_ALPHA_FORMAT', EGLVGAlphaFormat),
 133     ('EGL_VG_COLORSPACE', EGLVGColorspace)])
 134
 135 EGLPixmapSurfaceAttribs = EGLAttribArray([
 136     ('EGL_VG_ALPHA_FORMAT', EGLVGAlphaFormat),
 137     ('EGL_VG_COLORSPACE', EGLVGColorspace)
 138 ])
 139
 140 EGLPbufferAttribs = EGLAttribArray([
 141     ('EGL_HEIGHT', Int),
 142     ('EGL_LARGEST_PBUFFER', EGLBoolean),
 143     ('EGL_MIPMAP_TEXTURE', UInt),
 144     ('EGL_TEXTURE_FORMAT', EGLTextureFormat),
 145     ('EGL_TEXTURE_TARGET', EGLTextureTarget),
 146     ('EGL_VG_ALPHA_FORMAT', EGLVGAlphaFormat),
 147     ('EGL_VG_COLORSPACE', EGLVGColorspace),
 148     ('EGL_WIDTH', Int)
 149 ])
 150
 151 EGLPbufferFromClientBufferAttribs = EGLAttribArray([
 152     ('EGL_MIPMAP_TEXTURE', EGLBoolean),
 153     ('EGL_TEXTURE_FORMAT', EGLTextureFormat),
 154     ('EGL_TEXTURE_TARGET', EGLTextureTarget)
 155 ])
 156
 157 EGLDrmImageMesaAttribs = EGLAttribArray([
 158     ('EGL_DRM_BUFFER_FORMAT_MESA', FakeEnum(Int, ['EGL_DRM_BUFFER_FORMAT_ARGB32_MESA'])),
 159     ('EGL_DRM_BUFFER_USE_MESA', Flags(Int, ['EGL_DRM_BUFFER_USE_SCANOUT_MESA', 'EGL_DRM_BUFFER_USE_SHARE_MESA']))
 160 ])
 161
 162 EGLLockSurfaceKHRAttribs = EGLAttribArray([
 163     ('EGL_MAP_PRESERVE_PIXELS_KHR', EGLBoolean),
 164     ('EGL_LOCK_USAGE_HINT_KHR', Flags(Int, ['EGL_READ_SURFACE_BIT_KHR', 'EGL_WRITE_SURFACE_BIT_KHR']))
 165 ])
 166
 167 EGLFenceSyncNVAttribs = EGLAttribArray([
 168     ('EGL_SYNC_STATUS_NV', Flags(Int, ['EGL_SIGNALED_NV', 'EGL_UNSIGNALED_NV']))
 169 ])
 170
 171 EGLProc = Opaque("__eglMustCastToProperFunctionPointerType")
 172
 173 def GlFunction(*args, **kwargs):
 174     kwargs.setdefault('call', 'GL_APIENTRY')
 175     return Function(*args, **kwargs)
 176
 177 eglapi.addFunctions([
 178     # EGL 1.4
 179     Function(EGLint_enum, "eglGetError", [], sideeffects=False),
 180
 181     Function(EGLDisplay, "eglGetDisplay", [(EGLNativeDisplayType, "display_id")]),
 182     Function(EGLBoolean, "eglInitialize", [(EGLDisplay, "dpy"), Out(Pointer(EGLint), "major"), Out(Pointer(EGLint), "minor")]),
 183     Function(EGLBoolean, "eglTerminate", [(EGLDisplay, "dpy")]),
 184
 185     Function(ConstCString, "eglQueryString", [(EGLDisplay, "dpy"), (EGLint_enum, "name")], sideeffects=False),
 186
 187     Function(EGLBoolean, "eglGetConfigs", [(EGLDisplay, "dpy"), (Array(EGLConfig, "config_size"), "configs"), (EGLint, "config_size"), Out(Pointer(EGLint), "num_config")]),
 188     Function(EGLBoolean, "eglChooseConfig", [(EGLDisplay, "dpy"), (EGLConfigAttribs, "attrib_list"), (Array(EGLConfig, "config_size"), "configs"), (EGLint, "config_size"), Out(Pointer(EGLint), "num_config")]),
 189     Function(EGLBoolean, "eglGetConfigAttrib", [(EGLDisplay, "dpy"), (EGLConfig, "config"), (EGLattrib, "attribute"), Out(Pointer(EGLint), "value")], sideeffects=False),
 190
 191     Function(EGLSurface, "eglCreateWindowSurface", [(EGLDisplay, "dpy"), (EGLConfig, "config"), (EGLNativeWindowType, "win"), (EGLWindowsSurfaceAttribs, "attrib_list")]),
 192     Function(EGLSurface, "eglCreatePbufferSurface", [(EGLDisplay, "dpy"), (EGLConfig, "config"), (EGLPbufferAttribs, "attrib_list")]),
 193     Function(EGLSurface, "eglCreatePixmapSurface", [(EGLDisplay, "dpy"), (EGLConfig, "config"), (EGLNativePixmapType, "pixmap"), (EGLPixmapSurfaceAttribs, "attrib_list")]),
 194     Function(EGLBoolean, "eglDestroySurface", [(EGLDisplay, "dpy"), (EGLSurface, "surface")]),
 195     Function(EGLBoolean, "eglQuerySurface", [(EGLDisplay, "dpy"), (EGLSurface, "surface"), (EGLattrib, "attribute"), Out(Pointer(EGLint), "value")], sideeffects=False),
 196
 197     Function(EGLBoolean, "eglBindAPI", [(EGLenum, "api")]),
 198     Function(EGLenum, "eglQueryAPI", [], sideeffects=False),
 199
 200     Function(EGLBoolean, "eglWaitClient", []),
 201
 202     Function(EGLBoolean, "eglReleaseThread", []),
 203
 204     Function(EGLSurface, "eglCreatePbufferFromClientBuffer", [(EGLDisplay, "dpy"), (EGLenum, "buftype"), (EGLClientBuffer, "buffer"), (EGLConfig, "config"), (EGLPbufferFromClientBufferAttribs, "attrib_list")]),
 205
 206     Function(EGLBoolean, "eglSurfaceAttrib", [(EGLDisplay, "dpy"), (EGLSurface, "surface"), (EGLattrib, "attribute"), (EGLint, "value")]),
 207     Function(EGLBoolean, "eglBindTexImage", [(EGLDisplay, "dpy"), (EGLSurface, "surface"), (EGLattrib, "buffer")]),
 208     Function(EGLBoolean, "eglReleaseTexImage", [(EGLDisplay, "dpy"), (EGLSurface, "surface"), (EGLattrib, "buffer")]),
 209
 210     Function(EGLBoolean, "eglSwapInterval", [(EGLDisplay, "dpy"), (EGLint, "interval")]),
 211
 212     Function(EGLContext, "eglCreateContext", [(EGLDisplay, "dpy"), (EGLConfig, "config"), (EGLContext, "share_context"), (EGLAttribArray([('EGL_CONTEXT_CLIENT_VERSION', Int)]), "attrib_list")]),
 213     Function(EGLBoolean, "eglDestroyContext", [(EGLDisplay, "dpy"), (EGLContext, "ctx")]),
 214     Function(EGLBoolean, "eglMakeCurrent", [(EGLDisplay, "dpy"), (EGLSurface, "draw"), (EGLSurface, "read"), (EGLContext, "ctx")]),
 215
 216     Function(EGLContext, "eglGetCurrentContext", [], sideeffects=False),
 217     Function(EGLSurface, "eglGetCurrentSurface", [(EGLattrib, "readdraw")], sideeffects=False),
 218     Function(EGLDisplay, "eglGetCurrentDisplay", [], sideeffects=False),
 219
 220     Function(EGLBoolean, "eglQueryContext", [(EGLDisplay, "dpy"), (EGLContext, "ctx"), (EGLattrib, "attribute"), Out(Pointer(EGLint), "value")], sideeffects=False),
 221
 222     Function(EGLBoolean, "eglWaitGL", []),
 223     Function(EGLBoolean, "eglWaitNative", [(EGLattrib, "engine")]),
 224     Function(EGLBoolean, "eglSwapBuffers", [(EGLDisplay, "dpy"), (EGLSurface, "surface")]),
 225     Function(EGLBoolean, "eglCopyBuffers", [(EGLDisplay, "dpy"), (EGLSurface, "surface"), (EGLNativePixmapType, "target")]),
 226
 227     Function(EGLProc, "eglGetProcAddress", [(ConstCString, "procname")]),
 228
 229     # EGL_KHR_lock_surface
 230     # EGL_KHR_lock_surface2
 231     Function(EGLBoolean, "eglLockSurfaceKHR", [(EGLDisplay, "display"), (EGLSurface, "surface"), (EGLLockSurfaceKHRAttribs, "attrib_list")]),
 232     Function(EGLBoolean, "eglUnlockSurfaceKHR", [(EGLDisplay, "display"), (EGLSurface, "surface")]),
 233
 234     # EGL_KHR_image_base
 235     Function(EGLImageKHR, "eglCreateImageKHR", [(EGLDisplay, "dpy"), (EGLContext, "ctx"), (EGLenum, "target"), (EGLClientBuffer, "buffer"), (EGLAttribArray([('EGL_IMAGE_PRESERVED_KHR', EGLBoolean)]), "attrib_list")]),
 236     Function(EGLBoolean, "eglDestroyImageKHR", [(EGLDisplay, "dpy"), (EGLImageKHR, "image")]),
 237
 238     # EGL_KHR_fence_sync
 239     # EGL_KHR_reusable_sync
 240     Function(EGLSyncKHR, "eglCreateSyncKHR", [(EGLDisplay, "dpy"), (EGLenum, "type"), (EGLAttribArray([]), "attrib_list")]),
 241     Function(EGLBoolean, "eglDestroySyncKHR", [(EGLDisplay, "dpy"), (EGLSyncKHR, "sync")]),
 242     Function(EGLint, "eglClientWaitSyncKHR", [(EGLDisplay, "dpy"), (EGLSyncKHR, "sync"), (EGLint, "flags"), (EGLTimeKHR, "timeout")]),
 243     Function(EGLBoolean, "eglSignalSyncKHR", [(EGLDisplay, "dpy"), (EGLSyncKHR, "sync"), (EGLenum, "mode")]),
 244     Function(EGLBoolean, "eglGetSyncAttribKHR", [(EGLDisplay, "dpy"), (EGLSyncKHR, "sync"), (EGLattrib, "attribute"), Out(Pointer(EGLint), "value")], sideeffects=False),
 245
 246     # EGL_NV_sync
 247     Function(EGLSyncNV, "eglCreateFenceSyncNV", [(EGLDisplay, "dpy"), (EGLenum, "condition"), (EGLFenceSyncNVAttribs, "attrib_list")]),
 248     Function(EGLBoolean, "eglDestroySyncNV", [(EGLSyncNV, "sync")]),
 249     Function(EGLBoolean, "eglFenceNV", [(EGLSyncNV, "sync")]),
 250     Function(EGLint, "eglClientWaitSyncNV", [(EGLSyncNV, "sync"), (EGLint, "flags"), (EGLTimeNV, "timeout")]),
 251     Function(EGLBoolean, "eglSignalSyncNV", [(EGLSyncNV, "sync"), (EGLenum, "mode")]),
 252     Function(EGLBoolean, "eglGetSyncAttribNV", [(EGLSyncNV, "sync"), (EGLattrib, "attribute"), Out(Pointer(EGLint), "value")], sideeffects=False),
 253
 254     # EGL_HI_clientpixmap
 255     Function(EGLSurface, "eglCreatePixmapSurfaceHI", [(EGLDisplay, "dpy"), (EGLConfig, "config"), (Pointer(EGLClientPixmapHI), "pixmap")]),
 256
 257     # EGL_MESA_drm_image
 258     Function(EGLImageKHR, "eglCreateDRMImageMESA", [(EGLDisplay, "dpy"), (EGLDrmImageMesaAttribs, "attrib_list")]),
 259     Function(EGLBoolean, "eglExportDRMImageMESA", [(EGLDisplay, "dpy"), (EGLImageKHR, "image"), Out(Pointer(EGLint), "name"), Out(Pointer(EGLint), "handle"), Out(Pointer(EGLint), "stride")]),
 260
 261     # EGL_NV_post_sub_buffer
 262     Function(EGLBoolean, "eglPostSubBufferNV", [(EGLDisplay, "dpy"), (EGLSurface, "surface"), (EGLint, "x"), (EGLint, "y"), (EGLint, "width"), (EGLint, "height")]),
 263
 264     # EGL_ANGLE_query_surface_pointer
 265     Function(EGLBoolean, "eglQuerySurfacePointerANGLE", [(EGLDisplay, "dpy"), (EGLSurface, "surface"), (EGLattrib, "attribute"), Out(Pointer(OpaquePointer(Void)), "value")], sideeffects=False),
 266
 267     # EGL_NV_system_time
 268     Function(EGLuint64NV, "eglGetSystemTimeFrequencyNV", [], sideeffects=False),
 269     Function(EGLuint64NV, "eglGetSystemTimeNV", [], sideeffects=False),
 270
 271     # GL_OES_EGL_image
 272     GlFunction(Void, "glEGLImageTargetTexture2DOES", [(GLenum, "target"), (EGLImageKHR, "image")]),
 273     GlFunction(Void, "glEGLImageTargetRenderbufferStorageOES", [(GLenum, "target"), (EGLImageKHR, "image")]),
 274 ])