Module device 

Structs

Device

An OpenCL device id and methods to query it.

SubDevice

cl_amd_device_topology

cl_device_integer_dot_product_acceleration_properties_khr

cl_device_pci_bus_info_khr

cl_name_version

Constants

ALTERA_DEVICE_VENDOR_ID

AMD_DEVICE_VENDOR_ID

Device Vendor Ids.

AMD_ON_APPLE_DEVICE_VENDOR_ID

APPLE_DEVICE_VENDOR_ID

ARM_DEVICE_VENDOR_ID

BROADCOM_DEVICE_VENDOR_ID

CL_DEVICE_ADDRESS_BITS

CL_DEVICE_AFFINITY_DOMAIN_L1_CACHE

CL_DEVICE_AFFINITY_DOMAIN_L2_CACHE

CL_DEVICE_AFFINITY_DOMAIN_L3_CACHE

CL_DEVICE_AFFINITY_DOMAIN_L4_CACHE

CL_DEVICE_AFFINITY_DOMAIN_NEXT_PARTITIONABLE

CL_DEVICE_AFFINITY_DOMAIN_NUMA

CL_DEVICE_ATOMIC_FENCE_CAPABILITIES

CL_DEVICE_ATOMIC_MEMORY_CAPABILITIES

CL_DEVICE_ATOMIC_ORDER_ACQ_REL

CL_DEVICE_ATOMIC_ORDER_RELAXED

CL_DEVICE_ATOMIC_ORDER_SEQ_CST

CL_DEVICE_ATOMIC_SCOPE_ALL_DEVICES

CL_DEVICE_ATOMIC_SCOPE_DEVICE

CL_DEVICE_ATOMIC_SCOPE_WORK_GROUP

CL_DEVICE_ATOMIC_SCOPE_WORK_ITEM

CL_DEVICE_AVAILABLE

CL_DEVICE_AVAILABLE_ASYNC_QUEUES_AMD

CL_DEVICE_BOARD_NAME_AMD

CL_DEVICE_BUILT_IN_KERNELS

CL_DEVICE_BUILT_IN_KERNELS_WITH_VERSION

CL_DEVICE_COMMAND_BUFFER_CAPABILITIES_KHR

CL_DEVICE_COMMAND_BUFFER_REQUIRED_QUEUE_PROPERTIES_KHR

CL_DEVICE_COMPILER_AVAILABLE

CL_DEVICE_COMPUTE_CAPABILITY_MAJOR_NV

CL_DEVICE_COMPUTE_CAPABILITY_MINOR_NV

CL_DEVICE_DEVICE_ENQUEUE_CAPABILITIES

CL_DEVICE_DOUBLE_FP_CONFIG

CL_DEVICE_ENDIAN_LITTLE

CL_DEVICE_ERROR_CORRECTION_SUPPORT

CL_DEVICE_EXECUTION_CAPABILITIES

CL_DEVICE_EXTENSIONS

CL_DEVICE_EXTENSIONS_WITH_VERSION

CL_DEVICE_EXTERNAL_MEMORY_IMPORT_HANDLE_TYPES_KHR

CL_DEVICE_FEATURE_CAPABILITIES_INTEL

CL_DEVICE_GENERIC_ADDRESS_SPACE_SUPPORT

CL_DEVICE_GFXIP_MAJOR_AMD

CL_DEVICE_GFXIP_MINOR_AMD

CL_DEVICE_GLOBAL_FREE_MEMORY_AMD

CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE

CL_DEVICE_GLOBAL_MEM_CACHE_SIZE

CL_DEVICE_GLOBAL_MEM_CACHE_TYPE

CL_DEVICE_GLOBAL_MEM_CHANNELS_AMD

CL_DEVICE_GLOBAL_MEM_CHANNEL_BANKS_AMD

CL_DEVICE_GLOBAL_MEM_CHANNEL_BANK_WIDTH_AMD

CL_DEVICE_GLOBAL_MEM_SIZE

CL_DEVICE_GLOBAL_VARIABLE_PREFERRED_TOTAL_SIZE

CL_DEVICE_GPU_OVERLAP_NV

CL_DEVICE_HALF_FP_CONFIG

CL_DEVICE_HOST_UNIFIED_MEMORY

CL_DEVICE_ID_INTEL

CL_DEVICE_ILS_WITH_VERSION

CL_DEVICE_IL_VERSION

CL_DEVICE_IMAGE2D_MAX_HEIGHT

CL_DEVICE_IMAGE2D_MAX_WIDTH

CL_DEVICE_IMAGE3D_MAX_DEPTH

CL_DEVICE_IMAGE3D_MAX_HEIGHT

CL_DEVICE_IMAGE3D_MAX_WIDTH

CL_DEVICE_IMAGE_BASE_ADDRESS_ALIGNMENT

CL_DEVICE_IMAGE_MAX_ARRAY_SIZE

CL_DEVICE_IMAGE_MAX_BUFFER_SIZE

CL_DEVICE_IMAGE_PITCH_ALIGNMENT

CL_DEVICE_IMAGE_SUPPORT

CL_DEVICE_INTEGER_DOT_PRODUCT_ACCELERATION_PROPERTIES_4x8BIT_PACKED_KHR

CL_DEVICE_INTEGER_DOT_PRODUCT_ACCELERATION_PROPERTIES_8BIT_KHR

CL_DEVICE_INTEGER_DOT_PRODUCT_CAPABILITIES_KHR

CL_DEVICE_INTEGRATED_MEMORY_NV

CL_DEVICE_IP_VERSION_INTEL

CL_DEVICE_KERNEL_CLOCK_CAPABILITIES_KHR

CL_DEVICE_KERNEL_EXEC_TIMEOUT_NV

CL_DEVICE_LATEST_CONFORMANCE_VERSION_PASSED

CL_DEVICE_LINKER_AVAILABLE

CL_DEVICE_LOCAL_MEM_BANKS_AMD

CL_DEVICE_LOCAL_MEM_SIZE

CL_DEVICE_LOCAL_MEM_SIZE_PER_COMPUTE_UNIT_AMD

CL_DEVICE_LOCAL_MEM_TYPE

CL_DEVICE_LUID_KHR

CL_DEVICE_LUID_VALID_KHR

CL_DEVICE_MAX_CLOCK_FREQUENCY

CL_DEVICE_MAX_COMPUTE_UNITS

CL_DEVICE_MAX_CONSTANT_ARGS

CL_DEVICE_MAX_CONSTANT_BUFFER_SIZE

CL_DEVICE_MAX_GLOBAL_VARIABLE_SIZE

CL_DEVICE_MAX_MEM_ALLOC_SIZE

CL_DEVICE_MAX_NUM_SUB_GROUPS

CL_DEVICE_MAX_ON_DEVICE_EVENTS

CL_DEVICE_MAX_ON_DEVICE_QUEUES

CL_DEVICE_MAX_PARAMETER_SIZE

CL_DEVICE_MAX_PIPE_ARGS

CL_DEVICE_MAX_READ_IMAGE_ARGS

CL_DEVICE_MAX_READ_WRITE_IMAGE_ARGS

CL_DEVICE_MAX_SAMPLERS

CL_DEVICE_MAX_WORK_GROUP_SIZE

CL_DEVICE_MAX_WORK_GROUP_SIZE_AMD

CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS

CL_DEVICE_MAX_WORK_ITEM_SIZES

CL_DEVICE_MAX_WRITE_IMAGE_ARGS

CL_DEVICE_MEMORY_CAPABILITIES_IMG

CL_DEVICE_MEM_BASE_ADDR_ALIGN

CL_DEVICE_MIN_DATA_TYPE_ALIGN_SIZE

CL_DEVICE_NAME

CL_DEVICE_NATIVE_VECTOR_WIDTH_CHAR

CL_DEVICE_NATIVE_VECTOR_WIDTH_DOUBLE

CL_DEVICE_NATIVE_VECTOR_WIDTH_FLOAT

CL_DEVICE_NATIVE_VECTOR_WIDTH_HALF

CL_DEVICE_NATIVE_VECTOR_WIDTH_INT

CL_DEVICE_NATIVE_VECTOR_WIDTH_LONG

CL_DEVICE_NATIVE_VECTOR_WIDTH_SHORT

CL_DEVICE_NODE_MASK_KHR

CL_DEVICE_NON_UNIFORM_WORK_GROUP_SUPPORT

CL_DEVICE_NOT_FOUND

CL_DEVICE_NUMERIC_VERSION

CL_DEVICE_NUM_EUS_PER_SUB_SLICE_INTEL

CL_DEVICE_NUM_SLICES_INTEL

CL_DEVICE_NUM_SUB_SLICES_PER_SLICE_INTEL

CL_DEVICE_NUM_THREADS_PER_EU_INTEL

CL_DEVICE_OPENCL_C_ALL_VERSIONS

CL_DEVICE_OPENCL_C_FEATURES

CL_DEVICE_OPENCL_C_VERSION

CL_DEVICE_PARENT_DEVICE

CL_DEVICE_PARTITION_AFFINITY_DOMAIN

CL_DEVICE_PARTITION_BY_AFFINITY_DOMAIN

CL_DEVICE_PARTITION_BY_COUNTS

CL_DEVICE_PARTITION_BY_COUNTS_LIST_END

CL_DEVICE_PARTITION_EQUALLY

CL_DEVICE_PARTITION_MAX_SUB_DEVICES

CL_DEVICE_PARTITION_PROPERTIES

CL_DEVICE_PARTITION_TYPE

CL_DEVICE_PCIE_ID_AMD

CL_DEVICE_PCI_BUS_ID_NV

CL_DEVICE_PCI_BUS_INFO_KHR

CL_DEVICE_PCI_SLOT_ID_NV

CL_DEVICE_PIPE_MAX_ACTIVE_RESERVATIONS

CL_DEVICE_PIPE_MAX_PACKET_SIZE

CL_DEVICE_PIPE_SUPPORT

CL_DEVICE_PLATFORM

CL_DEVICE_PREFERRED_CONSTANT_BUFFER_SIZE_AMD

CL_DEVICE_PREFERRED_GLOBAL_ATOMIC_ALIGNMENT

CL_DEVICE_PREFERRED_INTEROP_USER_SYNC

CL_DEVICE_PREFERRED_LOCAL_ATOMIC_ALIGNMENT

CL_DEVICE_PREFERRED_PLATFORM_ATOMIC_ALIGNMENT

CL_DEVICE_PREFERRED_VECTOR_WIDTH_CHAR

CL_DEVICE_PREFERRED_VECTOR_WIDTH_DOUBLE

CL_DEVICE_PREFERRED_VECTOR_WIDTH_FLOAT

CL_DEVICE_PREFERRED_VECTOR_WIDTH_HALF

CL_DEVICE_PREFERRED_VECTOR_WIDTH_INT

CL_DEVICE_PREFERRED_VECTOR_WIDTH_LONG

CL_DEVICE_PREFERRED_VECTOR_WIDTH_SHORT

CL_DEVICE_PREFERRED_WORK_GROUP_SIZE_AMD

CL_DEVICE_PREFERRED_WORK_GROUP_SIZE_MULTIPLE

CL_DEVICE_PRINTF_BUFFER_SIZE

CL_DEVICE_PROFILE

CL_DEVICE_PROFILING_TIMER_OFFSET_AMD

CL_DEVICE_PROFILING_TIMER_RESOLUTION

CL_DEVICE_QUEUE_ON_DEVICE_MAX_SIZE

CL_DEVICE_QUEUE_ON_DEVICE_PREFERRED_SIZE

CL_DEVICE_QUEUE_ON_DEVICE_PROPERTIES

CL_DEVICE_QUEUE_ON_HOST_PROPERTIES

CL_DEVICE_QUEUE_REPLACEABLE_DEFAULT

CL_DEVICE_QUEUE_SUPPORTED

CL_DEVICE_REFERENCE_COUNT

CL_DEVICE_REGISTERS_PER_BLOCK_NV

CL_DEVICE_SEMAPHORE_EXPORT_HANDLE_TYPES_KHR

CL_DEVICE_SEMAPHORE_IMPORT_HANDLE_TYPES_KHR

CL_DEVICE_SEMAPHORE_TYPES_KHR

CL_DEVICE_SIMD_INSTRUCTION_WIDTH_AMD

CL_DEVICE_SIMD_PER_COMPUTE_UNIT_AMD

CL_DEVICE_SIMD_WIDTH_AMD

CL_DEVICE_SINGLE_FP_CONFIG

CL_DEVICE_SUB_GROUP_INDEPENDENT_FORWARD_PROGRESS

CL_DEVICE_SVM_ATOMICS

CL_DEVICE_SVM_CAPABILITIES

CL_DEVICE_SVM_COARSE_GRAIN_BUFFER

CL_DEVICE_SVM_FINE_GRAIN_BUFFER

CL_DEVICE_SVM_FINE_GRAIN_SYSTEM

CL_DEVICE_THREAD_TRACE_SUPPORTED_AMD

CL_DEVICE_TOPOLOGY_AMD

CL_DEVICE_TYPE

CL_DEVICE_TYPE_ACCELERATOR

CL_DEVICE_TYPE_ALL

CL_DEVICE_TYPE_CPU

CL_DEVICE_TYPE_CUSTOM

CL_DEVICE_TYPE_DEFAULT

CL_DEVICE_TYPE_GPU

CL_DEVICE_UUID_KHR

CL_DEVICE_VENDOR

CL_DEVICE_VENDOR_ID

CL_DEVICE_VERSION

CL_DEVICE_WARP_SIZE_NV

CL_DEVICE_WAVEFRONT_WIDTH_AMD

CL_DEVICE_WORK_GROUP_COLLECTIVE_FUNCTIONS_SUPPORT

CL_DRIVER_UUID_KHR

CL_DRIVER_VERSION

CL_EXEC_KERNEL

CL_EXEC_NATIVE_KERNEL

CL_FALSE

CL_FP_CORRECTLY_ROUNDED_DIVIDE_SQRT

CL_FP_DENORM

CL_FP_FMA

CL_FP_INF_NAN

CL_FP_ROUND_TO_INF

CL_FP_ROUND_TO_NEAREST

CL_FP_ROUND_TO_ZERO

CL_FP_SOFT_FLOAT

CL_GLOBAL

CL_LOCAL

CL_LUID_SIZE_KHR

CL_NONE

CL_READ_ONLY_CACHE

CL_READ_WRITE_CACHE

CL_SUCCESS

CL_TRUE

CL_UUID_SIZE_KHR

CL_VERSION_MAJOR_BITS

CL_VERSION_MAJOR_MASK

CL_VERSION_MINOR_BITS

CL_VERSION_MINOR_MASK

CL_VERSION_PATCH_BITS

CL_VERSION_PATCH_MASK

IBM_DEVICE_VENDOR_ID

INTEL_DEVICE_VENDOR_ID

NVIDIA_DEVICE_VENDOR_ID

QUALCOMM_DEVICE_VENDOR_ID

TEXAS_INSTRUMENTS_DEVICE_VENDOR_ID

VIA_TECHNOLOGIES_DEVICE_VENDOR_ID

XILINX_DEVICE_VENDOR_ID

Functions

create_sub_devices

Create sub-devices by partitioning an OpenCL device. Calls clCreateSubDevices to get the partitioned sub-devices.

device_type_text

A text representation of an OpenCL device type, see: Device Types.

get_all_devices

Get the ids of all available devices of the given type.

get_amd_device_topology

Convert a u8 slice (e.g. from get_device_info) into a cl_amd_device_topology structure.

get_device_and_host_timer

Query device and host timestamps. Calls clGetDeviceAndHostTimer CL_VERSION_2_1

get_device_data

Get data about an OpenCL device. Calls clGetDeviceInfo to get the desired data about the device.

get_device_ids

Get the list of available devices of the given type on a platform. Calls clGetDeviceIDs to get the available device ids on the platform.

get_device_info

Get specific information about an OpenCL device. Calls clGetDeviceInfo to get the desired information about the device.

get_device_integer_dot_product_acceleration_properties_khr

Convert a u8 slice (e.g. from get_device_info) into a cl_device_integer_dot_product_acceleration_properties_khr structure.

get_device_pci_bus_info_khr

Convert a u8 slice (e.g. from get_device_info) into a cl_device_pci_bus_info_khr structure.

get_host_timer

The current value of the host clock as seen by device. Calls clGetHostTimer CL_VERSION_2_1

release_device^⚠

Release an OpenCL device. Calls clReleaseDevice to decrement the device reference count if device is a valid sub-device created by a call to clCreateSubDevices.

retain_device^⚠

Retain an OpenCL device. Calls clRetainDevice to increment the device reference count if device is a valid sub-device created by a call to clCreateSubDevices.

set_default_device_command_queue

Replace the default command queue on an OpenCL device. Calls clSetDefaultDeviceCommandQueue to replace the default command queue CL_VERSION_2_1

vendor_id_text

A text representation of an OpenCL vendor id.

Type Aliases

cl_command_queue

cl_context

cl_device_feature_capabilities_intel

cl_device_fp_config

cl_device_id

cl_device_info

cl_device_partition_property

cl_device_svm_capabilities

cl_device_type

cl_double

cl_float

cl_int

cl_platform_id

cl_uint

cl_ulong