src/egl/main/egldriver.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 EGLDRIVER_INCLUDED
  32 #define EGLDRIVER_INCLUDED
  33
  34
  35 #include "c99_compat.h"
  36
  37 #include "egltypedefs.h"
  38 #include <stdbool.h>
  39 #include <stddef.h>
  40
  41
  42 #ifdef __cplusplus
  43 extern "C" {
  44 #endif
  45
  46 /**
  47  * Define an inline driver typecast function.
  48  *
  49  * Note that this macro defines a function and should not be ended with a
  50  * semicolon when used.
  51  */
  52 #define _EGL_DRIVER_TYPECAST(drvtype, egltype, code)           \
  53    static inline struct drvtype *drvtype(const egltype *obj)   \
  54    { return (struct drvtype *) code; }
  55
  56
  57 /**
  58  * Define the driver typecast functions for _EGLDriver, _EGLDisplay,
  59  * _EGLContext, _EGLSurface, and _EGLConfig.
  60  *
  61  * Note that this macro defines several functions and should not be ended with
  62  * a semicolon when used.
  63  */
  64 #define _EGL_DRIVER_STANDARD_TYPECASTS(drvname)                            \
  65    _EGL_DRIVER_TYPECAST(drvname ## _driver, _EGLDriver, obj)               \
  66    /* note that this is not a direct cast */                               \
  67    _EGL_DRIVER_TYPECAST(drvname ## _display, _EGLDisplay, obj->DriverData) \
  68    _EGL_DRIVER_TYPECAST(drvname ## _context, _EGLContext, obj)             \
  69    _EGL_DRIVER_TYPECAST(drvname ## _surface, _EGLSurface, obj)             \
  70    _EGL_DRIVER_TYPECAST(drvname ## _config, _EGLConfig, obj)
  71
  72 /**
  73  * A generic function ptr type
  74  */
  75 typedef void (*_EGLProc)(void);
  76
  77 struct wl_display;
  78 struct mesa_glinterop_device_info;
  79 struct mesa_glinterop_export_in;
  80 struct mesa_glinterop_export_out;
  81
  82 /**
  83  * The API dispatcher jumps through these functions
  84  */
  85 struct _egl_driver
  86 {
  87    /* driver funcs */
  88    EGLBoolean (*Initialize)(_EGLDisplay *disp);
  89    EGLBoolean (*Terminate)(_EGLDisplay *disp);
  90    const char *(*QueryDriverName)(_EGLDisplay *disp);
  91    char *(*QueryDriverConfig)(_EGLDisplay *disp);
  92
  93    /* context funcs */
  94    _EGLContext *(*CreateContext)(_EGLDisplay *disp, _EGLConfig *config,
  95                                  _EGLContext *share_list, const EGLint *attrib_list);
  96    EGLBoolean (*DestroyContext)(_EGLDisplay *disp, _EGLContext *ctx);
  97    /* this is the only function (other than Initialize) that may be called
  98     * with an uninitialized display
  99     */
 100    EGLBoolean (*MakeCurrent)(_EGLDisplay *disp,
 101                              _EGLSurface *draw, _EGLSurface *read,
 102                              _EGLContext *ctx);
 103
 104    /* surface funcs */
 105    _EGLSurface *(*CreateWindowSurface)(_EGLDisplay *disp, _EGLConfig *config,
 106                                        void *native_window, const EGLint *attrib_list);
 107    _EGLSurface *(*CreatePixmapSurface)(_EGLDisplay *disp, _EGLConfig *config,
 108                                        void *native_pixmap, const EGLint *attrib_list);
 109    _EGLSurface *(*CreatePbufferSurface)(_EGLDisplay *disp, _EGLConfig *config,
 110                                         const EGLint *attrib_list);
 111    EGLBoolean (*DestroySurface)(_EGLDisplay *disp, _EGLSurface *surface);
 112    EGLBoolean (*QuerySurface)(_EGLDisplay *disp, _EGLSurface *surface,
 113                               EGLint attribute, EGLint *value);
 114    EGLBoolean (*BindTexImage)(_EGLDisplay *disp, _EGLSurface *surface,
 115                               EGLint buffer);
 116    EGLBoolean (*ReleaseTexImage)(_EGLDisplay *disp, _EGLSurface *surface,
 117                                  EGLint buffer);
 118    EGLBoolean (*SwapInterval)(_EGLDisplay *disp, _EGLSurface *surf,
 119                               EGLint interval);
 120    EGLBoolean (*SwapBuffers)(_EGLDisplay *disp, _EGLSurface *draw);
 121    EGLBoolean (*CopyBuffers)(_EGLDisplay *disp, _EGLSurface *surface,
 122                              void *native_pixmap_target);
 123    EGLBoolean (*SetDamageRegion)(_EGLDisplay *disp, _EGLSurface *surface,
 124                                  EGLint *rects, EGLint n_rects);
 125
 126    /* misc functions */
 127    EGLBoolean (*WaitClient)(_EGLDisplay *disp, _EGLContext *ctx);
 128    EGLBoolean (*WaitNative)(EGLint engine);
 129
 130    /* this function may be called from multiple threads at the same time */
 131    _EGLProc (*GetProcAddress)(const char *procname);
 132
 133    _EGLImage *(*CreateImageKHR)(_EGLDisplay *disp, _EGLContext *ctx,
 134                                 EGLenum target, EGLClientBuffer buffer,
 135                                 const EGLint *attr_list);
 136    EGLBoolean (*DestroyImageKHR)(_EGLDisplay *disp, _EGLImage *image);
 137
 138    _EGLSync *(*CreateSyncKHR)(_EGLDisplay *disp, EGLenum type,
 139                               const EGLAttrib *attrib_list);
 140    EGLBoolean (*DestroySyncKHR)(_EGLDisplay *disp, _EGLSync *sync);
 141    EGLint (*ClientWaitSyncKHR)(_EGLDisplay *disp, _EGLSync *sync,
 142                                EGLint flags, EGLTime timeout);
 143    EGLint (*WaitSyncKHR)(_EGLDisplay *disp, _EGLSync *sync);
 144    EGLBoolean (*SignalSyncKHR)(_EGLDisplay *disp, _EGLSync *sync, EGLenum mode);
 145    EGLint (*DupNativeFenceFDANDROID)(_EGLDisplay *disp, _EGLSync *sync);
 146
 147    EGLBoolean (*SwapBuffersRegionNOK)(_EGLDisplay *disp, _EGLSurface *surf,
 148                                       EGLint numRects, const EGLint *rects);
 149
 150    _EGLImage *(*CreateDRMImageMESA)(_EGLDisplay *disp, const EGLint *attr_list);
 151    EGLBoolean (*ExportDRMImageMESA)(_EGLDisplay *disp, _EGLImage *img,
 152                                     EGLint *name, EGLint *handle,
 153                                     EGLint *stride);
 154
 155    EGLBoolean (*BindWaylandDisplayWL)(_EGLDisplay *disp, struct wl_display *display);
 156    EGLBoolean (*UnbindWaylandDisplayWL)(_EGLDisplay *disp, struct wl_display *display);
 157    EGLBoolean (*QueryWaylandBufferWL)(_EGLDisplay *displ, struct wl_resource *buffer,
 158                                       EGLint attribute, EGLint *value);
 159    struct wl_buffer *(*CreateWaylandBufferFromImageWL)(_EGLDisplay *disp, _EGLImage *img);
 160
 161    EGLBoolean (*SwapBuffersWithDamageEXT)(_EGLDisplay *disp, _EGLSurface *surface,
 162                                           const EGLint *rects, EGLint n_rects);
 163
 164    EGLBoolean (*PostSubBufferNV)(_EGLDisplay *disp, _EGLSurface *surface,
 165                                  EGLint x, EGLint y, EGLint width, EGLint height);
 166
 167    EGLint (*QueryBufferAge)(_EGLDisplay *disp, _EGLSurface *surface);
 168    EGLBoolean (*GetSyncValuesCHROMIUM)(_EGLDisplay *disp, _EGLSurface *surface,
 169                                        EGLuint64KHR *ust, EGLuint64KHR *msc,
 170                                        EGLuint64KHR *sbc);
 171
 172    EGLBoolean (*ExportDMABUFImageQueryMESA)(const _EGLDriver *drv, _EGLDisplay *disp,
 173                                             _EGLImage *img, EGLint *fourcc,
 174                                             EGLint *nplanes,
 175                                             EGLuint64KHR *modifiers);
 176    EGLBoolean (*ExportDMABUFImageMESA)(const _EGLDriver *drv, _EGLDisplay *disp,
 177                                        _EGLImage *img, EGLint *fds,
 178                                        EGLint *strides, EGLint *offsets);
 179
 180    int (*GLInteropQueryDeviceInfo)(_EGLDisplay *disp, _EGLContext *ctx,
 181                                    struct mesa_glinterop_device_info *out);
 182    int (*GLInteropExportObject)(_EGLDisplay *disp, _EGLContext *ctx,
 183                                 struct mesa_glinterop_export_in *in,
 184                                 struct mesa_glinterop_export_out *out);
 185
 186    EGLBoolean (*QueryDmaBufFormatsEXT)(const _EGLDriver *drv, _EGLDisplay *disp,
 187                                        EGLint max_formats, EGLint *formats,
 188                                        EGLint *num_formats);
 189    EGLBoolean (*QueryDmaBufModifiersEXT) (const _EGLDriver *drv, _EGLDisplay *disp,
 190                                           EGLint format, EGLint max_modifiers,
 191                                           EGLuint64KHR *modifiers,
 192                                           EGLBoolean *external_only,
 193                                           EGLint *num_modifiers);
 194
 195    void (*SetBlobCacheFuncsANDROID) (const _EGLDriver *drv, _EGLDisplay *disp,
 196                                      EGLSetBlobFuncANDROID set,
 197                                      EGLGetBlobFuncANDROID get);
 198 };
 199
 200
 201 extern bool
 202 _eglInitializeDisplay(_EGLDisplay *disp);
 203
 204
 205 extern __eglMustCastToProperFunctionPointerType
 206 _eglGetDriverProc(const char *procname);
 207
 208
 209 #ifdef __cplusplus
 210 }
 211 #endif
 212
 213
 214 #endif /* EGLDRIVER_INCLUDED */