table of contents
CLWAITFOREVENTS(3clc) | OpenCL Manual | CLWAITFOREVENTS(3clc) |
NAME¶
clWaitForEvents - Waits on the host thread for commands identified by event objects to complete.¶
cl_int
clWaitForEvents(cl_uint num_events,
const cl_event *event_list);
PARAMETERS¶
event_listThe events specified in event_list act as
synchronization points.
NOTES¶
Waits on the host thread for commands identified by event objects in event_list to complete. A command is considered complete if its execution status is CL_COMPLETE or a negative value. The events specified in event_list act as synchronization points. If the cl_khr_gl_event(3clc) extension is enabled, event objects can also be used to reflect the status of an OpenGL sync object. The sync object in turn refers to a fence command executing in an OpenGL command stream. This provides another method of coordinating sharing of buffers and images between OpenGL and OpenCL.ERRORS¶
Returns CL_SUCCESS if the execution status of all events in event_list is CL_COMPLETE. Otherwise, it returns one of the following errors:•CL_INVALID_VALUE if num_events is zero or
event_list is NULL..
•CL_INVALID_CONTEXT if events specified in
event_list do not belong to the same context.
•CL_INVALID_EVENT if event objects specified in
event_list are not valid event objects.
•CL_EXEC_STATUS_ERROR_FOR_EVENTS_IN_WAIT_LIST if
the execution status of any of the events in event_list is a negative
integer value.
•CL_OUT_OF_RESOURCES if there is a failure to
allocate resources required by the OpenCL implementation on the device.
•CL_OUT_OF_HOST_MEMORY if there is a failure to
allocate resources required by the OpenCL implementation on the host.
SPECIFICATION¶
OpenCL Specification[1]SEE ALSO¶
clGetEventInfo(3clc), clReleaseEvent(3clc), clRetainEvent(3clc), cl_khr_gl_event(3clc)AUTHORS¶
The Khronos GroupCOPYRIGHT¶
Copyright © 2007-2011 The Khronos Group Inc.NOTES¶
- 1.
- OpenCL Specification
page 179, section 5.9 - Event Objects
06/18/2014 | The Khronos Group |