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