MeeGo 1.2 Harmattan Developer Documentation Develop for the Nokia N9

EGL 1.4 library

Introduction

The Khronos Native Platform Graphics Interface (EGL) is an open standard developed by the Khronos Group. It provides an interface between rendering APIs (for example OpenGL ES) and an underlying native platform window system. With EGL, the user can create interfaces onto which client APIs can draw, create graphics contexts, and synchronize drawing.

To learn more, see Khronos EGL API Registry info page.

List of functions in EGL 1.4

Errors

Name Content
eglGetError

Returns error information eglGetError function can return several different error codes which describe the type of the error. Error code EGL_SUCCESS is returned when the function is successed.

Initialisation

Name Content
eglGetDisplay

Returns an EGL display connection

eglInitialize

Initialises an EGL display connection

eglTerminate

Terminates an EGL display connection


EGL Versioning

Name Content
eglQueryString

Returns a pointer to a static, zero-terminated string describing the EGL implementation running on the specified display


Configuration management

Name Content
eglGetConfigs

Returns a list of all EGL frame buffer configurations for a specific display

eglChooseConfig

Returns a list of EGL frame buffer configurations that match specified attributes

eglGetConfigAttrib

Returns the value of an EGLConfig attribute


Rendering surfaces

Name Content
eglCreateWindowSurface

Creates an onscreen EGL window surface

eglCreatePbufferSurface

Creates a new EGL pixel buffer (pbuffer) surface

eglCreatePbufferFromClientBuffer

Creates a new EGL pixel buffer surface bound to an OpenVG image

eglCreatePixmapSurface

Creates a new EGL pixmap surface

eglDestroySurface

Destroys an EGL surface

eglSurfaceAttrib

Sets an EGL surface attribute

eglQuerySurface

Returns EGL surface information


Rendering to textures

Name Content
eglBindTexImage

Defines a two-dimensional texture image

eglReleaseTexImage

Releases a color buffer that is being used as a texture


Rendering contexts

Name Content
eglBindAPI

Sets the current rendering API

eglQueryAPI

Queries the current rendering API

eglCreateContext

Creates a new EGL rendering context

eglDestroyContext

Destroys an EGL rendering context

eglMakeCurrent

Attaches an EGL rendering context to EGL surfaces

eglGetCurrentContext

Returns the current EGL rendering context

eglGetCurrentSurface

Returns the read or draw surface for the current EGL rendering context

eglGetCurrentDisplay

Returns the display for the current EGL rendering context

eglQueryContext

Returns EGL rendering context information


Synchronisation primitives

Name Content
eglWaitClient

Completes client API execution prior to subsequent native rendering calls

eglWaitGL

Complete GL execution prior to subsequent native rendering calls

eglWaitNative

Complete native execution prior to subsequent GL rendering calls


Posting the colour buffer

Name Content
eglSwapBuffers

Posts EGL surface color buffer to a native window

eglCopyBuffers

Copies EGL surface color buffer to a native pixmap

eglSwapInterval

Specifies the minimum number of video frame periods per buffer swap for the window associated with the current context


Obtaining extension function pointers

Name Content
eglGetProcAddress

Returns a GL or an EGL extension function


Releasing thread state

Name Content
eglReleaseThread

Releases EGL per-thread state