C Specification

To replace the default command-queue on a device, call the function

// Provided by CL_VERSION_2_1
cl_int clSetDefaultDeviceCommandQueue(
    cl_context context,
    cl_device_id device,
    cl_command_queue command_queue);
clSetDefaultDeviceCommandQueue is missing before version 2.1.

Parameters

  • context is the OpenCL context used to create command_queue.

  • device is a valid OpenCL device associated with context.

  • command_queue specifies a command-queue object which replaces the default device command-queue

Description

clSetDefaultDeviceCommandQueue may be used to replace a default device command-queue created with clCreateCommandQueueWithProperties and the CL_QUEUE_ON_DEVICE_DEFAULT flag.

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

  • CL_INVALID_CONTEXT if context is not a valid context.

  • CL_INVALID_DEVICE if device is not a valid device or is not associated with context.

  • CL_INVALID_OPERATION if device does not support a replaceable default on-device queue.

  • CL_INVALID_COMMAND_QUEUE if command_queue is not a valid command-queue for device.

  • 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.

See Also

CL_VERSION_2_1, cl_command_queue, cl_context, cl_device_id

Document Notes

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

Copyright 2014-2025 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0