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)[source]#

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)[source]#

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)[source]#

Returns a str representing value.

New in version 0.91.

class pyopencl.command_execution_status#
COMPLETE#
QUEUED#
RUNNING#
SUBMITTED#
to_string(value)[source]#

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)[source]#

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)[source]#

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)[source]#

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)[source]#

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)[source]#

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)[source]#

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)[source]#

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)[source]#

Returns a str representing value.

New in version 0.91.

class pyopencl.device_exec_capabilities#
KERNEL#
NATIVE_KERNEL#
to_string(value)[source]#

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)[source]#

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#
ME_VERSION_INTEL#

Available with the cl_intel_advanced_motion_estimation extension.

New in version 2016.2.

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.

NUM_SIMULTANEOUS_INTEROPS_INTEL#

Available with the cl_intel_simultaneous_sharing extension.

New in version 2016.2.

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.

SIMULTANEOUS_INTEROPS_INTEL#

Available with the cl_intel_simultaneous_sharing extension.

New in version 2016.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)[source]#

Returns a str representing value.

New in version 0.91.

class pyopencl.device_local_mem_type#
GLOBAL#
LOCAL#
to_string(value)[source]#

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)[source]#

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)[source]#

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)[source]#

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)[source]#

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)[source]#

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)[source]#

Returns a str representing value.

New in version 0.91.

class pyopencl.filter_mode#
LINEAR#
NEAREST#
to_string(value)[source]#

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)[source]#

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)[source]#

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)[source]#

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)[source]#

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)[source]#

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)[source]#

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)[source]#

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)[source]#

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)[source]#

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)[source]#

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)[source]#

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)[source]#

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)[source]#

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)[source]#

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)[source]#

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)[source]#

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)[source]#

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)[source]#

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)[source]#

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)[source]#

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)[source]#

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)[source]#

Returns a str representing value.

New in version 0.91.

class pyopencl.program_kind#
BINARY#
IL#
SOURCE#
UNKNOWN#
name#
value#
to_string(value)[source]#

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)[source]#

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)[source]#

Returns a str representing value.

New in version 0.91.

class pyopencl.sampler_properties#
ADDRESSING_MODE#
FILTER_MODE#
NORMALIZED_COORDS#
to_string(value)[source]#

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)[source]#

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)[source]#

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)[source]#

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