include/EGL/egl.h

   1 /* -*- mode: c; tab-width: 8; -*- */
   2 /* vi: set sw=4 ts=8: */
   3 /* Reference version of egl.h for EGL 1.4.
   4  * Last modified 2008/05/02
   5  */
   6
   7 #ifndef __egl_h_
   8 #define __egl_h_
   9
  10 /* All platform-dependent types and macro boilerplate (such as EGLAPI
  11  * and EGLAPIENTRY) should go in eglplatform.h.
  12  */
  13 #include <EGL/eglplatform.h>
  14
  15 #ifdef __cplusplus
  16 extern "C" {
  17 #endif
  18
  19 /* EGL Types */
  20 typedef int32_t EGLint;
  21 typedef unsigned int EGLBoolean;
  22 typedef unsigned int EGLenum;
  23 typedef void *EGLConfig;
  24 typedef void *EGLContext;
  25 typedef void *EGLDisplay;
  26 typedef void *EGLSurface;
  27 typedef void *EGLClientBuffer;
  28
  29 /* EGL Versioning */
  30 #define EGL_VERSION_1_0                 1
  31 #define EGL_VERSION_1_1                 1
  32 #define EGL_VERSION_1_2                 1
  33 #define EGL_VERSION_1_3                 1
  34 #define EGL_VERSION_1_4                 1
  35
  36 /* EGL Enumerants. Bitmasks and other exceptional cases aside, most
  37  * enums are assigned unique values starting at 0x3000.
  38  */
  39
  40 /* EGL aliases */
  41 #define EGL_FALSE                       0
  42 #define EGL_TRUE                        1
  43
  44 /* Out-of-band handle values */
  45 #define EGL_DEFAULT_DISPLAY             ((void *)0)
  46 #define EGL_NO_CONTEXT                  ((EGLContext)0)
  47 #define EGL_NO_DISPLAY                  ((EGLDisplay)0)
  48 #define EGL_NO_SURFACE                  ((EGLSurface)0)
  49
  50 /* Out-of-band attribute value */
  51 #define EGL_DONT_CARE                   ((EGLint)-1)
  52
  53 /* Errors / GetError return values */
  54 #define EGL_SUCCESS                     0x3000
  55 #define EGL_NOT_INITIALIZED             0x3001
  56 #define EGL_BAD_ACCESS                  0x3002
  57 #define EGL_BAD_ALLOC                   0x3003
  58 #define EGL_BAD_ATTRIBUTE               0x3004
  59 #define EGL_BAD_CONFIG                  0x3005
  60 #define EGL_BAD_CONTEXT                 0x3006
  61 #define EGL_BAD_CURRENT_SURFACE         0x3007
  62 #define EGL_BAD_DISPLAY                 0x3008
  63 #define EGL_BAD_MATCH                   0x3009
  64 #define EGL_BAD_NATIVE_PIXMAP           0x300A
  65 #define EGL_BAD_NATIVE_WINDOW           0x300B
  66 #define EGL_BAD_PARAMETER               0x300C
  67 #define EGL_BAD_SURFACE                 0x300D
  68 #define EGL_CONTEXT_LOST                0x300E  /* EGL 1.1 - IMG_power_management */
  69
  70 /* Reserved 0x300F-0x301F for additional errors */
  71
  72 /* Config attributes */
  73 #define EGL_BUFFER_SIZE                 0x3020
  74 #define EGL_ALPHA_SIZE                  0x3021
  75 #define EGL_BLUE_SIZE                   0x3022
  76 #define EGL_GREEN_SIZE                  0x3023
  77 #define EGL_RED_SIZE                    0x3024
  78 #define EGL_DEPTH_SIZE                  0x3025
  79 #define EGL_STENCIL_SIZE                0x3026
  80 #define EGL_CONFIG_CAVEAT               0x3027
  81 #define EGL_CONFIG_ID                   0x3028
  82 #define EGL_LEVEL                       0x3029
  83 #define EGL_MAX_PBUFFER_HEIGHT          0x302A
  84 #define EGL_MAX_PBUFFER_PIXELS          0x302B
  85 #define EGL_MAX_PBUFFER_WIDTH           0x302C
  86 #define EGL_NATIVE_RENDERABLE           0x302D
  87 #define EGL_NATIVE_VISUAL_ID            0x302E
  88 #define EGL_NATIVE_VISUAL_TYPE          0x302F
  89 #define EGL_PRESERVED_RESOURCES         0x3030
  90 #define EGL_SAMPLES                     0x3031
  91 #define EGL_SAMPLE_BUFFERS              0x3032
  92 #define EGL_SURFACE_TYPE                0x3033
  93 #define EGL_TRANSPARENT_TYPE            0x3034
  94 #define EGL_TRANSPARENT_BLUE_VALUE      0x3035
  95 #define EGL_TRANSPARENT_GREEN_VALUE     0x3036
  96 #define EGL_TRANSPARENT_RED_VALUE       0x3037
  97 #define EGL_NONE                        0x3038  /* Attrib list terminator */
  98 #define EGL_BIND_TO_TEXTURE_RGB         0x3039
  99 #define EGL_BIND_TO_TEXTURE_RGBA        0x303A
 100 #define EGL_MIN_SWAP_INTERVAL           0x303B
 101 #define EGL_MAX_SWAP_INTERVAL           0x303C
 102 #define EGL_LUMINANCE_SIZE              0x303D
 103 #define EGL_ALPHA_MASK_SIZE             0x303E
 104 #define EGL_COLOR_BUFFER_TYPE           0x303F
 105 #define EGL_RENDERABLE_TYPE             0x3040
 106 #define EGL_MATCH_NATIVE_PIXMAP         0x3041  /* Pseudo-attribute (not queryable) */
 107 #define EGL_CONFORMANT                  0x3042
 108
 109 /* Reserved 0x3041-0x304F for additional config attributes */
 110
 111 /* Config attribute values */
 112 #define EGL_SLOW_CONFIG                 0x3050  /* EGL_CONFIG_CAVEAT value */
 113 #define EGL_NON_CONFORMANT_CONFIG       0x3051  /* EGL_CONFIG_CAVEAT value */
 114 #define EGL_TRANSPARENT_RGB             0x3052  /* EGL_TRANSPARENT_TYPE value */
 115 #define EGL_RGB_BUFFER                  0x308E  /* EGL_COLOR_BUFFER_TYPE value */
 116 #define EGL_LUMINANCE_BUFFER            0x308F  /* EGL_COLOR_BUFFER_TYPE value */
 117
 118 /* More config attribute values, for EGL_TEXTURE_FORMAT */
 119 #define EGL_NO_TEXTURE                  0x305C
 120 #define EGL_TEXTURE_RGB                 0x305D
 121 #define EGL_TEXTURE_RGBA                0x305E
 122 #define EGL_TEXTURE_2D                  0x305F
 123
 124 /* Config attribute mask bits */
 125 #define EGL_PBUFFER_BIT                 0x0001  /* EGL_SURFACE_TYPE mask bits */
 126 #define EGL_PIXMAP_BIT                  0x0002  /* EGL_SURFACE_TYPE mask bits */
 127 #define EGL_WINDOW_BIT                  0x0004  /* EGL_SURFACE_TYPE mask bits */
 128 #define EGL_VG_COLORSPACE_LINEAR_BIT    0x0020  /* EGL_SURFACE_TYPE mask bits */
 129 #define EGL_VG_ALPHA_FORMAT_PRE_BIT     0x0040  /* EGL_SURFACE_TYPE mask bits */
 130 #define EGL_MULTISAMPLE_RESOLVE_BOX_BIT 0x0200  /* EGL_SURFACE_TYPE mask bits */
 131 #define EGL_SWAP_BEHAVIOR_PRESERVED_BIT 0x0400  /* EGL_SURFACE_TYPE mask bits */
 132
 133 #define EGL_OPENGL_ES_BIT               0x0001  /* EGL_RENDERABLE_TYPE mask bits */
 134 #define EGL_OPENVG_BIT                  0x0002  /* EGL_RENDERABLE_TYPE mask bits */
 135 #define EGL_OPENGL_ES2_BIT              0x0004  /* EGL_RENDERABLE_TYPE mask bits */
 136 #define EGL_OPENGL_BIT                  0x0008  /* EGL_RENDERABLE_TYPE mask bits */
 137
 138 /* QueryString targets */
 139 #define EGL_VENDOR                      0x3053
 140 #define EGL_VERSION                     0x3054
 141 #define EGL_EXTENSIONS                  0x3055
 142 #define EGL_CLIENT_APIS                 0x308D
 143
 144 /* QuerySurface / SurfaceAttrib / CreatePbufferSurface targets */
 145 #define EGL_HEIGHT                      0x3056
 146 #define EGL_WIDTH                       0x3057
 147 #define EGL_LARGEST_PBUFFER             0x3058
 148 #define EGL_TEXTURE_FORMAT              0x3080
 149 #define EGL_TEXTURE_TARGET              0x3081
 150 #define EGL_MIPMAP_TEXTURE              0x3082
 151 #define EGL_MIPMAP_LEVEL                0x3083
 152 #define EGL_RENDER_BUFFER               0x3086
 153 #define EGL_VG_COLORSPACE               0x3087
 154 #define EGL_VG_ALPHA_FORMAT             0x3088
 155 #define EGL_HORIZONTAL_RESOLUTION       0x3090
 156 #define EGL_VERTICAL_RESOLUTION         0x3091
 157 #define EGL_PIXEL_ASPECT_RATIO          0x3092
 158 #define EGL_SWAP_BEHAVIOR               0x3093
 159 #define EGL_MULTISAMPLE_RESOLVE         0x3099
 160
 161 /* EGL_RENDER_BUFFER values / BindTexImage / ReleaseTexImage buffer targets */
 162 #define EGL_BACK_BUFFER                 0x3084
 163 #define EGL_SINGLE_BUFFER               0x3085
 164
 165 /* OpenVG color spaces */
 166 #define EGL_VG_COLORSPACE_sRGB          0x3089  /* EGL_VG_COLORSPACE value */
 167 #define EGL_VG_COLORSPACE_LINEAR        0x308A  /* EGL_VG_COLORSPACE value */
 168
 169 /* OpenVG alpha formats */
 170 #define EGL_VG_ALPHA_FORMAT_NONPRE      0x308B  /* EGL_ALPHA_FORMAT value */
 171 #define EGL_VG_ALPHA_FORMAT_PRE         0x308C  /* EGL_ALPHA_FORMAT value */
 172
 173 /* Constant scale factor by which fractional display resolutions &
 174  * aspect ratio are scaled when queried as integer values.
 175  */
 176 #define EGL_DISPLAY_SCALING             10000
 177
 178 /* Unknown display resolution/aspect ratio */
 179 #define EGL_UNKNOWN                     ((EGLint)-1)
 180
 181 /* Back buffer swap behaviors */
 182 #define EGL_BUFFER_PRESERVED            0x3094  /* EGL_SWAP_BEHAVIOR value */
 183 #define EGL_BUFFER_DESTROYED            0x3095  /* EGL_SWAP_BEHAVIOR value */
 184
 185 /* CreatePbufferFromClientBuffer buffer types */
 186 #define EGL_OPENVG_IMAGE                0x3096
 187
 188 /* QueryContext targets */
 189 #define EGL_CONTEXT_CLIENT_TYPE         0x3097
 190
 191 /* CreateContext attributes */
 192 #define EGL_CONTEXT_CLIENT_VERSION      0x3098
 193
 194 /* Multisample resolution behaviors */
 195 #define EGL_MULTISAMPLE_RESOLVE_DEFAULT 0x309A  /* EGL_MULTISAMPLE_RESOLVE value */
 196 #define EGL_MULTISAMPLE_RESOLVE_BOX     0x309B  /* EGL_MULTISAMPLE_RESOLVE value */
 197
 198 /* BindAPI/QueryAPI targets */
 199 #define EGL_OPENGL_ES_API               0x30A0
 200 #define EGL_OPENVG_API                  0x30A1
 201 #define EGL_OPENGL_API                  0x30A2
 202
 203 /* GetCurrentSurface targets */
 204 #define EGL_DRAW                        0x3059
 205 #define EGL_READ                        0x305A
 206
 207 /* WaitNative engines */
 208 #define EGL_CORE_NATIVE_ENGINE          0x305B
 209
 210 /* EGL 1.2 tokens renamed for consistency in EGL 1.3 */
 211 #define EGL_COLORSPACE                  EGL_VG_COLORSPACE
 212 #define EGL_ALPHA_FORMAT                EGL_VG_ALPHA_FORMAT
 213 #define EGL_COLORSPACE_sRGB             EGL_VG_COLORSPACE_sRGB
 214 #define EGL_COLORSPACE_LINEAR           EGL_VG_COLORSPACE_LINEAR
 215 #define EGL_ALPHA_FORMAT_NONPRE         EGL_VG_ALPHA_FORMAT_NONPRE
 216 #define EGL_ALPHA_FORMAT_PRE            EGL_VG_ALPHA_FORMAT_PRE
 217
 218 /* EGL extensions must request enum blocks from the Khronos
 219  * API Registrar, who maintains the enumerant registry. Submit
 220  * a bug in Khronos Bugzilla against task "Registry".
 221  */
 222
 223
 224
 225 /* EGL Functions */
 226
 227 EGLAPI EGLint EGLAPIENTRY eglGetError(void);
 228
 229 EGLAPI EGLDisplay EGLAPIENTRY eglGetDisplay(EGLNativeDisplayType display_id);
 230 EGLAPI EGLBoolean EGLAPIENTRY eglInitialize(EGLDisplay dpy, EGLint *major, EGLint *minor);
 231 EGLAPI EGLBoolean EGLAPIENTRY eglTerminate(EGLDisplay dpy);
 232
 233 EGLAPI const char * EGLAPIENTRY eglQueryString(EGLDisplay dpy, EGLint name);
 234
 235 EGLAPI EGLBoolean EGLAPIENTRY eglGetConfigs(EGLDisplay dpy, EGLConfig *configs,
 236                          EGLint config_size, EGLint *num_config);
 237 EGLAPI EGLBoolean EGLAPIENTRY eglChooseConfig(EGLDisplay dpy, const EGLint *attrib_list,
 238                            EGLConfig *configs, EGLint config_size,
 239                            EGLint *num_config);
 240 EGLAPI EGLBoolean EGLAPIENTRY eglGetConfigAttrib(EGLDisplay dpy, EGLConfig config,
 241                               EGLint attribute, EGLint *value);
 242
 243 EGLAPI EGLSurface EGLAPIENTRY eglCreateWindowSurface(EGLDisplay dpy, EGLConfig config,
 244                                   EGLNativeWindowType win,
 245                                   const EGLint *attrib_list);
 246 EGLAPI EGLSurface EGLAPIENTRY eglCreatePbufferSurface(EGLDisplay dpy, EGLConfig config,
 247                                    const EGLint *attrib_list);
 248 EGLAPI EGLSurface EGLAPIENTRY eglCreatePixmapSurface(EGLDisplay dpy, EGLConfig config,
 249                                   EGLNativePixmapType pixmap,
 250                                   const EGLint *attrib_list);
 251 EGLAPI EGLBoolean EGLAPIENTRY eglDestroySurface(EGLDisplay dpy, EGLSurface surface);
 252 EGLAPI EGLBoolean EGLAPIENTRY eglQuerySurface(EGLDisplay dpy, EGLSurface surface,
 253                            EGLint attribute, EGLint *value);
 254
 255 EGLAPI EGLBoolean EGLAPIENTRY eglBindAPI(EGLenum api);
 256 EGLAPI EGLenum EGLAPIENTRY eglQueryAPI(void);
 257
 258 EGLAPI EGLBoolean EGLAPIENTRY eglWaitClient(void);
 259
 260 EGLAPI EGLBoolean EGLAPIENTRY eglReleaseThread(void);
 261
 262 EGLAPI EGLSurface EGLAPIENTRY eglCreatePbufferFromClientBuffer(
 263               EGLDisplay dpy, EGLenum buftype, EGLClientBuffer buffer,
 264               EGLConfig config, const EGLint *attrib_list);
 265
 266 EGLAPI EGLBoolean EGLAPIENTRY eglSurfaceAttrib(EGLDisplay dpy, EGLSurface surface,
 267                             EGLint attribute, EGLint value);
 268 EGLAPI EGLBoolean EGLAPIENTRY eglBindTexImage(EGLDisplay dpy, EGLSurface surface, EGLint buffer);
 269 EGLAPI EGLBoolean EGLAPIENTRY eglReleaseTexImage(EGLDisplay dpy, EGLSurface surface, EGLint buffer);
 270
 271
 272 EGLAPI EGLBoolean EGLAPIENTRY eglSwapInterval(EGLDisplay dpy, EGLint interval);
 273
 274
 275 EGLAPI EGLContext EGLAPIENTRY eglCreateContext(EGLDisplay dpy, EGLConfig config,
 276                             EGLContext share_context,
 277                             const EGLint *attrib_list);
 278 EGLAPI EGLBoolean EGLAPIENTRY eglDestroyContext(EGLDisplay dpy, EGLContext ctx);
 279 EGLAPI EGLBoolean EGLAPIENTRY eglMakeCurrent(EGLDisplay dpy, EGLSurface draw,
 280                           EGLSurface read, EGLContext ctx);
 281
 282 EGLAPI EGLContext EGLAPIENTRY eglGetCurrentContext(void);
 283 EGLAPI EGLSurface EGLAPIENTRY eglGetCurrentSurface(EGLint readdraw);
 284 EGLAPI EGLDisplay EGLAPIENTRY eglGetCurrentDisplay(void);
 285 EGLAPI EGLBoolean EGLAPIENTRY eglQueryContext(EGLDisplay dpy, EGLContext ctx,
 286                            EGLint attribute, EGLint *value);
 287
 288 EGLAPI EGLBoolean EGLAPIENTRY eglWaitGL(void);
 289 EGLAPI EGLBoolean EGLAPIENTRY eglWaitNative(EGLint engine);
 290 EGLAPI EGLBoolean EGLAPIENTRY eglSwapBuffers(EGLDisplay dpy, EGLSurface surface);
 291 EGLAPI EGLBoolean EGLAPIENTRY eglCopyBuffers(EGLDisplay dpy, EGLSurface surface,
 292                           EGLNativePixmapType target);
 293
 294 EGLAPI void (* EGLAPIENTRY eglGetProcAddress(const char *procname))(void);
 295
 296 #ifdef __cplusplus
 297 }
 298 #endif
 299
 300 #endif /* __egl_h_ */