OpenCL Runtime: ConstantsΒΆ

Warning

This set of PyOpenCL documentation is incomplete because it was generated on a PyOpenCL build that did not support OpenGL.

class pyopencl.addressing_modeΒΆ
CLAMPΒΆ
CLAMP_TO_EDGEΒΆ
MIRRORED_REPEATΒΆ

Available with OpenCL 1.1.

New in version 0.92.

NONEΒΆ
REPEATΒΆ
to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.channel_orderΒΆ
AΒΆ
ABGRΒΆ

Available with OpenCL 2.0.

New in version 2015.2.

BGRAΒΆ
INTENSITYΒΆ
LUMINANCEΒΆ
RΒΆ
RAΒΆ
RGΒΆ
RGBΒΆ
RGBAΒΆ
RGBxΒΆ

Available with OpenCL 1.1.

New in version 0.92.

RGxΒΆ

Available with OpenCL 1.1.

New in version 0.92.

RxΒΆ

Available with OpenCL 1.1.

New in version 0.92.

sBGRAΒΆ

Available with OpenCL 2.0.

New in version 2015.2.

sRGBΒΆ

Available with OpenCL 2.0.

New in version 2015.2.

sRGBAΒΆ

Available with OpenCL 2.0.

New in version 2015.2.

sRGBxΒΆ

Available with OpenCL 2.0.

New in version 2015.2.

to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.channel_typeΒΆ
FLOATΒΆ
HALF_FLOATΒΆ
SIGNED_INT16ΒΆ
SIGNED_INT32ΒΆ
SIGNED_INT8ΒΆ
SNORM_INT16ΒΆ
SNORM_INT8ΒΆ
UNORM_INT16ΒΆ
UNORM_INT24ΒΆ

Available with OpenCL 1.2.

New in version 2020.3.

UNORM_INT8ΒΆ
UNORM_INT_101010ΒΆ
UNORM_INT_101010_2ΒΆ

Available with OpenCL 2.1.

New in version 2020.3.

UNORM_SHORT_555ΒΆ
UNORM_SHORT_565ΒΆ
UNSIGNED_INT16ΒΆ
UNSIGNED_INT32ΒΆ
UNSIGNED_INT8ΒΆ
to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.command_execution_statusΒΆ
COMPLETEΒΆ
QUEUEDΒΆ
RUNNINGΒΆ
SUBMITTEDΒΆ
to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.command_queue_infoΒΆ
CONTEXTΒΆ
DEVICEΒΆ
PROPERTIESΒΆ
PROPERTIES_ARRAYΒΆ
REFERENCE_COUNTΒΆ
to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.command_queue_propertiesΒΆ
ON_DEVICEΒΆ

Available with OpenCL 2.0.

New in version 2015.2.

ON_DEVICE_DEFAULTΒΆ

Available with OpenCL 2.0.

New in version 2015.2.

OUT_OF_ORDER_EXEC_MODE_ENABLEΒΆ
PROFILING_ENABLEΒΆ
to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.command_typeΒΆ
ACQUIRE_GL_OBJECTSΒΆ
BARRIERΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

COPY_BUFFERΒΆ
COPY_BUFFER_RECTΒΆ

Available with OpenCL 1.1.

New in version 0.92.

COPY_BUFFER_TO_IMAGEΒΆ
COPY_IMAGEΒΆ
COPY_IMAGE_TO_BUFFERΒΆ
FILL_BUFFERΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

FILL_IMAGEΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

MAP_BUFFERΒΆ
MAP_IMAGEΒΆ
MARKERΒΆ
MIGRATE_MEM_OBJECTSΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

NATIVE_KERNELΒΆ
NDRANGE_KERNELΒΆ
READ_BUFFERΒΆ
READ_BUFFER_RECTΒΆ

Available with OpenCL 1.1.

New in version 0.92.

READ_IMAGEΒΆ
RELEASE_GL_OBJECTSΒΆ
SVM_FREEΒΆ

Available with OpenCL 2.0.

New in version 2015.2.

SVM_MAPΒΆ

Available with OpenCL 2.0.

New in version 2015.2.

SVM_MEMCPYΒΆ

Available with OpenCL 2.0.

New in version 2015.2.

SVM_MEMFILLΒΆ

Available with OpenCL 2.0.

New in version 2015.2.

SVM_MIGRATE_MEMΒΆ

Available with OpenCL 3.0.

New in version 2020.3.

SVM_UNMAPΒΆ

Available with OpenCL 2.0.

New in version 2015.2.

TASKΒΆ
UNMAP_MEM_OBJECTΒΆ
USERΒΆ

Available with OpenCL 1.1.

New in version 0.92.

WRITE_BUFFERΒΆ
WRITE_BUFFER_RECTΒΆ

Available with OpenCL 1.1.

New in version 0.92.

WRITE_IMAGEΒΆ
to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.context_infoΒΆ
DEVICESΒΆ
INTEROP_USER_SYNCΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

NUM_DEVICESΒΆ

Available with OpenCL 1.1.

New in version 0.92.

PROPERTIESΒΆ
REFERENCE_COUNTΒΆ
to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.context_propertiesΒΆ
OFFLINE_DEVICES_AMDΒΆ

Available with the cl_amd_offline_devices extension.

New in version 2011.1.

PLATFORMΒΆ
to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.device_affinity_domainΒΆ
L1_CACHEΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

L2_CACHEΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

L3_CACHEΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

L4_CACHEΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

NEXT_PARTITIONABLEΒΆ
NUMAΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.device_atomic_capabilitiesΒΆ
ORDER_ACQ_RELΒΆ

Available with OpenCL 3.0.

New in version 2020.3.

ORDER_RELAXEDΒΆ

Available with OpenCL 3.0.

New in version 2020.3.

ORDER_SEQ_CSTΒΆ

Available with OpenCL 3.0.

New in version 2020.3.

SCOPE_ALL_DEVICESΒΆ

Available with OpenCL 3.0.

New in version 2020.3.

SCOPE_DEVICEΒΆ

Available with OpenCL 3.0.

New in version 2020.3.

SCOPE_WORK_GROUPΒΆ

Available with OpenCL 3.0.

New in version 2020.3.

SCOPE_WORK_ITEMΒΆ

Available with OpenCL 3.0.

New in version 2020.3.

to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.device_device_enqueue_capabilitiesΒΆ
REPLACEABLE_DEFAULTΒΆ

Available with OpenCL 3.0.

New in version 2020.3.

SUPPORTEDΒΆ

Available with OpenCL 3.0.

New in version 2020.3.

to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.device_exec_capabilitiesΒΆ
KERNELΒΆ
NATIVE_KERNELΒΆ
to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.device_fp_configΒΆ
CORRECTLY_ROUNDED_DIVIDE_SQRTΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

DENORMΒΆ
FMAΒΆ
INF_NANΒΆ
ROUND_TO_INFΒΆ
ROUND_TO_NEARESTΒΆ
ROUND_TO_ZEROΒΆ
SOFT_FLOATΒΆ

Available with OpenCL 1.1.

New in version 0.92.

to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.device_infoΒΆ
ADDRESS_BITSΒΆ
ATOMIC_FENCE_CAPABILITIESΒΆ

Available with OpenCL 3.0.

New in version 2020.3.

ATOMIC_MEMORY_CAPABILITIESΒΆ

Available with OpenCL 3.0.

New in version 2020.3.

ATTRIBUTE_ASYNC_ENGINE_COUNT_NVΒΆ

Available with the cl_nv_device_attribute_query extension.

New in version 0.92.

AVAILABLEΒΆ
AVAILABLE_ASYNC_QUEUES_AMDΒΆ

Available with the cl_amd_device_attribute_query extension.

New in version 2013.2.

BOARD_NAME_AMDΒΆ

Available with the cl_amd_device_attribute_query extension.

New in version 2013.2.

BUILT_IN_KERNELSΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

BUILT_IN_KERNELS_WITH_VERSIONΒΆ

Available with OpenCL 3.0.

New in version 2020.3.

COMPILER_AVAILABLEΒΆ
COMPUTE_CAPABILITY_MAJOR_NVΒΆ

Available with the cl_nv_device_attribute_query extension.

New in version 0.92.

COMPUTE_CAPABILITY_MINOR_NVΒΆ

Available with the cl_nv_device_attribute_query extension.

New in version 0.92.

DEVICE_ENQUEUE_CAPABILITIESΒΆ

Available with OpenCL 3.0.

New in version 2020.3.

DOUBLE_FP_CONFIGΒΆ

Available with the cl_khr_fp64 extension.

New in version 2011.1.

DRIVER_VERSIONΒΆ
ENDIAN_LITTLEΒΆ
ERROR_CORRECTION_SUPPORTΒΆ
EXECUTION_CAPABILITIESΒΆ
EXTENSIONSΒΆ
EXTENSIONS_WITH_VERSIONΒΆ

Available with OpenCL 3.0.

New in version 2020.3.

EXT_MEM_PADDING_IN_BYTES_QCOMΒΆ

Available with the cl_qcom_ext_host_ptr extension.

New in version 2016.2.

GENERIC_ADDRESS_SPACE_SUPPORTΒΆ

Available with OpenCL 3.0.

New in version 2020.3.

GFXIP_MAJOR_AMDΒΆ

Available with the cl_amd_device_attribute_query extension.

New in version 2013.2.

GFXIP_MINOR_AMDΒΆ

Available with the cl_amd_device_attribute_query extension.

New in version 2013.2.

GLOBAL_FREE_MEMORY_AMDΒΆ

Available with the cl_amd_device_attribute_query extension.

New in version 2013.2.

GLOBAL_MEM_CACHELINE_SIZEΒΆ
GLOBAL_MEM_CACHE_SIZEΒΆ
GLOBAL_MEM_CACHE_TYPEΒΆ
GLOBAL_MEM_CHANNELS_AMDΒΆ

Available with the cl_amd_device_attribute_query extension.

New in version 2013.2.

GLOBAL_MEM_CHANNEL_BANKS_AMDΒΆ

Available with the cl_amd_device_attribute_query extension.

New in version 2013.2.

GLOBAL_MEM_CHANNEL_BANK_WIDTH_AMDΒΆ

Available with the cl_amd_device_attribute_query extension.

New in version 2013.2.

GLOBAL_MEM_SIZEΒΆ
GLOBAL_VARIABLE_PREFERRED_TOTAL_SIZEΒΆ

Available with OpenCL 2.0.

New in version 2015.2.

GPU_OVERLAP_NVΒΆ

Available with the cl_nv_device_attribute_query extension.

New in version 0.92.

HALF_FP_CONFIGΒΆ

Available with the cl_khr_fp16 extension.

New in version 2011.1.

HOST_UNIFIED_MEMORYΒΆ

Available with OpenCL 1.1.

New in version 0.92.

ILS_WITH_VERSIONΒΆ

Available with OpenCL 3.0.

New in version 2020.3.

IL_VERSIONΒΆ

Available with OpenCL 2.1.

New in version 2016.2.

IMAGE2D_MAX_HEIGHTΒΆ
IMAGE2D_MAX_WIDTHΒΆ
IMAGE3D_MAX_DEPTHΒΆ
IMAGE3D_MAX_HEIGHTΒΆ
IMAGE3D_MAX_WIDTHΒΆ
IMAGE_MAX_ARRAY_SIZEΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

IMAGE_MAX_BUFFER_SIZEΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

IMAGE_SUPPORTΒΆ
INTEGRATED_MEMORY_NVΒΆ

Available with the cl_nv_device_attribute_query extension.

New in version 0.92.

KERNEL_EXEC_TIMEOUT_NVΒΆ

Available with the cl_nv_device_attribute_query extension.

New in version 0.92.

LINKER_AVAILABLEΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

LOCAL_MEM_BANKS_AMDΒΆ

Available with the cl_amd_device_attribute_query extension.

New in version 2013.2.

LOCAL_MEM_SIZEΒΆ
LOCAL_MEM_SIZE_PER_COMPUTE_UNIT_AMDΒΆ

Available with the cl_amd_device_attribute_query extension.

New in version 2013.2.

LOCAL_MEM_TYPEΒΆ
MAX_ATOMIC_COUNTERS_EXTΒΆ

Available with the cl_ext_atomic_counters_64 extension.

New in version 2013.2.

MAX_CLOCK_FREQUENCYΒΆ
MAX_COMPUTE_UNITSΒΆ
MAX_CONSTANT_ARGSΒΆ
MAX_CONSTANT_BUFFER_SIZEΒΆ
MAX_GLOBAL_VARIABLE_SIZEΒΆ

Available with OpenCL 2.0.

New in version 2015.2.

MAX_MEM_ALLOC_SIZEΒΆ
MAX_NUM_SUB_GROUPSΒΆ

Available with OpenCL 2.1.

New in version 2016.2.

MAX_ON_DEVICE_EVENTSΒΆ

Available with OpenCL 2.0.

New in version 2015.2.

MAX_ON_DEVICE_QUEUESΒΆ

Available with OpenCL 2.0.

New in version 2015.2.

MAX_PARAMETER_SIZEΒΆ
MAX_PIPE_ARGSΒΆ

Available with OpenCL 2.0.

New in version 2015.2.

MAX_READ_IMAGE_ARGSΒΆ
MAX_READ_WRITE_IMAGE_ARGSΒΆ

Available with OpenCL 2.0.

New in version 2015.2.

MAX_SAMPLERSΒΆ
MAX_WORK_GROUP_SIZEΒΆ
MAX_WORK_GROUP_SIZE_AMDΒΆ
MAX_WORK_ITEM_DIMENSIONSΒΆ
MAX_WORK_ITEM_SIZESΒΆ
MAX_WRITE_IMAGE_ARGSΒΆ
MEM_BASE_ADDR_ALIGNΒΆ
MIN_DATA_TYPE_ALIGN_SIZEΒΆ
NAMEΒΆ
NATIVE_VECTOR_WIDTH_CHARΒΆ

Available with OpenCL 1.1.

New in version 0.92.

NATIVE_VECTOR_WIDTH_DOUBLEΒΆ

Available with OpenCL 1.1.

New in version 0.92.

NATIVE_VECTOR_WIDTH_FLOATΒΆ

Available with OpenCL 1.1.

New in version 0.92.

NATIVE_VECTOR_WIDTH_HALFΒΆ

Available with OpenCL 1.1.

New in version 0.92.

NATIVE_VECTOR_WIDTH_INTΒΆ

Available with OpenCL 1.1.

New in version 0.92.

NATIVE_VECTOR_WIDTH_LONGΒΆ

Available with OpenCL 1.1.

New in version 0.92.

NATIVE_VECTOR_WIDTH_SHORTΒΆ

Available with OpenCL 1.1.

New in version 0.92.

NON_UNIFORM_WORK_GROUP_SUPPORTΒΆ

Available with OpenCL 3.0.

New in version 2020.3.

NUMERIC_VERSIONΒΆ

Available with OpenCL 3.0.

New in version 2020.3.

OPENCL_C_ALL_VERSIONSΒΆ

Available with OpenCL 3.0.

New in version 2020.3.

OPENCL_C_FEATURESΒΆ

Available with OpenCL 3.0.

New in version 2020.3.

OPENCL_C_VERSIONΒΆ

Available with OpenCL 1.1.

New in version 0.92.

PAGE_SIZE_QCOMΒΆ

Available with the cl_qcom_ext_host_ptr extension.

New in version 2016.2.

PARENT_DEVICEΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

PARTITION_AFFINITY_DOMAINΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

PARTITION_MAX_SUB_DEVICESΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

PARTITION_PROPERTIESΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

PARTITION_TYPEΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

PCIE_ID_AMDΒΆ
PCI_BUS_ID_NVΒΆ

Available with the cl_nv_device_attribute_query extension.

New in version 0.92.

PCI_DOMAIN_ID_NVΒΆ

Available with the cl_nv_device_attribute_query extension.

New in version 0.92.

PCI_SLOT_ID_NVΒΆ

Available with the cl_nv_device_attribute_query extension.

New in version 0.92.

PIPE_MAX_ACTIVE_RESERVATIONSΒΆ

Available with OpenCL 2.0.

New in version 2015.2.

PIPE_MAX_PACKET_SIZEΒΆ

Available with OpenCL 2.0.

New in version 2015.2.

PIPE_SUPPORTΒΆ

Available with OpenCL 3.0.

New in version 2020.3.

PLATFORMΒΆ
PREFERRED_CONSTANT_BUFFER_SIZE_AMDΒΆ
PREFERRED_GLOBAL_ATOMIC_ALIGNMENTΒΆ

Available with OpenCL 2.0.

New in version 2015.2.

PREFERRED_INTEROP_USER_SYNCΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

PREFERRED_LOCAL_ATOMIC_ALIGNMENTΒΆ

Available with OpenCL 2.0.

New in version 2015.2.

PREFERRED_PLATFORM_ATOMIC_ALIGNMENTΒΆ

Available with OpenCL 2.0.

New in version 2015.2.

PREFERRED_VECTOR_WIDTH_CHARΒΆ
PREFERRED_VECTOR_WIDTH_DOUBLEΒΆ
PREFERRED_VECTOR_WIDTH_FLOATΒΆ
PREFERRED_VECTOR_WIDTH_HALFΒΆ

Available with OpenCL 1.1.

New in version 0.92.

PREFERRED_VECTOR_WIDTH_INTΒΆ
PREFERRED_VECTOR_WIDTH_LONGΒΆ
PREFERRED_VECTOR_WIDTH_SHORTΒΆ
PREFERRED_WORK_GROUP_SIZE_AMDΒΆ
PREFERRED_WORK_GROUP_SIZE_MULTIPLEΒΆ

Available with OpenCL 3.0.

New in version 2020.3.

PRINTF_BUFFER_SIZEΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

PROFILEΒΆ
PROFILING_TIMER_OFFSET_AMDΒΆ

Available with the cl_amd_device_attribute_query extension.

New in version 2013.2.

PROFILING_TIMER_RESOLUTIONΒΆ
QUEUE_ON_DEVICE_MAX_SIZEΒΆ

Available with OpenCL 2.0.

New in version 2015.2.

QUEUE_ON_DEVICE_PREFERRED_SIZEΒΆ

Available with OpenCL 2.0.

New in version 2015.2.

QUEUE_ON_DEVICE_PROPERTIESΒΆ

Available with OpenCL 2.0.

New in version 2015.2.

QUEUE_ON_HOST_PROPERTIESΒΆ
QUEUE_PROPERTIESΒΆ
REFERENCE_COUNTΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

REGISTERS_PER_BLOCK_NVΒΆ

Available with the cl_nv_device_attribute_query extension.

New in version 0.92.

SIMD_INSTRUCTION_WIDTH_AMDΒΆ

Available with the cl_amd_device_attribute_query extension.

New in version 2013.2.

SIMD_PER_COMPUTE_UNIT_AMDΒΆ

Available with the cl_amd_device_attribute_query extension.

New in version 2013.2.

SIMD_WIDTH_AMDΒΆ

Available with the cl_amd_device_attribute_query extension.

New in version 2013.2.

SINGLE_FP_CONFIGΒΆ
SPIR_VERSIONSΒΆ

Available with the cl_khr_spir extension.

New in version 2016.2.

SUB_GROUP_INDEPENDENT_FORWARD_PROGRESSΒΆ

Available with OpenCL 2.1.

New in version 2016.2.

SVM_CAPABILITIESΒΆ

Available with OpenCL 2.0.

New in version 2015.2.

THREAD_TRACE_SUPPORTED_AMDΒΆ

Available with the cl_amd_device_attribute_query extension.

New in version 2013.2.

TOPOLOGY_AMDΒΆ

Available with the cl_amd_device_attribute_query extension.

New in version 2013.2.

TYPEΒΆ
VENDORΒΆ
VENDOR_IDΒΆ
VERSIONΒΆ
WARP_SIZE_NVΒΆ

Available with the cl_nv_device_attribute_query extension.

New in version 0.92.

WAVEFRONT_WIDTH_AMDΒΆ

Available with the cl_amd_device_attribute_query extension.

New in version 2013.2.

WORK_GROUP_COLLECTIVE_FUNCTIONS_SUPPORTΒΆ

Available with OpenCL 3.0.

New in version 2020.3.

to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.device_local_mem_typeΒΆ
GLOBALΒΆ
LOCALΒΆ
to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.device_mem_cache_typeΒΆ
NONEΒΆ
READ_ONLY_CACHEΒΆ
READ_WRITE_CACHEΒΆ
to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.device_partition_propertyΒΆ
BY_AFFINITY_DOMAINΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

BY_COUNTSΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

BY_COUNTS_LIST_ENDΒΆ
EQUALLYΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.device_svm_capabilitiesΒΆ
ATOMICSΒΆ

Available with OpenCL 2.0.

New in version 2015.2.

COARSE_GRAIN_BUFFERΒΆ

Available with OpenCL 2.0.

New in version 2015.2.

FINE_GRAIN_BUFFERΒΆ

Available with OpenCL 2.0.

New in version 2015.2.

FINE_GRAIN_SYSTEMΒΆ

Available with OpenCL 2.0.

New in version 2015.2.

to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.device_topology_type_amdΒΆ
PCIEΒΆ

Available with the cl_amd_device_attribute_query extension.

New in version 2013.2.

to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.device_typeΒΆ
ACCELERATORΒΆ
ALLΒΆ
CPUΒΆ
CUSTOMΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

DEFAULTΒΆ
GPUΒΆ
to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.event_infoΒΆ
COMMAND_EXECUTION_STATUSΒΆ
COMMAND_QUEUEΒΆ
COMMAND_TYPEΒΆ
CONTEXTΒΆ

Available with OpenCL 1.1.

New in version 0.92.

REFERENCE_COUNTΒΆ
to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.filter_modeΒΆ
LINEARΒΆ
NEARESTΒΆ
to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.gl_context_infoΒΆ

Only available when PyOpenCL is compiled with GL support. See have_gl().

to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.image_infoΒΆ
ARRAY_SIZEΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

BUFFERΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

DEPTHΒΆ
ELEMENT_SIZEΒΆ
FORMATΒΆ
HEIGHTΒΆ
NUM_MIP_LEVELSΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

NUM_SAMPLESΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

ROW_PITCHΒΆ
SLICE_PITCHΒΆ
WIDTHΒΆ
to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.kernel_arg_access_qualifierΒΆ
NONEΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

READ_ONLYΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

READ_WRITEΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

WRITE_ONLYΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.kernel_arg_address_qualifierΒΆ
CONSTANTΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

GLOBALΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

LOCALΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

PRIVATEΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.kernel_arg_infoΒΆ
ACCESS_QUALIFIERΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

ADDRESS_QUALIFIERΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

NAMEΒΆ
TYPE_NAMEΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

TYPE_QUALIFIERΒΆ

Available with OpenCL 1.2.

New in version 2015.2.

to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.kernel_arg_type_qualifierΒΆ
CONSTΒΆ

Available with OpenCL 1.2.

New in version 2015.2.

NONEΒΆ

Available with OpenCL 1.2.

New in version 2015.2.

PIPEΒΆ

Available with OpenCL 2.0.

New in version 2015.2.

RESTRICTΒΆ

Available with OpenCL 1.2.

New in version 2015.2.

VOLATILEΒΆ

Available with OpenCL 1.2.

New in version 2015.2.

to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.kernel_infoΒΆ
ATTRIBUTESΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

CONTEXTΒΆ
FUNCTION_NAMEΒΆ
NUM_ARGSΒΆ
PROGRAMΒΆ
REFERENCE_COUNTΒΆ
to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.kernel_sub_group_infoΒΆ
COMPILE_NUM_SUB_GROUPSΒΆ

Available with OpenCL 2.1.

New in version 2020.3.

LOCAL_SIZE_FOR_SUB_GROUP_COUNTΒΆ

Available with OpenCL 2.1.

New in version 2020.3.

MAX_NUM_SUB_GROUPSΒΆ

Available with OpenCL 2.1.

New in version 2020.3.

MAX_SUB_GROUP_SIZE_FOR_NDRANGEΒΆ

Available with OpenCL 2.1.

New in version 2020.3.

SUB_GROUP_COUNT_FOR_NDRANGEΒΆ

Available with OpenCL 2.1.

New in version 2020.3.

to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.kernel_work_group_infoΒΆ
COMPILE_WORK_GROUP_SIZEΒΆ
GLOBAL_WORK_SIZEΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

LOCAL_MEM_SIZEΒΆ
PREFERRED_WORK_GROUP_SIZE_MULTIPLEΒΆ

Available with OpenCL 1.1.

New in version 0.92.

PRIVATE_MEM_SIZEΒΆ

Available with OpenCL 1.1.

New in version 0.92.

WORK_GROUP_SIZEΒΆ
to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.khronos_vendor_idΒΆ
CODEPLAYΒΆ

Available with OpenCL 3.0.

New in version 2020.3.

to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.map_flagsΒΆ
READΒΆ
WRITEΒΆ
WRITE_INVALIDATE_REGIONΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.mem_flagsΒΆ
ALLOC_HOST_PTRΒΆ
COPY_HOST_PTRΒΆ
HOST_NO_ACCESSΒΆ
HOST_READ_ONLYΒΆ
HOST_WRITE_ONLYΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

KERNEL_READ_AND_WRITEΒΆ

Available with OpenCL 2.0.

New in version 2015.2.

READ_ONLYΒΆ
READ_WRITEΒΆ
USE_HOST_PTRΒΆ
USE_PERSISTENT_MEM_AMDΒΆ

Available with the cl_amd_device_memory_flags extension.

New in version 2011.1.

WRITE_ONLYΒΆ
to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.mem_infoΒΆ
ASSOCIATED_MEMOBJECTΒΆ

Available with OpenCL 1.1.

New in version 0.92.

CONTEXTΒΆ
FLAGSΒΆ
HOST_PTRΒΆ
MAP_COUNTΒΆ
OFFSETΒΆ

Available with OpenCL 1.1.

New in version 0.92.

PROPERTIESΒΆ
REFERENCE_COUNTΒΆ
SIZEΒΆ
TYPEΒΆ
USES_SVM_POINTERΒΆ

Available with OpenCL 2.0.

New in version 2015.2.

to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.mem_migration_flagsΒΆ
CONTENT_UNDEFINEDΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

HOSTΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.mem_object_typeΒΆ
BUFFERΒΆ
IMAGE1DΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

IMAGE1D_ARRAYΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

IMAGE1D_BUFFERΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

IMAGE2DΒΆ
IMAGE2D_ARRAYΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

IMAGE3DΒΆ
PIPEΒΆ

Available with OpenCL 2.0.

New in version 2015.2.

to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.pipe_infoΒΆ
MAX_PACKETSΒΆ

Available with OpenCL 2.0.

New in version 2020.3.

PACKET_SIZEΒΆ

Available with OpenCL 2.0.

New in version 2020.3.

PROPERTIESΒΆ

Available with OpenCL 3.0.

New in version 2020.3.

to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.pipe_propertiesΒΆ
MAX_PACKETSΒΆ

Available with OpenCL 2.0.

New in version 2020.3.

PACKET_SIZEΒΆ

Available with OpenCL 2.0.

New in version 2020.3.

to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.platform_infoΒΆ
EXTENSIONSΒΆ
EXTENSIONS_WITH_VERSIONΒΆ
HOST_TIMER_RESOLUTIONΒΆ
NAMEΒΆ
NUMERIC_VERSIONΒΆ
PROFILEΒΆ
VENDORΒΆ
VERSIONΒΆ
to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.profiling_infoΒΆ
COMPLETEΒΆ

Available with OpenCL 2.0.

New in version 2015.2.

ENDΒΆ
QUEUEDΒΆ
STARTΒΆ
SUBMITΒΆ
to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.program_binary_typeΒΆ
COMPILED_OBJECTΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

EXECUTABLEΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

LIBRARYΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

NONEΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.program_build_infoΒΆ
BINARY_TYPEΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

GLOBAL_VARIABLE_TOTAL_SIZEΒΆ

Available with OpenCL 2.0.

New in version 2015.2.

LOGΒΆ
OPTIONSΒΆ
STATUSΒΆ
to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.program_infoΒΆ
BINARIESΒΆ
BINARY_SIZESΒΆ
CONTEXTΒΆ
DEVICESΒΆ
ILΒΆ
KERNEL_NAMESΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

NUM_DEVICESΒΆ
NUM_KERNELSΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

REFERENCE_COUNTΒΆ
SCOPE_GLOBAL_CTORS_PRESENTΒΆ

Available with OpenCL 2.1.

New in version 2020.3.

SCOPE_GLOBAL_DTORS_PRESENTΒΆ

Available with OpenCL 2.1.

New in version 2020.3.

SOURCEΒΆ
to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.program_kindΒΆ
BINARYΒΆ
ILΒΆ
SOURCEΒΆ
UNKNOWNΒΆ
nameΒΆ
valueΒΆ
to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.queue_propertiesΒΆ
DEVICE_DEFAULTΒΆ
PROPERTIESΒΆ

Available with OpenCL 2.0.

New in version 2015.2.

SIZEΒΆ

Available with OpenCL 2.0.

New in version 2015.2.

to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.sampler_infoΒΆ
ADDRESSING_MODEΒΆ
CONTEXTΒΆ
FILTER_MODEΒΆ
LOD_MAXΒΆ

Available with the (deprecated) extension.

New in version 2015.2.

LOD_MAX_KHRΒΆ

Available with the cl_khr_mipmap_image extension.

New in version 2020.3.

LOD_MINΒΆ

Available with the (deprecated) extension.

New in version 2015.2.

LOD_MIN_KHRΒΆ

Available with the cl_khr_mipmap_image extension.

New in version 2020.3.

MIP_FILTER_MODEΒΆ

Available with the (deprecated) extension.

New in version 2015.2.

MIP_FILTER_MODE_KHRΒΆ

Available with the cl_khr_mipmap_image extension.

New in version 2020.3.

NORMALIZED_COORDSΒΆ
PROPERTIESΒΆ

Available with OpenCL 3.0.

New in version 2020.3.

REFERENCE_COUNTΒΆ
to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.sampler_propertiesΒΆ
ADDRESSING_MODEΒΆ
FILTER_MODEΒΆ
NORMALIZED_COORDSΒΆ
to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.status_codeΒΆ
BUILD_PROGRAM_FAILUREΒΆ
COMPILER_NOT_AVAILABLEΒΆ
COMPILE_PROGRAM_FAILUREΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

DEVICE_NOT_AVAILABLEΒΆ
DEVICE_NOT_FOUNDΒΆ
DEVICE_PARTITION_FAILEDΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

EXEC_STATUS_ERROR_FOR_EVENTS_IN_WAIT_LISTΒΆ

Available with OpenCL 1.1.

New in version 0.92.

IMAGE_FORMAT_MISMATCHΒΆ
IMAGE_FORMAT_NOT_SUPPORTEDΒΆ
INVALID_ARG_INDEXΒΆ
INVALID_ARG_SIZEΒΆ
INVALID_ARG_VALUEΒΆ
INVALID_BINARYΒΆ
INVALID_BUFFER_SIZEΒΆ
INVALID_BUILD_OPTIONSΒΆ
INVALID_COMMAND_QUEUEΒΆ
INVALID_COMPILER_OPTIONSΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

INVALID_CONTEXTΒΆ
INVALID_DEVICEΒΆ
INVALID_DEVICE_PARTITION_COUNTΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

INVALID_DEVICE_QUEUEΒΆ

Available with OpenCL 2.0.

New in version 2015.2.

INVALID_DEVICE_TYPEΒΆ
INVALID_EVENTΒΆ
INVALID_EVENT_WAIT_LISTΒΆ
INVALID_GLOBAL_OFFSETΒΆ
INVALID_GLOBAL_WORK_SIZEΒΆ

Available with OpenCL 1.1.

New in version 0.92.

INVALID_GL_OBJECTΒΆ
INVALID_HOST_PTRΒΆ
INVALID_IMAGE_DESCRIPTORΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

INVALID_IMAGE_FORMAT_DESCRIPTORΒΆ
INVALID_IMAGE_SIZEΒΆ
INVALID_KERNELΒΆ
INVALID_KERNEL_ARGSΒΆ
INVALID_KERNEL_DEFINITIONΒΆ
INVALID_KERNEL_NAMEΒΆ
INVALID_LINKER_OPTIONSΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

INVALID_MEM_OBJECTΒΆ
INVALID_MIP_LEVELΒΆ
INVALID_OPERATIONΒΆ
INVALID_PIPE_SIZEΒΆ

Available with OpenCL 2.0.

New in version 2015.2.

INVALID_PLATFORMΒΆ
INVALID_PROGRAMΒΆ
INVALID_PROGRAM_EXECUTABLEΒΆ
INVALID_QUEUE_PROPERTIESΒΆ
INVALID_SAMPLERΒΆ
INVALID_SPEC_IDΒΆ

Available with OpenCL 2.1.

New in version 2020.3.

INVALID_VALUEΒΆ
INVALID_WORK_DIMENSIONΒΆ
INVALID_WORK_GROUP_SIZEΒΆ
INVALID_WORK_ITEM_SIZEΒΆ
KERNEL_ARG_INFO_NOT_AVAILABLEΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

LINKER_NOT_AVAILABLEΒΆ

Available with OpenCL 1.2.

New in version 2011.2.

Available with OpenCL 1.2.

New in version 2011.2.

MAP_FAILUREΒΆ
MAX_SIZE_RESTRICTION_EXCEEDEDΒΆ

Available with OpenCL 2.1.

New in version 2020.3.

MEM_COPY_OVERLAPΒΆ
MEM_OBJECT_ALLOCATION_FAILUREΒΆ
MISALIGNED_SUB_BUFFER_OFFSETΒΆ

Available with OpenCL 1.1.

New in version 0.92.

OUT_OF_HOST_MEMORYΒΆ
OUT_OF_RESOURCESΒΆ
PLATFORM_NOT_FOUND_KHRΒΆ

Available with the cl_khr_icd extension.

New in version 2011.1.

PROFILING_INFO_NOT_AVAILABLEΒΆ
SUCCESSΒΆ
to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.svm_mem_flagsΒΆ
READ_ONLYΒΆ

Available with OpenCL 2.0.

New in version 2015.2.

READ_WRITEΒΆ

Available with OpenCL 2.0.

New in version 2015.2.

SVM_ATOMICSΒΆ

Available with OpenCL 2.0.

New in version 2015.2.

SVM_FINE_GRAIN_BUFFERΒΆ

Available with OpenCL 2.0.

New in version 2015.2.

WRITE_ONLYΒΆ

Available with OpenCL 2.0.

New in version 2015.2.

to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.version_bitsΒΆ
MAJOR_BITSΒΆ

Available with OpenCL 3.0.

New in version 2020.3.

MAJOR_MASKΒΆ

Available with OpenCL 3.0.

New in version 2020.3.

MINOR_BITSΒΆ

Available with OpenCL 3.0.

New in version 2020.3.

MINOR_MASKΒΆ

Available with OpenCL 3.0.

New in version 2020.3.

PATCH_BITSΒΆ

Available with OpenCL 3.0.

New in version 2020.3.

PATCH_MASKΒΆ

Available with OpenCL 3.0.

New in version 2020.3.

to_string(value)ΒΆ

Returns a str representing value.

New in version 0.91.

class pyopencl.NameVersionΒΆ
Describes the version of a specific feature.

Note

Only available with OpenCL 3.0 or newer.

New in version 2020.3.

__init__(version, name)ΒΆ
versionΒΆ
nameΒΆ
class pyopencl.DeviceTopologyAmdΒΆ
.. method:: __init__(bus, device, function)
.. attribute:: type
.. attribute:: bus
.. attribute:: device
.. attribute:: function