The list of devices available on a platform can be obtained using the function :
platform refers to the platform ID returned by clGetPlatformIDs or can be
NULL. If platform is
NULL, the behavior is implementation-defined.
device_type is a bitfield that identifies the type of OpenCL device. The device_type can be used to query specific OpenCL devices or all OpenCL devices available. The valid values for device_type are specified in the Device Types table.
num_entries is the number of
cl_device_entries that can be added to devices. If devices is not
NULL, the num_entries must be greater than zero.
devices returns a list of OpenCL devices found. The
cl_device_values returned in devices can be used to identify a specific OpenCL device. If devices is
NULL, this argument is ignored. The number of OpenCL devices returned is the minimum of the value specified by num_entries or the number of OpenCL devices whose type matches device_type.
num_devices returns the number of OpenCL devices available that match device_type. If num_devices is
NULL, this argument is ignored.
An OpenCL device similar to a traditional CPU (Central Processing Unit). The host processor that executes OpenCL host code may also be considered a CPU OpenCL device.
An OpenCL device similar to a GPU (Graphics Processing Unit). Many systems include a dedicated processor for graphics or rendering that may be considered a GPU OpenCL device.
Dedicated devices that may accelerate OpenCL programs, such as FPGAs (Field Programmable Gate Arrays), DSPs (Digital Signal Processors), or AI (Artificial Intelligence) processors.
missing before version 1.2.
Specialized devices that implement some of the OpenCL runtime APIs but do not support all required OpenCL functionality.
The default OpenCL device in the platform.
The default OpenCL device must not be a
All OpenCL devices available in the platform, except for
The device type is purely informational and has no semantic meaning.
Some devices may be more than one type.
For example, a
CL_DEVICE_ device may also be a
CL_DEVICE_ device, or a
may also be some other, more descriptive device type.
CL_DEVICE_ devices must not be combined with any other
One device in the platform should be a
The default device should also be a more specific device type, such
CL_SUCCESS if the function is executed
Otherwise, it returns one of the following errors:
CL_INVALID_if platform is not a valid platform.
CL_INVALID_if device_type is not a valid value.
CL_INVALID_if num_entries is equal to zero and devices is not
NULLor if both num_devices and devices are
CL_DEVICE_if no OpenCL devices that matched device_type were found.
CL_OUT_if there is a failure to allocate resources required by the OpenCL implementation on the device.
CL_OUT_if there is a failure to allocate resources required by the OpenCL implementation on the host.
OF_ HOST_ MEMORY
The application can query specific capabilities of the OpenCL device(s) returned by clGetDeviceIDs. This can be used by the application to determine which device(s) to use.
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.