src/egl/main/eglapi.h

   1 /**************************************************************************
   2  *
   3  * Copyright 2008 VMware, Inc.
   4  * Copyright 2009-2010 Chia-I Wu <olvaffe@gmail.com>
   5  * Copyright 2010-2011 LunarG, Inc.
   6  * All Rights Reserved.
   7  *
   8  * Permission is hereby granted, free of charge, to any person obtaining a
   9  * copy of this software and associated documentation files (the
  10  * "Software"), to deal in the Software without restriction, including
  11  * without limitation the rights to use, copy, modify, merge, publish,
  12  * distribute, sub license, and/or sell copies of the Software, and to
  13  * permit persons to whom the Software is furnished to do so, subject to
  14  * the following conditions:
  15  *
  16  * The above copyright notice and this permission notice (including the
  17  * next paragraph) shall be included in all copies or substantial portions
  18  * of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  21  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  23  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  24  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  25  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  26  * DEALINGS IN THE SOFTWARE.
  27  *
  28  **************************************************************************/
  29
  30
  31 #ifndef EGLAPI_INCLUDED
  32 #define EGLAPI_INCLUDED
  33
  34 /**
  35  * A generic function ptr type
  36  */
  37 typedef void (*_EGLProc)(void);
  38
  39
  40 /**
  41  * Typedefs for all EGL API entrypoint functions.
  42  */
  43
  44 /* driver funcs */
  45 typedef EGLBoolean (*Initialize_t)(_EGLDriver *, _EGLDisplay *dpy);
  46 typedef EGLBoolean (*Terminate_t)(_EGLDriver *, _EGLDisplay *dpy);
  47
  48 /* config funcs */
  49 typedef EGLBoolean (*GetConfigs_t)(_EGLDriver *drv, _EGLDisplay *dpy, EGLConfig *configs, EGLint config_size, EGLint *num_config);
  50 typedef EGLBoolean (*ChooseConfig_t)(_EGLDriver *drv, _EGLDisplay *dpy, const EGLint *attrib_list, EGLConfig *configs, EGLint config_size, EGLint *num_config);
  51 typedef EGLBoolean (*GetConfigAttrib_t)(_EGLDriver *drv, _EGLDisplay *dpy, _EGLConfig *config, EGLint attribute, EGLint *value);
  52
  53 /* context funcs */
  54 typedef _EGLContext *(*CreateContext_t)(_EGLDriver *drv, _EGLDisplay *dpy, _EGLConfig *config, _EGLContext *share_list, const EGLint *attrib_list);
  55 typedef EGLBoolean (*DestroyContext_t)(_EGLDriver *drv, _EGLDisplay *dpy, _EGLContext *ctx);
  56 /* this is the only function (other than Initialize) that may be called with an uninitialized display */
  57 typedef EGLBoolean (*MakeCurrent_t)(_EGLDriver *drv, _EGLDisplay *dpy, _EGLSurface *draw, _EGLSurface *read, _EGLContext *ctx);
  58 typedef EGLBoolean (*QueryContext_t)(_EGLDriver *drv, _EGLDisplay *dpy, _EGLContext *ctx, EGLint attribute, EGLint *value);
  59
  60 /* surface funcs */
  61 typedef _EGLSurface *(*CreateWindowSurface_t)(_EGLDriver *drv, _EGLDisplay *dpy, _EGLConfig *config, void *native_window, const EGLint *attrib_list);
  62 typedef _EGLSurface *(*CreatePixmapSurface_t)(_EGLDriver *drv, _EGLDisplay *dpy, _EGLConfig *config, void *native_pixmap, const EGLint *attrib_list);
  63 typedef _EGLSurface *(*CreatePbufferSurface_t)(_EGLDriver *drv, _EGLDisplay *dpy, _EGLConfig *config, const EGLint *attrib_list);
  64 typedef EGLBoolean (*DestroySurface_t)(_EGLDriver *drv, _EGLDisplay *dpy, _EGLSurface *surface);
  65 typedef EGLBoolean (*QuerySurface_t)(_EGLDriver *drv, _EGLDisplay *dpy, _EGLSurface *surface, EGLint attribute, EGLint *value);
  66 typedef EGLBoolean (*SurfaceAttrib_t)(_EGLDriver *drv, _EGLDisplay *dpy, _EGLSurface *surface, EGLint attribute, EGLint value);
  67 typedef EGLBoolean (*BindTexImage_t)(_EGLDriver *drv, _EGLDisplay *dpy, _EGLSurface *surface, EGLint buffer);
  68 typedef EGLBoolean (*ReleaseTexImage_t)(_EGLDriver *drv, _EGLDisplay *dpy, _EGLSurface *surface, EGLint buffer);
  69 typedef EGLBoolean (*SwapInterval_t)(_EGLDriver *drv, _EGLDisplay *dpy, _EGLSurface *surf, EGLint interval);
  70 typedef EGLBoolean (*SwapBuffers_t)(_EGLDriver *drv, _EGLDisplay *dpy, _EGLSurface *draw);
  71 typedef EGLBoolean (*CopyBuffers_t)(_EGLDriver *drv, _EGLDisplay *dpy, _EGLSurface *surface, void *native_pixmap_target);
  72
  73 /* misc funcs */
  74 typedef EGLBoolean (*WaitClient_t)(_EGLDriver *drv, _EGLDisplay *dpy, _EGLContext *ctx);
  75 typedef EGLBoolean (*WaitNative_t)(_EGLDriver *drv, _EGLDisplay *dpy, EGLint engine);
  76
  77 /* this function may be called from multiple threads at the same time */
  78 typedef _EGLProc (*GetProcAddress_t)(_EGLDriver *drv, const char *procname);
  79
  80
  81
  82 typedef _EGLSurface *(*CreatePbufferFromClientBuffer_t)(_EGLDriver *drv, _EGLDisplay *dpy, EGLenum buftype, EGLClientBuffer buffer, _EGLConfig *config, const EGLint *attrib_list);
  83
  84
  85 typedef _EGLImage *(*CreateImageKHR_t)(_EGLDriver *drv, _EGLDisplay *dpy, _EGLContext *ctx, EGLenum target, EGLClientBuffer buffer, const EGLint *attr_list);
  86 typedef EGLBoolean (*DestroyImageKHR_t)(_EGLDriver *drv, _EGLDisplay *dpy, _EGLImage *image);
  87
  88
  89 typedef _EGLSync *(*CreateSyncKHR_t)(_EGLDriver *drv, _EGLDisplay *dpy, EGLenum type, const EGLint *attrib_list, const EGLAttribKHR *attrib_list64);
  90 typedef EGLBoolean (*DestroySyncKHR_t)(_EGLDriver *drv, _EGLDisplay *dpy, _EGLSync *sync);
  91 typedef EGLint (*ClientWaitSyncKHR_t)(_EGLDriver *drv, _EGLDisplay *dpy, _EGLSync *sync, EGLint flags, EGLTimeKHR timeout);
  92 typedef EGLint (*WaitSyncKHR_t)(_EGLDriver *drv, _EGLDisplay *dpy, _EGLSync *sync);
  93 typedef EGLBoolean (*SignalSyncKHR_t)(_EGLDriver *drv, _EGLDisplay *dpy, _EGLSync *sync, EGLenum mode);
  94 typedef EGLBoolean (*GetSyncAttribKHR_t)(_EGLDriver *drv, _EGLDisplay *dpy, _EGLSync *sync, EGLint attribute, EGLint *value);
  95
  96
  97 #ifdef EGL_NOK_swap_region
  98 typedef EGLBoolean (*SwapBuffersRegionNOK_t)(_EGLDriver *drv, _EGLDisplay *disp, _EGLSurface *surf, EGLint numRects, const EGLint *rects);
  99 #endif
 100
 101 #ifdef EGL_MESA_drm_image
 102 typedef _EGLImage *(*CreateDRMImageMESA_t)(_EGLDriver *drv, _EGLDisplay *disp, const EGLint *attr_list);
 103 typedef EGLBoolean (*ExportDRMImageMESA_t)(_EGLDriver *drv, _EGLDisplay *disp, _EGLImage *img, EGLint *name, EGLint *handle, EGLint *stride);
 104 #endif
 105
 106 #ifdef EGL_WL_bind_wayland_display
 107 struct wl_display;
 108 typedef EGLBoolean (*BindWaylandDisplayWL_t)(_EGLDriver *drv, _EGLDisplay *disp, struct wl_display *display);
 109 typedef EGLBoolean (*UnbindWaylandDisplayWL_t)(_EGLDriver *drv, _EGLDisplay *disp, struct wl_display *display);
 110 typedef EGLBoolean (*QueryWaylandBufferWL_t)(_EGLDriver *drv, _EGLDisplay *displ, struct wl_resource *buffer, EGLint attribute, EGLint *value);
 111 #endif
 112
 113 #ifdef EGL_WL_create_wayland_buffer_from_image
 114 typedef struct wl_buffer * (*CreateWaylandBufferFromImageWL_t)(_EGLDriver *drv, _EGLDisplay *disp, _EGLImage *img);
 115 #endif
 116
 117 typedef EGLBoolean (*PostSubBufferNV_t)(_EGLDriver *drv, _EGLDisplay *disp, _EGLSurface *surface, EGLint x, EGLint y, EGLint width, EGLint height);
 118
 119 typedef EGLint (*QueryBufferAge_t)(_EGLDriver *drv,
 120                                    _EGLDisplay *dpy, _EGLSurface *surface);
 121
 122 #ifdef EGL_EXT_swap_buffers_with_damage
 123 typedef EGLBoolean (*SwapBuffersWithDamageEXT_t) (_EGLDriver *drv, _EGLDisplay *dpy, _EGLSurface *surface, const EGLint *rects, EGLint n_rects);
 124 #endif
 125
 126 typedef EGLBoolean (*GetSyncValuesCHROMIUM_t) (_EGLDisplay *dpy, _EGLSurface *surface, EGLuint64KHR *ust, EGLuint64KHR *msc, EGLuint64KHR *sbc);
 127
 128 #ifdef EGL_MESA_image_dma_buf_export
 129 typedef EGLBoolean (*ExportDMABUFImageQueryMESA_t)(_EGLDriver *drv, _EGLDisplay *disp, _EGLImage *img, EGLint *fourcc, EGLint *nplanes, EGLuint64KHR *modifiers);
 130 typedef EGLBoolean (*ExportDMABUFImageMESA_t)(_EGLDriver *drv, _EGLDisplay *disp, _EGLImage *img, EGLint *fds, EGLint *strides, EGLint *offsets);
 131 #endif
 132
 133 /**
 134  * The API dispatcher jumps through these functions
 135  */
 136 struct _egl_api
 137 {
 138    Initialize_t Initialize;
 139    Terminate_t Terminate;
 140
 141    GetConfigs_t GetConfigs;
 142    ChooseConfig_t ChooseConfig;
 143    GetConfigAttrib_t GetConfigAttrib;
 144
 145    CreateContext_t CreateContext;
 146    DestroyContext_t DestroyContext;
 147    MakeCurrent_t MakeCurrent;
 148    QueryContext_t QueryContext;
 149
 150    CreateWindowSurface_t CreateWindowSurface;
 151    CreatePixmapSurface_t CreatePixmapSurface;
 152    CreatePbufferSurface_t CreatePbufferSurface;
 153    DestroySurface_t DestroySurface;
 154    QuerySurface_t QuerySurface;
 155    SurfaceAttrib_t SurfaceAttrib;
 156    BindTexImage_t BindTexImage;
 157    ReleaseTexImage_t ReleaseTexImage;
 158    SwapInterval_t SwapInterval;
 159    SwapBuffers_t SwapBuffers;
 160    CopyBuffers_t CopyBuffers;
 161
 162    WaitClient_t WaitClient;
 163    WaitNative_t WaitNative;
 164    GetProcAddress_t GetProcAddress;
 165
 166    CreatePbufferFromClientBuffer_t CreatePbufferFromClientBuffer;
 167
 168    CreateImageKHR_t CreateImageKHR;
 169    DestroyImageKHR_t DestroyImageKHR;
 170
 171    CreateSyncKHR_t CreateSyncKHR;
 172    DestroySyncKHR_t DestroySyncKHR;
 173    ClientWaitSyncKHR_t ClientWaitSyncKHR;
 174    WaitSyncKHR_t WaitSyncKHR;
 175    SignalSyncKHR_t SignalSyncKHR;
 176    GetSyncAttribKHR_t GetSyncAttribKHR;
 177
 178 #ifdef EGL_NOK_swap_region
 179    SwapBuffersRegionNOK_t SwapBuffersRegionNOK;
 180 #endif
 181
 182 #ifdef EGL_MESA_drm_image
 183    CreateDRMImageMESA_t CreateDRMImageMESA;
 184    ExportDRMImageMESA_t ExportDRMImageMESA;
 185 #endif
 186
 187 #ifdef EGL_WL_bind_wayland_display
 188    BindWaylandDisplayWL_t BindWaylandDisplayWL;
 189    UnbindWaylandDisplayWL_t UnbindWaylandDisplayWL;
 190    QueryWaylandBufferWL_t QueryWaylandBufferWL;
 191 #endif
 192
 193 #ifdef EGL_WL_create_wayland_buffer_from_image
 194    CreateWaylandBufferFromImageWL_t CreateWaylandBufferFromImageWL;
 195 #endif
 196
 197 #ifdef EGL_EXT_swap_buffers_with_damage
 198    SwapBuffersWithDamageEXT_t SwapBuffersWithDamageEXT;
 199 #endif /* EGL_EXT_swap_buffers_with_damage */
 200
 201    PostSubBufferNV_t PostSubBufferNV;
 202
 203    QueryBufferAge_t QueryBufferAge;
 204    GetSyncValuesCHROMIUM_t GetSyncValuesCHROMIUM;
 205
 206 #ifdef EGL_MESA_image_dma_buf_export
 207    ExportDMABUFImageQueryMESA_t ExportDMABUFImageQueryMESA;
 208    ExportDMABUFImageMESA_t ExportDMABUFImageMESA;
 209 #endif
 210 };
 211
 212 #endif /* EGLAPI_INCLUDED */