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 "eglapi.h"
  39 #include <stddef.h>
  40
  41 /**
  42  * Define an inline driver typecast function.
  43  *
  44  * Note that this macro defines a function and should not be ended with a
  45  * semicolon when used.
  46  */
  47 #define _EGL_DRIVER_TYPECAST(drvtype, egltype, code)           \
  48    static inline struct drvtype *drvtype(const egltype *obj)   \
  49    { return (struct drvtype *) code; }
  50
  51
  52 /**
  53  * Define the driver typecast functions for _EGLDriver, _EGLDisplay,
  54  * _EGLContext, _EGLSurface, and _EGLConfig.
  55  *
  56  * Note that this macro defines several functions and should not be ended with
  57  * a semicolon when used.
  58  */
  59 #define _EGL_DRIVER_STANDARD_TYPECASTS(drvname)                            \
  60    _EGL_DRIVER_TYPECAST(drvname ## _driver, _EGLDriver, obj)               \
  61    /* note that this is not a direct cast */                               \
  62    _EGL_DRIVER_TYPECAST(drvname ## _display, _EGLDisplay, obj->DriverData) \
  63    _EGL_DRIVER_TYPECAST(drvname ## _context, _EGLContext, obj)             \
  64    _EGL_DRIVER_TYPECAST(drvname ## _surface, _EGLSurface, obj)             \
  65    _EGL_DRIVER_TYPECAST(drvname ## _config, _EGLConfig, obj)
  66
  67
  68 typedef _EGLDriver *(*_EGLMain_t)(const char *args);
  69
  70
  71 /**
  72  * Base class for device drivers.
  73  */
  74 struct _egl_driver
  75 {
  76    const char *Name;  /**< name of this driver */
  77
  78    /**
  79     * Release the driver resource.
  80     *
  81     * It is called before dlclose().
  82     */
  83    void (*Unload)(_EGLDriver *drv);
  84
  85    _EGLAPI API;  /**< EGL API dispatch table */
  86 };
  87
  88
  89 extern _EGLDriver *
  90 _eglBuiltInDriverGALLIUM(const char *args);
  91
  92
  93 extern _EGLDriver *
  94 _eglBuiltInDriverDRI2(const char *args);
  95
  96
  97 extern _EGLDriver *
  98 _eglBuiltInDriverGLX(const char *args);
  99
 100
 101 extern _EGLDriver *
 102 _eglMain(const char *args);
 103
 104
 105 extern _EGLDriver *
 106 _eglMatchDriver(_EGLDisplay *dpy, EGLBoolean test_only);
 107
 108
 109 extern __eglMustCastToProperFunctionPointerType
 110 _eglGetDriverProc(const char *procname);
 111
 112
 113 extern void
 114 _eglUnloadDrivers(void);
 115
 116
 117 /* defined in eglfallbacks.c */
 118 extern void
 119 _eglInitDriverFallbacks(_EGLDriver *drv);
 120
 121
 122 extern void
 123 _eglSearchPathForEach(EGLBoolean (*callback)(const char *, size_t, void *),
 124                       void *callback_data);
 125
 126
 127 #endif /* EGLDRIVER_INCLUDED */