clCreateUserEvent3clc
Creates a user event object.
cl_event clCreateUserEvent(cl_context context, cl_int *errcode_ret);
Parameters
context
A valid OpenCL context used to create the user event object.
errcode_ret
Returns an appropriate error code. If errcode_ret is NULL, no error code is returned.
Notes
User events allow applications to enqueue commands that wait on a user event to finish before the command is executed by the device.
The execution status of the user event object created is set to CL_SUBMITTED.
Errors
Returns a valid non-zero buffer 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_CONTEXT if context is not a valid context.
• 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]
Notes
- 1.
-
OpenCL Specification
page 178, section 5.9 - Event Objects
Releases
5 releases since Debian 8 (Jessie); the text changed 3 times.