To create a user event object, call the function
cl_event clCreateUserEvent( cl_context context, cl_int* errcode_ret);
context must be a valid OpenCL context.
errcode_ret will return an appropriate error code. If errcode_ret is
NULL, no error code is returned.
User events allow applications to enqueue commands that wait on a user event to finish before the command is executed by the device.
clCreateUserEvent returns a valid non-zero event object and errcode_ret
is set to
CL_SUCCESS if the user event object is created successfully.
Otherwise, it returns a
NULL value with one of the following error values
returned in errcode_ret:
CL_INVALID_CONTEXTif context is not a valid context.
CL_OUT_OF_RESOURCESif there is a failure to allocate resources required by the OpenCL implementation on the device.
CL_OUT_OF_HOST_MEMORYif there is a failure to allocate resources required by the OpenCL implementation on the host.
The execution status of the user event object created is set to
For more information, see the OpenCL Specification
This page is extracted from the OpenCL Specification. Fixes and changes should be made to the Specification, not directly.
Copyright (c) 2014-2020 Khronos Group. This work is licensed under a Creative Commons Attribution 4.0 International License.