1 // Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
2 // All rights reserved.
3 // This component and the accompanying materials are made available
4 // under the terms of "Eclipse Public License v1.0"
5 // which accompanies this distribution, and is available
6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
8 // Initial Contributors:
9 // Nokia Corporation - initial contribution.
17 #include "eglsynchelper.h"
18 #include "EGL/egltypes.h"
20 #ifndef EGL_EGLEXT_PROTOTYPES
22 #define EGLSYNC_TYPE 0xE5
24 /* sync object data type for POSIX thread implementation*/
26 typedef struct CondVarSync_* NativeSyncType;
32 /*-------------------------------------------------------------------*//*!
33 * \brief Create a sync object for the specified display.
35 * \param dpy Identifier of the display which will own the sync object
36 * \param type Type of the sync object. EGL_SYNC_REUSABLE_KHR is only supported
37 * \param attrib_list Attribute-value list specifying attributes of the sync
38 * object, terminated by an attribute entry EGL_NONE
39 * \return Handle for the created sync object if successful, EGL_NO_SYNC_KHR otherwise
40 * \error EGL_BAD_DISPLAY if <dpy> is not a name of a valid EGLDisplay;
41 * EGL_NOT_INITIALIZED if the display object associated with the <dpy> has not been initialized;
42 * EGL_BAD_ATTRIBUTE if <attrib_list> is neither NULL nor empty (containing only EGL_NONE) or
43 * if <type> is not a supported type of sync object;
44 * EGL_BAD_ALLOC if the memory allocation related to sync object is not successful
45 * \note If <type> is EGL_SYNC_REUSABLE_KHR, a reusable sync object is created.
46 * In this case <attrib_list> must be NULL or empty (containing only EGL_NONE).
47 * *//*-------------------------------------------------------------------*/
48 EGLSyncKHR eglCreateSyncKHR( EGLDisplay dpy,
50 const EGLint *attrib_list )
52 PFNEGLCREATESYNCKHRPROC createPointer = (PFNEGLCREATESYNCKHRPROC) eglGetProcAddress("eglCreateSyncKHR");
54 if (createPointer == NULL)
56 return EGL_NO_SYNC_KHR;
60 return createPointer(dpy, condition, attrib_list);
65 /*-------------------------------------------------------------------*//*!
66 * \brief Destroy a sync object and free memory associated with it
68 * \param dpy Identifier of the display which owns the sync object
69 * \param sync Sync object handle.
70 * \return EGL_TRUE if deletion was successful and EGL_FALSE otherwise
71 * \error EGL_BAD_DISPLAY if <dpy> is not a name of a valid EGLDisplay;
72 * EGL_NOT_INITIALIZED if the display object associated with the <dpy> has not been initialized;
73 * EGL_BAD_PARAMETER if <sync> is not a valid sync object for <dpy>
74 * \note If any eglClientWaitSyncKHR commands are blocking on <sync> when
75 * eglDestroySyncKHR is called, they will be woken up, as if <sync> were signaled.
76 * If no errors are generated, <sync> will no longer be the handle of a valid sync object.
77 *//*-------------------------------------------------------------------*/
78 EGLBoolean eglDestroySyncKHR( EGLDisplay dpy, EGLSyncKHR sync )
80 PFNEGLDESTROYSYNCKHRPROC destroyPointer = (PFNEGLDESTROYSYNCKHRPROC) eglGetProcAddress("eglDestroySyncKHR");
82 if (destroyPointer == NULL)
88 return destroyPointer(dpy, sync);
92 /*-------------------------------------------------------------------*//*!
93 * \brief Blocks the calling thread until the specified sync object
94 * is signaled, or until <timeout> nanoseconds have passed.
96 * \param dpy Identifier of the display which owns the sync object.
97 * \param sync Sync object handle.
98 * \param flags If the EGL_FLUSH_COMMANDS_BIT_KHR bit is set in <flags>
99 * and <sync> is unsignaled when the function is called, then the equivalent
100 * of Flush() will be performed for the current API context.
101 * \param timeout The thread will be unblocked when <timeout> is expired.
102 * If the <timeout> is to zero, the function just test the current status
103 * of the sync object. If the <timeout> is set to EGL_FOREVER_KHR, then the
104 * function does not time out. For all other values, <timeout> is adjusted to
105 * the closest value which may be substantially longer than one nanosecond.
106 * \return EGL_CONDITION_SATISFIED if <sync> was signaled before
107 * the timeout expired, which includes the case when <sync> was already
108 * signaled when eglClientWaitSyncKHR was called; EGL_TIMEOUT_EXPIRED_KHR if the
109 * specified timeout period expired before <sync> was signaled;
110 * EGL_FALSE if an error occurs.
111 * \error EGL_BAD_DISPLAY if <dpy> is not a name of a valid EGLDisplay;
112 * EGL_NOT_INITIALIZED if the display object associated with the <dpy> has not been initialized;
113 * EGL_BAD_PARAMETER if <sync> is not a valid sync object for <dpy> or
114 * if <flags> does not equal to 0 or EGL_SYNC_FLUSH_COMMAND_BIT_KHR
115 * Note\ More than one eglClientWaitSyncKHR may be outstanding on the same <sync> at any given time.
116 * When there are multiple threads blocked on the same <sync> and the sync object is signaled,
117 * all such threads are released, but the order in which they are released is not defined.
118 * If a sync object is destroyed while an eglClientWaitSyncKHR is blocking on that object,
119 * eglClientWaitSyncKHR will unblock and return immediately, just as if the sync object
120 * had been signaled prior to being destroyed.
121 *//*-------------------------------------------------------------------*/
122 EGLint eglClientWaitSyncKHR( EGLDisplay dpy,
127 PFNEGLCLIENTWAITSYNCKHRPROC clientWaitPointer = (PFNEGLCLIENTWAITSYNCKHRPROC) eglGetProcAddress("eglClientWaitSyncKHR");
129 if (clientWaitPointer == NULL)
135 return clientWaitPointer(dpy, sync, flags, timeout);
139 /*-------------------------------------------------------------------*//*!
140 * \brief Signals or unsignals the reusable sync object.
142 * \param dpy Identifier of the display which owns the sync object.
143 * \param sync Sync object handle.
144 * \param mode Status of the sync object. There are two possible states:
145 * EGL_SIGNALED_KHR and EGL_UNSIGNALED_KHR.
146 * \return EGL_TRUE if an operation was successful and EGL_FALSE otherwise.
147 * \note The error code returned from eglSignalSyncImpl() will be generated
148 *//*-------------------------------------------------------------------*/
149 EGLBoolean eglSignalSyncKHR( EGLDisplay dpy,
153 PFNEGLSIGNALSYNCKHRPROC signalPointer = (PFNEGLSIGNALSYNCKHRPROC) eglGetProcAddress("eglSignalSyncKHR");
155 if (signalPointer == NULL)
161 return signalPointer(dpy, sync, mode);
166 /*-------------------------------------------------------------------*//*!
167 * \brief Query an attribute of the sync object
169 * \param dpy Identifier of the display which owns the sync object
170 * \param sync Sync object handle.
171 * \param attribute An attribute to be retrieved.
172 * \param value Pointer to the value for the requested attribute which will be filled on function return.
173 * \return EGL_TRUE if an operation was successful and EGL_FALSE otherwise
174 * \error EGL_BAD_DISPLAY if <dpy> is not a name of a valid EGLDisplay;
175 * EGL_NOT_INITIALIZED if the display object associated with the <dpy> has not been initialized;
176 * EGL_BAD_PARAMETER if <sync> is not a valid sync object for <dpy> or if <value> is not
177 * a valid pointer; EGL_BAD_ATTRIBUTE if <attribute> does not lie within expected range;
178 * EGL_BAD_MATCH if <attribute> is not supported for the type of sync object passed in <sync>
179 *//*-------------------------------------------------------------------*/
180 EGLBoolean eglGetSyncAttribKHR( EGLDisplay dpy,
185 PFNEGLGETSYNCATTRIBKHRPROC getAttribPointer = (PFNEGLGETSYNCATTRIBKHRPROC) eglGetProcAddress("eglGetSyncAttribKHR");
187 if (getAttribPointer == NULL)
193 return getAttribPointer(dpy, sync, attribute, value);