1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/graphics/graphicscomposition/openwfsupport/inc/eglsynchelper.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,154 @@
1.4 +// Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of "Eclipse Public License v1.0"
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +// eglsynchelper.c
1.18 +//
1.19 +
1.20 +#ifndef __eglsynchelper_h_
1.21 +#define __eglsynchelper_h_
1.22 +
1.23 +#include <EGL/eglext.h>
1.24 +#include <EGL/egl.h>
1.25 +#include "KHR/khrplatform.h"
1.26 +
1.27 +
1.28 +
1.29 +#ifdef __cplusplus
1.30 +extern "C" {
1.31 +#endif
1.32 +
1.33 +#ifndef EGL_EGLEXT_PROTOTYPES
1.34 +
1.35 +/*
1.36 + * EGLSyncKHR is an opaque handle to an EGL sync object
1.37 + */
1.38 +typedef void* EGLSyncKHR;
1.39 +
1.40 +
1.41 +typedef khronos_utime_nanoseconds_t EGLTimeKHR;
1.42 +
1.43 +/* API functions */
1.44 +
1.45 +/*-------------------------------------------------------------------*//*!
1.46 + * \brief Create a sync object for the specified display.
1.47 + * \ingroup api
1.48 + * \param dpy Identifier of the display which will own the sync object
1.49 + * \param type Type of the sync object. EGL_SYNC_REUSABLE_KHR is only supported
1.50 + * \param attrib_list Attribute-value list specifying attributes of the sync
1.51 + * object, terminated by an attribute entry EGL_NONE
1.52 + * \return Handle for the created sync object if successful, EGL_NO_SYNC_KHR otherwise
1.53 + * \error EGL_BAD_DISPLAY if <dpy> is not a name of a valid EGLDisplay;
1.54 + * EGL_NOT_INITIALIZED if the display object associated with the <dpy> has not been initialized;
1.55 + * EGL_BAD_ATTRIBUTE if <attrib_list> is neither NULL nor empty (containing only EGL_NONE) or
1.56 + * if <type> is not a supported type of sync object;
1.57 + * EGL_BAD_ALLOC if the memory allocation related to sync object is not successful
1.58 + * \note If <type> is EGL_SYNC_REUSABLE_KHR, a reusable sync object is created.
1.59 + * In this case <attrib_list> must be NULL or empty (containing only EGL_NONE).
1.60 + * *//*-------------------------------------------------------------------*/
1.61 +EGLSyncKHR eglCreateSyncKHR( EGLDisplay dpy,
1.62 + EGLenum condition,
1.63 + const EGLint *attrib_list );
1.64 +
1.65 +/*-------------------------------------------------------------------*//*!
1.66 + * \brief Destroy a sync object and free memory associated with it
1.67 + * \ingroup api
1.68 + * \param dpy Identifier of the display which owns the sync object
1.69 + * \param sync Sync object handle.
1.70 + * \return EGL_TRUE if deletion was successful and EGL_FALSE otherwise
1.71 + * \error EGL_BAD_DISPLAY if <dpy> is not a name of a valid EGLDisplay;
1.72 + * EGL_NOT_INITIALIZED if the display object associated with the <dpy> has not been initialized;
1.73 + * EGL_BAD_PARAMETER if <sync> is not a valid sync object for <dpy>
1.74 + * \note If any eglClientWaitSyncKHR commands are blocking on <sync> when
1.75 + * eglDestroySyncKHR is called, they will be woken up, as if <sync> were signaled.
1.76 + * If no errors are generated, <sync> will no longer be the handle of a valid sync object.
1.77 + *//*-------------------------------------------------------------------*/
1.78 +EGLBoolean eglDestroySyncKHR( EGLDisplay dpy, EGLSyncKHR sync );
1.79 +
1.80 +/*-------------------------------------------------------------------*//*!
1.81 + * \brief Blocks the calling thread until the specified sync object
1.82 + * is signaled, or until <timeout> nanoseconds have passed.
1.83 + * \ingroup api
1.84 + * \param dpy Identifier of the display which owns the sync object.
1.85 + * \param sync Sync object handle.
1.86 + * \param flags If the EGL_FLUSH_COMMANDS_BIT_KHR bit is set in <flags>
1.87 + * and <sync> is unsignaled when the function is called, then the equivalent
1.88 + * of Flush() will be performed for the current API context.
1.89 + * \param timeout The thread will be unblocked when <timeout> is expired.
1.90 + * If the <timeout> is to zero, the function just test the current status
1.91 + * of the sync object. If the <timeout> is set to EGL_FOREVER_KHR, then the
1.92 + * function does not time out. For all other values, <timeout> is adjusted to
1.93 + * the closest value which may be substantially longer than one nanosecond.
1.94 + * \return EGL_CONDITION_SATISFIED if <sync> was signaled before
1.95 + * the timeout expired, which includes the case when <sync> was already
1.96 + * signaled when eglClientWaitSyncKHR was called; EGL_TIMEOUT_EXPIRED_KHR if the
1.97 + * specified timeout period expired before <sync> was signaled;
1.98 + * EGL_FALSE if an error occurs.
1.99 + * \error EGL_BAD_DISPLAY if <dpy> is not a name of a valid EGLDisplay;
1.100 + * EGL_NOT_INITIALIZED if the display object associated with the <dpy> has not been initialized;
1.101 + * EGL_BAD_PARAMETER if <sync> is not a valid sync object for <dpy> or
1.102 + * if <flags> does not equal to 0 or EGL_SYNC_FLUSH_COMMAND_BIT_KHR
1.103 + * Note\ More than one eglClientWaitSyncKHR may be outstanding on the same <sync> at any given time.
1.104 + * When there are multiple threads blocked on the same <sync> and the sync object is signaled,
1.105 + * all such threads are released, but the order in which they are released is not defined.
1.106 + * If a sync object is destroyed while an eglClientWaitSyncKHR is blocking on that object,
1.107 + * eglClientWaitSyncKHR will unblock and return immediately, just as if the sync object
1.108 + * had been signaled prior to being destroyed.
1.109 + *//*-------------------------------------------------------------------*/
1.110 +EGLint eglClientWaitSyncKHR( EGLDisplay dpy,
1.111 + EGLSyncKHR sync,
1.112 + EGLint flags,
1.113 + EGLTimeKHR timeout );
1.114 +
1.115 +/*-------------------------------------------------------------------*//*!
1.116 + * \brief Signals or unsignals the reusable sync object.
1.117 + * \ingroup api
1.118 + * \param dpy Identifier of the display which owns the sync object.
1.119 + * \param sync Sync object handle.
1.120 + * \param mode Status of the sync object. There are two possible states:
1.121 + * EGL_SIGNALED_KHR and EGL_UNSIGNALED_KHR.
1.122 + * \return EGL_TRUE if an operation was successful and EGL_FALSE otherwise.
1.123 + * \note The error code returned from eglSignalSyncImpl() will be generated
1.124 + *//*-------------------------------------------------------------------*/
1.125 +EGLBoolean eglSignalSyncKHR( EGLDisplay dpy,
1.126 + EGLSyncKHR sync,
1.127 + EGLenum mode );
1.128 +
1.129 +
1.130 +
1.131 +/*-------------------------------------------------------------------*//*!
1.132 + * \brief Query an attribute of the sync object
1.133 + * \ingroup api
1.134 + * \param dpy Identifier of the display which owns the sync object
1.135 + * \param sync Sync object handle.
1.136 + * \param attribute An attribute to be retrieved.
1.137 + * \param value Pointer to the value for the requested attribute which will be filled on function return.
1.138 + * \return EGL_TRUE if an operation was successful and EGL_FALSE otherwise
1.139 + * \error EGL_BAD_DISPLAY if <dpy> is not a name of a valid EGLDisplay;
1.140 + * EGL_NOT_INITIALIZED if the display object associated with the <dpy> has not been initialized;
1.141 + * EGL_BAD_PARAMETER if <sync> is not a valid sync object for <dpy> or if <value> is not
1.142 + * a valid pointer; EGL_BAD_ATTRIBUTE if <attribute> does not lie within expected range;
1.143 + * EGL_BAD_MATCH if <attribute> is not supported for the type of sync object passed in <sync>
1.144 + *//*-------------------------------------------------------------------*/
1.145 +EGLBoolean eglGetSyncAttribKHR( EGLDisplay dpy,
1.146 + EGLSyncKHR sync,
1.147 + EGLint attribute,
1.148 + EGLint *value );
1.149 +#endif
1.150 +
1.151 +
1.152 +#ifdef __cplusplus
1.153 +}
1.154 +#endif
1.155 +
1.156 +
1.157 +#endif /* __eglsynchelper_h_ */