williamr@4: /*
williamr@4: ** Copyright (c) 2007-2009 The Khronos Group Inc.
williamr@4: **
williamr@4: ** Permission is hereby granted, free of charge, to any person obtaining a
williamr@4: ** copy of this software and/or associated documentation files (the
williamr@4: ** "Materials"), to deal in the Materials without restriction, including
williamr@4: ** without limitation the rights to use, copy, modify, merge, publish,
williamr@4: ** distribute, sublicense, and/or sell copies of the Materials, and to
williamr@4: ** permit persons to whom the Materials are furnished to do so, subject to
williamr@4: ** the following conditions:
williamr@4: **
williamr@4: ** The above copyright notice and this permission notice shall be included
williamr@4: ** in all copies or substantial portions of the Materials.
williamr@4: **
williamr@4: ** THE MATERIALS ARE PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
williamr@4: ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
williamr@4: ** MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
williamr@4: ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
williamr@4: ** CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
williamr@4: ** TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
williamr@4: ** MATERIALS OR THE USE OR OTHER DEALINGS IN THE MATERIALS.
williamr@4: */
williamr@2: 
williamr@4: #ifndef __egl_h_
williamr@4: #define __egl_h_
williamr@2: 
williamr@2: /**
williamr@4: @publishedAll
williamr@4: @released
williamr@4: */
williamr@2: 
williamr@2: 
williamr@4: /* differences from the actual sample implemtation provided by Khronos:
williamr@4: - this comment
williamr@4: - the Doxygen comment with tag 'publishedAll', and tag 'released'
williamr@4: - changing platform-dependant header name from <EGL/eglplatform.h> to <EGL/egltypes.h>
williamr@4: - exclude via #if 0 ... #endif some native types defined in egltypes.h
williamr@4: - include eglext.h file by default
williamr@4:  */
williamr@2: 
williamr@2: 
williamr@4: /* All platform-dependent types and macro boilerplate (such as EGLAPI
williamr@4:  * and EGLAPIENTRY) should go in egltypes.h.
williamr@4:  */
williamr@4: #include <EGL/egltypes.h>
williamr@2: 
williamr@4: /* The user of this API can use own extension by defining EGLEXT_LOCAL macro */
williamr@4: #ifndef EGLEXT_LOCAL
williamr@4: #include <EGL/eglext.h>
williamr@4: #endif /* ifndef EGLEXT_LOCAL */
williamr@4: 
williamr@4: #ifdef __cplusplus
williamr@4: extern "C" {
williamr@2: #endif
williamr@2: 
williamr@4: /* EGL Versioning */
williamr@4: #define EGL_VERSION_1_0			1
williamr@4: #define EGL_VERSION_1_1			1
williamr@4: #define EGL_VERSION_1_2			1
williamr@4: #define EGL_VERSION_1_3			1
williamr@4: #define EGL_VERSION_1_4			1
williamr@4: 
williamr@4: /* EGL Enumerants. Bitmasks and other exceptional cases aside, most
williamr@4:  * enums are assigned unique values starting at 0x3000.
williamr@4:  */
williamr@4: 
williamr@4: /* EGL aliases */
williamr@4: #define EGL_FALSE			0
williamr@4: #define EGL_TRUE			1
williamr@4: 
williamr@4: /* Out-of-band attribute value */
williamr@4: #define EGL_DONT_CARE			((EGLint)-1)
williamr@4: 
williamr@4: /* Errors / GetError return values */
williamr@4: #define EGL_SUCCESS			0x3000
williamr@4: #define EGL_NOT_INITIALIZED		0x3001
williamr@4: #define EGL_BAD_ACCESS			0x3002
williamr@4: #define EGL_BAD_ALLOC			0x3003
williamr@4: #define EGL_BAD_ATTRIBUTE		0x3004
williamr@4: #define EGL_BAD_CONFIG			0x3005
williamr@4: #define EGL_BAD_CONTEXT			0x3006
williamr@4: #define EGL_BAD_CURRENT_SURFACE		0x3007
williamr@4: #define EGL_BAD_DISPLAY			0x3008
williamr@4: #define EGL_BAD_MATCH			0x3009
williamr@4: #define EGL_BAD_NATIVE_PIXMAP		0x300A
williamr@4: #define EGL_BAD_NATIVE_WINDOW		0x300B
williamr@4: #define EGL_BAD_PARAMETER		0x300C
williamr@4: #define EGL_BAD_SURFACE			0x300D
williamr@4: #define EGL_CONTEXT_LOST		0x300E	/* EGL 1.1 - IMG_power_management */
williamr@4: 
williamr@4: /* Reserved 0x300F-0x301F for additional errors */
williamr@4: 
williamr@4: /* Config attributes */
williamr@4: #define EGL_BUFFER_SIZE			0x3020
williamr@4: #define EGL_ALPHA_SIZE			0x3021
williamr@4: #define EGL_BLUE_SIZE			0x3022
williamr@4: #define EGL_GREEN_SIZE			0x3023
williamr@4: #define EGL_RED_SIZE			0x3024
williamr@4: #define EGL_DEPTH_SIZE			0x3025
williamr@4: #define EGL_STENCIL_SIZE		0x3026
williamr@4: #define EGL_CONFIG_CAVEAT		0x3027
williamr@4: #define EGL_CONFIG_ID			0x3028
williamr@4: #define EGL_LEVEL			0x3029
williamr@4: #define EGL_MAX_PBUFFER_HEIGHT		0x302A
williamr@4: #define EGL_MAX_PBUFFER_PIXELS		0x302B
williamr@4: #define EGL_MAX_PBUFFER_WIDTH		0x302C
williamr@4: #define EGL_NATIVE_RENDERABLE		0x302D
williamr@4: #define EGL_NATIVE_VISUAL_ID		0x302E
williamr@4: #define EGL_NATIVE_VISUAL_TYPE		0x302F
williamr@4: #define EGL_PRESERVED_RESOURCES		0x3030
williamr@4: #define EGL_SAMPLES			0x3031
williamr@4: #define EGL_SAMPLE_BUFFERS		0x3032
williamr@4: #define EGL_SURFACE_TYPE		0x3033
williamr@4: #define EGL_TRANSPARENT_TYPE		0x3034
williamr@4: #define EGL_TRANSPARENT_BLUE_VALUE	0x3035
williamr@4: #define EGL_TRANSPARENT_GREEN_VALUE	0x3036
williamr@4: #define EGL_TRANSPARENT_RED_VALUE	0x3037
williamr@4: #define EGL_NONE			0x3038	/* Attrib list terminator */
williamr@4: #define EGL_BIND_TO_TEXTURE_RGB		0x3039
williamr@4: #define EGL_BIND_TO_TEXTURE_RGBA	0x303A
williamr@4: #define EGL_MIN_SWAP_INTERVAL		0x303B
williamr@4: #define EGL_MAX_SWAP_INTERVAL		0x303C
williamr@4: #define EGL_LUMINANCE_SIZE		0x303D
williamr@4: #define EGL_ALPHA_MASK_SIZE		0x303E
williamr@4: #define EGL_COLOR_BUFFER_TYPE		0x303F
williamr@4: #define EGL_RENDERABLE_TYPE		0x3040
williamr@4: #define EGL_MATCH_NATIVE_PIXMAP		0x3041	/* Pseudo-attribute (not queryable) */
williamr@4: #define EGL_CONFORMANT			0x3042
williamr@4: 
williamr@4: /* Reserved 0x3041-0x304F for additional config attributes */
williamr@4: 
williamr@4: /* Config attribute values */
williamr@4: #define EGL_SLOW_CONFIG			0x3050	/* EGL_CONFIG_CAVEAT value */
williamr@4: #define EGL_NON_CONFORMANT_CONFIG	0x3051	/* EGL_CONFIG_CAVEAT value */
williamr@4: #define EGL_TRANSPARENT_RGB		0x3052	/* EGL_TRANSPARENT_TYPE value */
williamr@4: #define EGL_RGB_BUFFER			0x308E	/* EGL_COLOR_BUFFER_TYPE value */
williamr@4: #define EGL_LUMINANCE_BUFFER		0x308F	/* EGL_COLOR_BUFFER_TYPE value */
williamr@4: 
williamr@4: /* More config attribute values, for EGL_TEXTURE_FORMAT */
williamr@4: #define EGL_NO_TEXTURE			0x305C
williamr@4: #define EGL_TEXTURE_RGB			0x305D
williamr@4: #define EGL_TEXTURE_RGBA		0x305E
williamr@4: #define EGL_TEXTURE_2D			0x305F
williamr@4: 
williamr@4: /* Config attribute mask bits */
williamr@4: #define EGL_PBUFFER_BIT			0x0001	/* EGL_SURFACE_TYPE mask bits */
williamr@4: #define EGL_PIXMAP_BIT			0x0002	/* EGL_SURFACE_TYPE mask bits */
williamr@4: #define EGL_WINDOW_BIT			0x0004	/* EGL_SURFACE_TYPE mask bits */
williamr@4: #define EGL_VG_COLORSPACE_LINEAR_BIT	0x0020	/* EGL_SURFACE_TYPE mask bits */
williamr@4: #define EGL_VG_ALPHA_FORMAT_PRE_BIT	0x0040	/* EGL_SURFACE_TYPE mask bits */
williamr@4: #define EGL_MULTISAMPLE_RESOLVE_BOX_BIT 0x0200	/* EGL_SURFACE_TYPE mask bits */
williamr@4: #define EGL_SWAP_BEHAVIOR_PRESERVED_BIT 0x0400	/* EGL_SURFACE_TYPE mask bits */
williamr@4: 
williamr@4: #define EGL_OPENGL_ES_BIT		0x0001	/* EGL_RENDERABLE_TYPE mask bits */
williamr@4: #define EGL_OPENVG_BIT			0x0002	/* EGL_RENDERABLE_TYPE mask bits */
williamr@4: #define EGL_OPENGL_ES2_BIT		0x0004	/* EGL_RENDERABLE_TYPE mask bits */
williamr@4: #define EGL_OPENGL_BIT			0x0008	/* EGL_RENDERABLE_TYPE mask bits */
williamr@4: 
williamr@4: /* QueryString targets */
williamr@4: #define EGL_VENDOR			0x3053
williamr@4: #define EGL_VERSION			0x3054
williamr@4: #define EGL_EXTENSIONS			0x3055
williamr@4: #define EGL_CLIENT_APIS			0x308D
williamr@4: 
williamr@4: /* QuerySurface / SurfaceAttrib / CreatePbufferSurface targets */
williamr@4: #define EGL_HEIGHT			0x3056
williamr@4: #define EGL_WIDTH			0x3057
williamr@4: #define EGL_LARGEST_PBUFFER		0x3058
williamr@4: #define EGL_TEXTURE_FORMAT		0x3080
williamr@4: #define EGL_TEXTURE_TARGET		0x3081
williamr@4: #define EGL_MIPMAP_TEXTURE		0x3082
williamr@4: #define EGL_MIPMAP_LEVEL		0x3083
williamr@4: #define EGL_RENDER_BUFFER		0x3086
williamr@4: #define EGL_VG_COLORSPACE		0x3087
williamr@4: #define EGL_VG_ALPHA_FORMAT		0x3088
williamr@4: #define EGL_HORIZONTAL_RESOLUTION	0x3090
williamr@4: #define EGL_VERTICAL_RESOLUTION		0x3091
williamr@4: #define EGL_PIXEL_ASPECT_RATIO		0x3092
williamr@4: #define EGL_SWAP_BEHAVIOR		0x3093
williamr@4: #define EGL_MULTISAMPLE_RESOLVE		0x3099
williamr@4: 
williamr@4: /* EGL_RENDER_BUFFER values / BindTexImage / ReleaseTexImage buffer targets */
williamr@4: #define EGL_BACK_BUFFER			0x3084
williamr@4: #define EGL_SINGLE_BUFFER		0x3085
williamr@4: 
williamr@4: /* OpenVG color spaces */
williamr@4: #define EGL_VG_COLORSPACE_sRGB		0x3089	/* EGL_VG_COLORSPACE value */
williamr@4: #define EGL_VG_COLORSPACE_LINEAR	0x308A	/* EGL_VG_COLORSPACE value */
williamr@4: 
williamr@4: /* OpenVG alpha formats */
williamr@4: #define EGL_VG_ALPHA_FORMAT_NONPRE	0x308B	/* EGL_ALPHA_FORMAT value */
williamr@4: #define EGL_VG_ALPHA_FORMAT_PRE		0x308C	/* EGL_ALPHA_FORMAT value */
williamr@4: 
williamr@4: /* Constant scale factor by which fractional display resolutions &
williamr@4:  * aspect ratio are scaled when queried as integer values.
williamr@4:  */
williamr@4: #define EGL_DISPLAY_SCALING		10000
williamr@4: 
williamr@4: /* Unknown display resolution/aspect ratio */
williamr@4: #define EGL_UNKNOWN			((EGLint)-1)
williamr@4: 
williamr@4: /* Back buffer swap behaviors */
williamr@4: #define EGL_BUFFER_PRESERVED		0x3094	/* EGL_SWAP_BEHAVIOR value */
williamr@4: #define EGL_BUFFER_DESTROYED		0x3095	/* EGL_SWAP_BEHAVIOR value */
williamr@4: 
williamr@4: /* CreatePbufferFromClientBuffer buffer types */
williamr@4: #define EGL_OPENVG_IMAGE		0x3096
williamr@4: 
williamr@4: /* QueryContext targets */
williamr@4: #define EGL_CONTEXT_CLIENT_TYPE		0x3097
williamr@4: 
williamr@4: /* CreateContext attributes */
williamr@4: #define EGL_CONTEXT_CLIENT_VERSION	0x3098
williamr@4: 
williamr@4: /* Multisample resolution behaviors */
williamr@4: #define EGL_MULTISAMPLE_RESOLVE_DEFAULT 0x309A	/* EGL_MULTISAMPLE_RESOLVE value */
williamr@4: #define EGL_MULTISAMPLE_RESOLVE_BOX	0x309B	/* EGL_MULTISAMPLE_RESOLVE value */
williamr@4: 
williamr@4: /* BindAPI/QueryAPI targets */
williamr@4: #define EGL_OPENGL_ES_API		0x30A0
williamr@4: #define EGL_OPENVG_API			0x30A1
williamr@4: #define EGL_OPENGL_API			0x30A2
williamr@4: 
williamr@4: /* GetCurrentSurface targets */
williamr@4: #define EGL_DRAW			0x3059
williamr@4: #define EGL_READ			0x305A
williamr@4: 
williamr@4: /* WaitNative engines */
williamr@4: #define EGL_CORE_NATIVE_ENGINE		0x305B
williamr@4: 
williamr@4: /* EGL 1.2 tokens renamed for consistency in EGL 1.3 */
williamr@4: #define EGL_COLORSPACE			EGL_VG_COLORSPACE
williamr@4: #define EGL_ALPHA_FORMAT		EGL_VG_ALPHA_FORMAT
williamr@4: #define EGL_COLORSPACE_sRGB		EGL_VG_COLORSPACE_sRGB
williamr@4: #define EGL_COLORSPACE_LINEAR		EGL_VG_COLORSPACE_LINEAR
williamr@4: #define EGL_ALPHA_FORMAT_NONPRE		EGL_VG_ALPHA_FORMAT_NONPRE
williamr@4: #define EGL_ALPHA_FORMAT_PRE		EGL_VG_ALPHA_FORMAT_PRE
williamr@4: 
williamr@4: /* EGL extensions must request enum blocks from the Khronos
williamr@4:  * API Registrar, who maintains the enumerant registry. Submit
williamr@4:  * a bug in Khronos Bugzilla against task "Registry".
williamr@4:  */
williamr@4: 
williamr@4: 
williamr@4: 
williamr@4: /* EGL Functions */
williamr@4: 
williamr@4: EGLAPI EGLint EGLAPIENTRY eglGetError(void);
williamr@4: 
williamr@4: EGLAPI EGLDisplay EGLAPIENTRY eglGetDisplay(EGLNativeDisplayType display_id);
williamr@4: EGLAPI EGLBoolean EGLAPIENTRY eglInitialize(EGLDisplay dpy, EGLint *major, EGLint *minor);
williamr@4: EGLAPI EGLBoolean EGLAPIENTRY eglTerminate(EGLDisplay dpy);
williamr@4: 
williamr@4: EGLAPI const char * EGLAPIENTRY eglQueryString(EGLDisplay dpy, EGLint name);
williamr@4: 
williamr@4: EGLAPI EGLBoolean EGLAPIENTRY eglGetConfigs(EGLDisplay dpy, EGLConfig *configs,
williamr@4: 			 EGLint config_size, EGLint *num_config);
williamr@4: EGLAPI EGLBoolean EGLAPIENTRY eglChooseConfig(EGLDisplay dpy, const EGLint *attrib_list,
williamr@4: 			   EGLConfig *configs, EGLint config_size,
williamr@4: 			   EGLint *num_config);
williamr@4: EGLAPI EGLBoolean EGLAPIENTRY eglGetConfigAttrib(EGLDisplay dpy, EGLConfig config,
williamr@4: 			      EGLint attribute, EGLint *value);
williamr@4: 
williamr@4: EGLAPI EGLSurface EGLAPIENTRY eglCreateWindowSurface(EGLDisplay dpy, EGLConfig config,
williamr@4: 				  EGLNativeWindowType win,
williamr@4: 				  const EGLint *attrib_list);
williamr@4: EGLAPI EGLSurface EGLAPIENTRY eglCreatePbufferSurface(EGLDisplay dpy, EGLConfig config,
williamr@4: 				   const EGLint *attrib_list);
williamr@4: EGLAPI EGLSurface EGLAPIENTRY eglCreatePixmapSurface(EGLDisplay dpy, EGLConfig config,
williamr@4: 				  EGLNativePixmapType pixmap,
williamr@4: 				  const EGLint *attrib_list);
williamr@4: EGLAPI EGLBoolean EGLAPIENTRY eglDestroySurface(EGLDisplay dpy, EGLSurface surface);
williamr@4: EGLAPI EGLBoolean EGLAPIENTRY eglQuerySurface(EGLDisplay dpy, EGLSurface surface,
williamr@4: 			   EGLint attribute, EGLint *value);
williamr@4: 
williamr@4: EGLAPI EGLBoolean EGLAPIENTRY eglBindAPI(EGLenum api);
williamr@4: EGLAPI EGLenum EGLAPIENTRY eglQueryAPI(void);
williamr@4: 
williamr@4: EGLAPI EGLBoolean EGLAPIENTRY eglWaitClient(void);
williamr@4: 
williamr@4: EGLAPI EGLBoolean EGLAPIENTRY eglReleaseThread(void);
williamr@4: 
williamr@4: EGLAPI EGLSurface EGLAPIENTRY eglCreatePbufferFromClientBuffer(
williamr@4: 	      EGLDisplay dpy, EGLenum buftype, EGLClientBuffer buffer,
williamr@4: 	      EGLConfig config, const EGLint *attrib_list);
williamr@4: 
williamr@4: EGLAPI EGLBoolean EGLAPIENTRY eglSurfaceAttrib(EGLDisplay dpy, EGLSurface surface,
williamr@4: 			    EGLint attribute, EGLint value);
williamr@4: EGLAPI EGLBoolean EGLAPIENTRY eglBindTexImage(EGLDisplay dpy, EGLSurface surface, EGLint buffer);
williamr@4: EGLAPI EGLBoolean EGLAPIENTRY eglReleaseTexImage(EGLDisplay dpy, EGLSurface surface, EGLint buffer);
williamr@4: 
williamr@4: 
williamr@4: EGLAPI EGLBoolean EGLAPIENTRY eglSwapInterval(EGLDisplay dpy, EGLint interval);
williamr@4: 
williamr@4: 
williamr@4: EGLAPI EGLContext EGLAPIENTRY eglCreateContext(EGLDisplay dpy, EGLConfig config,
williamr@4: 			    EGLContext share_context,
williamr@4: 			    const EGLint *attrib_list);
williamr@4: EGLAPI EGLBoolean EGLAPIENTRY eglDestroyContext(EGLDisplay dpy, EGLContext ctx);
williamr@4: EGLAPI EGLBoolean EGLAPIENTRY eglMakeCurrent(EGLDisplay dpy, EGLSurface draw,
williamr@4: 			  EGLSurface read, EGLContext ctx);
williamr@4: 
williamr@4: EGLAPI EGLContext EGLAPIENTRY eglGetCurrentContext(void);
williamr@4: EGLAPI EGLSurface EGLAPIENTRY eglGetCurrentSurface(EGLint readdraw);
williamr@4: EGLAPI EGLDisplay EGLAPIENTRY eglGetCurrentDisplay(void);
williamr@4: EGLAPI EGLBoolean EGLAPIENTRY eglQueryContext(EGLDisplay dpy, EGLContext ctx,
williamr@4: 			   EGLint attribute, EGLint *value);
williamr@4: 
williamr@4: EGLAPI EGLBoolean EGLAPIENTRY eglWaitGL(void);
williamr@4: EGLAPI EGLBoolean EGLAPIENTRY eglWaitNative(EGLint engine);
williamr@4: EGLAPI EGLBoolean EGLAPIENTRY eglSwapBuffers(EGLDisplay dpy, EGLSurface surface);
williamr@4: EGLAPI EGLBoolean EGLAPIENTRY eglCopyBuffers(EGLDisplay dpy, EGLSurface surface,
williamr@4: 			  EGLNativePixmapType target);
williamr@4: 
williamr@4: #ifdef __cplusplus
williamr@4: EGLAPI void (* EGLAPIENTRY eglGetProcAddress (const char *procname))(...);
williamr@4: #else
williamr@4: EGLAPI void (* EGLAPIENTRY eglGetProcAddress (const char *procname))();
williamr@4: #endif
williamr@4: 
williamr@4: #ifdef __cplusplus
williamr@4: }
williamr@4: #endif
williamr@4: 
williamr@4: #endif /* __egl_h_ */