NAME

       clCreateUserEvent - 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]

SEE ALSO

       classDiagram(3clc)

AUTHORS

       The Khronos Group

COPYRIGHT

       Copyright © 2007-2011 The Khronos Group Inc.
       Permission is hereby granted, free of charge, to any person obtaining a copy of this
       software and/or associated documentation files (the "Materials"), to deal in the Materials
       without restriction, including without limitation the rights to use, copy, modify, merge,
       publish, distribute, sublicense, and/or sell copies of the Materials, and to permit
       persons to whom the Materials are furnished to do so, subject to the condition that this
       copyright notice and permission notice shall be included in all copies or substantial
       portions of the Materials.

NOTES

        1. OpenCL Specification
           page 178, section 5.9 - Event Objects