egl.h File Reference

EGL_VERSION_1_0

EGL_VERSION_1_1

EGL_VERSION_1_2

EGL_VERSION_1_3

EGL_VERSION_1_4

EGL_FALSE

EGL_TRUE

EGL_DONT_CARE

EGL_SUCCESS

EGL_NOT_INITIALIZED

EGL_BAD_ACCESS

EGL_BAD_ALLOC

EGL_BAD_ATTRIBUTE

EGL_BAD_CONFIG

EGL_BAD_CONTEXT

EGL_BAD_CURRENT_SURFACE

EGL_BAD_DISPLAY

EGL_BAD_MATCH

EGL_BAD_NATIVE_PIXMAP

EGL_BAD_NATIVE_WINDOW

EGL_BAD_PARAMETER

EGL_BAD_SURFACE

EGL_CONTEXT_LOST

EGL_BUFFER_SIZE

EGL_ALPHA_SIZE

EGL_BLUE_SIZE

EGL_GREEN_SIZE

EGL_RED_SIZE

EGL_DEPTH_SIZE

EGL_STENCIL_SIZE

EGL_CONFIG_CAVEAT

EGL_CONFIG_ID

EGL_LEVEL

EGL_MAX_PBUFFER_HEIGHT

EGL_MAX_PBUFFER_PIXELS

EGL_MAX_PBUFFER_WIDTH

EGL_NATIVE_RENDERABLE

EGL_NATIVE_VISUAL_ID

EGL_NATIVE_VISUAL_TYPE

EGL_PRESERVED_RESOURCES

EGL_SAMPLES

EGL_SAMPLE_BUFFERS

EGL_SURFACE_TYPE

EGL_TRANSPARENT_TYPE

EGL_TRANSPARENT_BLUE_VALUE

EGL_TRANSPARENT_GREEN_VALUE

EGL_TRANSPARENT_RED_VALUE

EGL_NONE

EGL_BIND_TO_TEXTURE_RGB

EGL_BIND_TO_TEXTURE_RGBA

EGL_MIN_SWAP_INTERVAL

EGL_MAX_SWAP_INTERVAL

EGL_LUMINANCE_SIZE

EGL_ALPHA_MASK_SIZE

EGL_COLOR_BUFFER_TYPE

EGL_RENDERABLE_TYPE

EGL_MATCH_NATIVE_PIXMAP

EGL_CONFORMANT

EGL_SLOW_CONFIG

EGL_NON_CONFORMANT_CONFIG

EGL_TRANSPARENT_RGB

EGL_RGB_BUFFER

EGL_LUMINANCE_BUFFER

EGL_NO_TEXTURE

EGL_TEXTURE_RGB

EGL_TEXTURE_RGBA

EGL_TEXTURE_2D

EGL_PBUFFER_BIT

EGL_PIXMAP_BIT

EGL_WINDOW_BIT

EGL_VG_COLORSPACE_LINEAR_BIT

EGL_VG_ALPHA_FORMAT_PRE_BIT

EGL_MULTISAMPLE_RESOLVE_BOX_BIT

EGL_SWAP_BEHAVIOR_PRESERVED_BIT

EGL_OPENGL_ES_BIT

EGL_OPENVG_BIT

EGL_OPENGL_ES2_BIT

EGL_OPENGL_BIT

EGL_VENDOR

EGL_VERSION

EGL_EXTENSIONS

EGL_CLIENT_APIS

EGL_HEIGHT

EGL_WIDTH

EGL_LARGEST_PBUFFER

EGL_TEXTURE_FORMAT

EGL_TEXTURE_TARGET

EGL_MIPMAP_TEXTURE

EGL_MIPMAP_LEVEL

EGL_RENDER_BUFFER

EGL_VG_COLORSPACE

EGL_VG_ALPHA_FORMAT

EGL_HORIZONTAL_RESOLUTION

EGL_VERTICAL_RESOLUTION

EGL_PIXEL_ASPECT_RATIO

EGL_SWAP_BEHAVIOR

EGL_MULTISAMPLE_RESOLVE

EGL_BACK_BUFFER

EGL_SINGLE_BUFFER

EGL_VG_COLORSPACE_sRGB

EGL_VG_COLORSPACE_LINEAR

EGL_VG_ALPHA_FORMAT_NONPRE

EGL_VG_ALPHA_FORMAT_PRE

EGL_DISPLAY_SCALING

EGL_UNKNOWN

EGL_BUFFER_PRESERVED

EGL_BUFFER_DESTROYED

EGL_OPENVG_IMAGE

EGL_CONTEXT_CLIENT_TYPE

EGL_CONTEXT_CLIENT_VERSION

EGL_MULTISAMPLE_RESOLVE_DEFAULT

EGL_MULTISAMPLE_RESOLVE_BOX

EGL_OPENGL_ES_API

EGL_OPENVG_API

EGL_OPENGL_API

EGL_DRAW

EGL_READ

EGL_CORE_NATIVE_ENGINE

EGL_COLORSPACE

EGL_ALPHA_FORMAT

EGL_COLORSPACE_sRGB

EGL_COLORSPACE_LINEAR

EGL_ALPHA_FORMAT_NONPRE

EGL_ALPHA_FORMAT_PRE

eglGetError ( void )

EGLAPI EGLint EGLAPIENTRY

eglGetError

(

void

)

Get the error message for the previous call to EGL.

Note:

This function returns only the error code of the previous call from the same thread to EGL and resets the error state for the current thread to EGL_SUCCESS.

Return Value: One of error tokens listed in egl.h

eglGetDisplay ( EGLNativeDisplayType )

EGLAPI EGLDisplay EGLAPIENTRY

eglGetDisplay

(

EGLNativeDisplayType

display_id

)

Get a display handle.

Parameters
display_id	Display ID.

Return Value: Returns a handle to the display (or EGL_NO_DISPLAY).

eglInitialize ( EGLDisplay, EGLint , EGLint )

EGLAPI EGLBoolean EGLAPIENTRY	eglInitialize	(	EGLDisplay	dpy,
			EGLint *	major,
			EGLint *	minor
		)

Initialize EGL.

Parameters
dpy	Display handle.
major	Pointer to major version return value (may be NULL).
minor	Pointer to minor version return value (may be NULL).

Return Value: EGL_TRUE on success, EGL_FALSE otherwise

eglTerminate ( EGLDisplay )

EGLAPI EGLBoolean EGLAPIENTRY

eglTerminate

(

EGLDisplay

dpy

)

Terminate EGL.

Parameters
dpy	Display handle.

Return Value: Returns true on success, false otherwise.

eglQueryString ( EGLDisplay, EGLint )

EGLAPI const char *EGLAPIENTRY	eglQueryString	(	EGLDisplay	dpy,
			EGLint	name
		)

Get a string.

Parameters
dpy	Display handle.
name	Name of string.

Return Value: Pointer to the queried string (or NULL in case of error).

eglGetConfigs ( EGLDisplay, EGLConfig , EGLint, EGLint )

EGLAPI EGLBoolean EGLAPIENTRY	eglGetConfigs	(	EGLDisplay	dpy,
			EGLConfig *	configs,
			EGLint	config_size,
			EGLint *	num_config
		)

Get an array of config IDs.

Parameters
dpy	Display handle.
configs	Pointer to returned config IDs (may be NULL).
config_size	Maximum number of config IDs to return.
num_config	Pointer to number of valid config IDs in 'configs'.

Return Value: Returns EGL_TRUE on success, EGL_FALSE otherwise.

eglChooseConfig ( EGLDisplay, const EGLint , EGLConfig , EGLint, EGLint * )

EGLAPI EGLBoolean EGLAPIENTRY	eglChooseConfig	(	EGLDisplay	dpy,
			const EGLint *	attrib_list,
			EGLConfig *	configs,
			EGLint	config_size,
			EGLint *	num_config
		)

Choose an array of config IDs.

Parameters
dpy	Display handle.
attrib_list	Attribute list.
configs	Array of returned config IDs.
config_size	Maximum number of config IDs to return.
num_config	Pointer to number of valid config IDs in 'configs'.

Return Value: Returns EGL_TRUE on success, EGL_FALSE otherwise.

eglGetConfigAttrib ( EGLDisplay, EGLConfig, EGLint, EGLint * )

EGLAPI EGLBoolean EGLAPIENTRY	eglGetConfigAttrib	(	EGLDisplay	dpy,
			EGLConfig	config,
			EGLint	attribute,
			EGLint *	value
		)

Gets a configuration attribute.

Parameters
dpy	Display handle.
config	Config to use.
attribute	Attribute to query.
value	Pointer to returned value (may be NULL).

Return Value: Returns true if operations succeeds, false otherwise.

eglCreateWindowSurface ( EGLDisplay, EGLConfig, EGLNativeWindowType, const EGLint * )

EGLAPI EGLSurface EGLAPIENTRY	eglCreateWindowSurface	(	EGLDisplay	dpy,
			EGLConfig	config,
			EGLNativeWindowType	win,
			const EGLint *	attrib_list
		)

Create a window surface.

Todo[sampo 26/May/05] attribList can contain one value: EGL_RENDER_BUFFER, which can be either EGL_SINGLE_BUFFER or EGL_BACK_BUFFER defaulting to the latter. OpenGL ES renders always in the back buffer whereas OpenVG must be able to do both

Parameters
dpy	Display handle.
config	Configuration to use.
win	Native window type.
attrib_list	Pointer to attribute list.

Return Value: Returns a handle to the created surface (or EGL_NO_SURFACE).

eglCreatePbufferSurface ( EGLDisplay, EGLConfig, const EGLint * )

EGLAPI EGLSurface EGLAPIENTRY	eglCreatePbufferSurface	(	EGLDisplay	dpy,
			EGLConfig	config,
			const EGLint *	attrib_list
		)

Creates a PBuffer surface.

Parameters
dpy	Display handle.
config	config to use.
attrib_list	List of attributes. (accepts none)

Return Value: Returns a handle to the created surface (or EGL_NO_SURFACE).

eglCreatePixmapSurface ( EGLDisplay, EGLConfig, EGLNativePixmapType, const EGLint * )

EGLAPI EGLSurface EGLAPIENTRY	eglCreatePixmapSurface	(	EGLDisplay	dpy,
			EGLConfig	config,
			EGLNativePixmapType	pixmap,
			const EGLint *	attrib_list
		)

Creates a pixmap surface.

Parameters
dpy	Display handle.
config	Config handle.
pixmap	Native pixmap surface.
attrib_list	List of attributes.

Return Value: Returns a handle to the created surface (or EGL_NO_SURFACE).

eglDestroySurface ( EGLDisplay, EGLSurface )

EGLAPI EGLBoolean EGLAPIENTRY	eglDestroySurface	(	EGLDisplay	dpy,
			EGLSurface	surface
		)

Destroy given surface.

Parameters
dpy	Display handle.
surface	Surface handle.

Return Value: EGL_TRUE on success, EGL_FALSE otherwise.

eglQuerySurface ( EGLDisplay, EGLSurface, EGLint, EGLint * )

EGLAPI EGLBoolean EGLAPIENTRY	eglQuerySurface	(	EGLDisplay	dpy,
			EGLSurface	surface,
			EGLint	attribute,
			EGLint *	value
		)

Query a surface attribute.

Parameters
dpy	Display handle.
surface	Surface handle.
attribute	Attribute to query.
value	Pointer to returned value (may be NULL).

Return Value: Returns EGL_TRUE on success, EGL_FALSE otherwise.

eglBindAPI ( EGLenum )

EGLAPI EGLBoolean EGLAPIENTRY

eglBindAPI

(

EGLenum

api

)

Bind a client API.

Parameters
api	Either EGL_OPENGL_ES_API or EGL_OPENVG_API.

Return Value: Returns TRUE upon success, FALSE otherwise.

eglQueryAPI ( void )

EGLAPI EGLenum EGLAPIENTRY

eglQueryAPI

(

void

)

Queries the bound client API.

Return Value: Returns the client API enum. Either ES, VG or NONE.

eglWaitClient ( void )

EGLAPI EGLBoolean EGLAPIENTRY

eglWaitClient

(

void

)

Wait a Client API renderer.

Todo[sampo 23/May/05] is there enough error checking?

Return Value: Returns true on success, false otherwise.

eglReleaseThread ( void )

EGLAPI EGLBoolean EGLAPIENTRY

eglReleaseThread

(

void

)

Release Thread specific state.

Return Value: EGL_TRUE on success.

eglCreatePbufferFromClientBuffer ( EGLDisplay, EGLenum, EGLClientBuffer, EGLConfig, const EGLint * )

EGLAPI EGLSurface EGLAPIENTRY	eglCreatePbufferFromClientBuffer	(	EGLDisplay	dpy,
			EGLenum	buftype,
			EGLClientBuffer	buffer,
			EGLConfig	config,
			const EGLint *	attrib_list
		)

Creates a pbuffer from a given client buffer.

Parameters
dpy	Display handle.
buftype	The type of the client buffer. Only VGImage is supported currently
buffer	The client buffer
config	Config handle
attrib_list	list of attributes

Return Value: Returns a handle to the created surface (or EGL_NO_SURFACE).

eglSurfaceAttrib ( EGLDisplay, EGLSurface, EGLint, EGLint )

EGLAPI EGLBoolean EGLAPIENTRY	eglSurfaceAttrib	(	EGLDisplay	dpy,
			EGLSurface	surface,
			EGLint	attribute,
			EGLint	value
		)

Sets an attribute of a surface.

Parameters
dpy	Display handle.
surface	Surface handle.
attribute	The attribute to be set.
value	The value to set the attribute to.

Return Value: EGL_TRUE on success, EGL_FALSE otherwise.

eglBindTexImage ( EGLDisplay, EGLSurface, EGLint )

EGLAPI EGLBoolean EGLAPIENTRY	eglBindTexImage	(	EGLDisplay	dpy,
			EGLSurface	surface,
			EGLint	buffer
		)

Binds an EGL pixel buffer surface as an Open GLES texture.

Todo[sampo 25/May/05] Finish the comment box. Jaska?

Parameters
dpy	Display handle.
surface	Surface handle.

Return Value: Returns true on success, false otherwise.

eglReleaseTexImage ( EGLDisplay, EGLSurface, EGLint )

EGLAPI EGLBoolean EGLAPIENTRY	eglReleaseTexImage	(	EGLDisplay	dpy,
			EGLSurface	surface,
			EGLint	buffer
		)

Release a pixel buffer from an OpenGLES texture.

Todo[sampo 25/May/05] Finish the comment box. Jaska?

Parameters
dpy	Display handle.
surface	Surface handle.

Return Value: Returns true on success, false otherwise.

eglSwapInterval ( EGLDisplay, EGLint )

EGLAPI EGLBoolean EGLAPIENTRY	eglSwapInterval	(	EGLDisplay	dpy,
			EGLint	interval
		)

Specify the minimum number of video frame periods per buffer swap.

Todo[jasinb 20/Jul/04] Proper implementation.

Note:

This is a no-op, but a legal one, since we have defined the implementation specific boundaries (EGL_MIN/MAX_SWAP_INTERVAL) both to be 1.

Parameters
dpy	Display handle.
interval	Minimum number of video frames

Return Value: Returns EGL_TRUE on success, EGL_FALSE otherwise

eglCreateContext ( EGLDisplay, EGLConfig, EGLContext, const EGLint * )

EGLAPI EGLContext EGLAPIENTRY	eglCreateContext	(	EGLDisplay	dpy,
			EGLConfig	config,
			EGLContext	share_context,
			const EGLint *	attrib_list
		)

Create a context.

Parameters
dpy	Display handle.
config	Configuration ID.
share_context	Context to share texture objects with. (currently unsupported)
attrib_list	List of attributes.

Return Value: Returns a handle to the created context or EGL_NO_CONTEXT on failure.

eglDestroyContext ( EGLDisplay, EGLContext )

EGLAPI EGLBoolean EGLAPIENTRY	eglDestroyContext	(	EGLDisplay	dpy,
			EGLContext	ctx
		)

Destroy context.

Parameters
dpy	Display handle.
ctx	Context handle.

Return Value: Returns EGL_TRUE on success, EGL_FALSE otherwise.

eglMakeCurrent ( EGLDisplay, EGLSurface, EGLSurface, EGLContext )

EGLAPI EGLBoolean EGLAPIENTRY	eglMakeCurrent	(	EGLDisplay	dpy,
			EGLSurface	draw,
			EGLSurface	read,
			EGLContext	ctx
		)

Set the current context and read/draw surfaces.

Parameters
dpy	Display handle.
draw	Draw surface handle.
read	Read surface handle.
ctx	Context handle.

Return Value: Returns true on success, false otherwise.

eglGetCurrentContext ( void )

EGLAPI EGLContext EGLAPIENTRY

eglGetCurrentContext

(

void

)

Get current render context.

Return Value: Returns the handle to current render context.

eglGetCurrentSurface ( EGLint )

EGLAPI EGLSurface EGLAPIENTRY

eglGetCurrentSurface

(

EGLint

readdraw

)

Get a render surface.

Parameters
readdraw	which one of the read or draw surfaces to query

Return Value: Returns the handle to current rendering surface.

eglGetCurrentDisplay ( void )

EGLAPI EGLDisplay EGLAPIENTRY

eglGetCurrentDisplay

(

void

)

Get the currently active display.

Todo[teemu 15/Sep/05] Set current display on per thread basis

Return Value: Returns the currently active display.

eglQueryContext ( EGLDisplay, EGLContext, EGLint, EGLint * )

EGLAPI EGLBoolean EGLAPIENTRY	eglQueryContext	(	EGLDisplay	dpy,
			EGLContext	ctx,
			EGLint	attribute,
			EGLint *	value
		)

Query context parameter.

Parameters
dpy	Display handle.
ctx	Context handle.
attribute	Attribute to query (must be EGL_CONFIG_ID for EGL 1.0-1,1 and additionally EGL_CONTEXT_CLIENT_TYPE for EGL 1.2 and EGL_CONTEXT_CLIENT_VERSION).
value	Pointer to returned value.

Return Value: Returns EGL_TRUE on success, EGL_FALSE otherwise.

eglWaitGL ( void )

EGLAPI EGLBoolean EGLAPIENTRY

eglWaitGL

(

void

)

Wait for the GL renderer.

Todo[jussi 25/May/05] add a call to glFinish?

Return Value: Returns true on success, false otherwise.

eglWaitNative ( EGLint )

EGLAPI EGLBoolean EGLAPIENTRY

eglWaitNative

(

EGLint

engine

)

Wait a native engine.

Todo[jussi 25/May/05] implement this one?

Parameters
engine	Engine identifier.

Return Value: Returns true on success, false otherwise.

eglSwapBuffers ( EGLDisplay, EGLSurface )

EGLAPI EGLBoolean EGLAPIENTRY	eglSwapBuffers	(	EGLDisplay	dpy,
			EGLSurface	surface
		)

Swap back buffer to front.

Todo[petri 15/Oct/03] Super-sampling? [jussi 25/May/05] OpenVG allows dithering of higher bit depth surface to lower bit depth display. Makes sense when rendering to 1-bit displays. Add support for this one if we ever encounter them anymore.

Parameters
dpy	Display handle.
surface	Surface handle.

Return Value: Returns true on success, false otherwise.

eglCopyBuffers ( EGLDisplay, EGLSurface, EGLNativePixmapType )

EGLAPI EGLBoolean EGLAPIENTRY	eglCopyBuffers	(	EGLDisplay	dpy,
			EGLSurface	surface,
			EGLNativePixmapType	target
		)

Copy draw color buffer into native pixmap.

Parameters
dpy	Display handle.
surface	Surface handle to copy.
target	Destination pixmap for copy.

Return Value: Returns EGL_TRUE on success, EGL_FALSE otherwise.

EGLAPIENTRY

EGLAPI void(*)(...)

EGLAPIENTRY