table of contents
CLRETAINCOMMANDQUEUE(3clc) | OpenCL Manual | CLRETAINCOMMANDQUEUE(3clc) |
NAME¶
clRetainCommandQueue - Increments the command_queue reference count.¶
cl_int
clRetainCommandQueue(cl_command_queue command_queue);
PARAMETERS¶
command_queueSpecifies the command-queue to retain.
NOTES¶
clCreateCommandQueue(3clc) performs an implicit retain. This is very helpful for 3rd party libraries, which typically get a command-queue passed to them by the application. However, it is possible that the application may delete the command-queue without informing the library. Allowing functions to attach to (i.e. retain) and release a command-queue solves the problem of a command-queue being used by a library no longer being valid.ERRORS¶
Returns CL_SUCCESS if the function executed successfully, or one of the errors below:•CL_INVALID_COMMAND_QUEUE if command_queue
is not a valid command-queue.
•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¶
clCreateCommandQueue(3clc), clGetCommandQueueInfo(3clc), clReleaseCommandQueue(3clc)AUTHORS¶
The Khronos GroupCOPYRIGHT¶
Copyright © 2007-2011 The Khronos Group Inc.NOTES¶
- 1.
- OpenCL Specification
page 62, section 5.1 - Command Queues
06/18/2014 | The Khronos Group |