oracular (3) clReleaseCommandQueue.3clc.gz

NAME

       clReleaseCommandQueue - Decrements the command_queue reference count.

       cl_int clReleaseCommandQueue(cl_command_queue command_queue);

PARAMETERS

       command_queue
           Specifies the command-queue to release.

NOTES

       After the command_queue reference count becomes zero and all commands queued to command_queue have
       finished (e.g., kernel executions, memory object updates, etc.), the command-queue is deleted.

       clReleaseCommandQueue performs an implicit flush to issue any previously queued OpenCL commands in
       command_queue.

ERRORS

       Returns CL_SUCCESS if the function is executed successfully. Otherwise, it returns one of the following:

       •   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), clRetainCommandQueue(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 63, section 5.1 - Command Queues