Online Documentation - Statistics - FAQ - Plugin Parts (All, Dependencies) - Class hierarchy
New in Version 22.2 22.3 22.4 22.5 23.0 23.1 23.2 23.3 23.4 23.5 24.0 24.1
The list of the topics, classes, interfaces, controls, modules, global methods by category, global methods by name, screenshots, licenses and examples.
Platforms to show: All Mac Windows Linux Cross-Platform
Back to CLDeviceMBS class.
CLDeviceMBS.AddressBits as UInt32
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | OpenCL | MBS MacFrameworks Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Currently supported values are 32 or 64 bits.
Lasterror is set.
CLDeviceMBS.Available as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | OpenCL | MBS MacFrameworks Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Lasterror is set.
CLDeviceMBS.CompilerAvailable as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | OpenCL | MBS MacFrameworks Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Is true if the compiler is available. This can be false for the embededed platform profile only.
Lasterror is set.
CLDeviceMBS.DeviceType as UInt64
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | OpenCL | MBS MacFrameworks Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Currently supported values are one of or a combination of: kDeviceTypeCPU, kDeviceTypeGPU, kDeviceTypeAccelerator, or kDeviceTypeDefault.
Lasterror is set.
CLDeviceMBS.DeviceVersion as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | OpenCL | MBS MacFrameworks Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Returns the OpenCL version supported by the device. This version string has the following format:
OpenCL<space><major_version.minor_version><space><vendor-specific information>
The major_version.minor_version value returned will be 1.0.
Lasterror is set.
CLDeviceMBS.DriverVersion as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | OpenCL | MBS MacFrameworks Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Lasterror is set.
CLDeviceMBS.EndianLittle as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | OpenCL | MBS MacFrameworks Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Lasterror is set.
CLDeviceMBS.ErrorCorrectionSupport as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | OpenCL | MBS MacFrameworks Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Returns false if the device does not implement error correction. This can be a requirement for certain clients of OpenCL.
Lasterror is set.
CLDeviceMBS.ExecutionCapabilities as UInt64
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | OpenCL | MBS MacFrameworks Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
This is a bit-field that describes one or more of the following values:
kExecKernel - The OpenCL device can execute OpenCL kernels.
kExceNativeKernel - The OpenCL device can execute native kernels.
The mandated minimum capability is kExecKernel.
Lasterror is set.
CLDeviceMBS.Extensions as String
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | OpenCL | MBS MacFrameworks Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
(the extension names themselves do not contain any spaces).
The list of extension names returned currently can include one or more of the following approved extension names:
cl_khr_fp64
cl_khr_select_fprounding_mode
cl_khr_global_int32_base_atomics
cl_khr_global_int32_extended_atomics
cl_khr_local_int32_base_atomics
cl_khr_local_int32_extended_atomics
cl_khr_int64_base_atomics
cl_khr_int64_extended_atomics
cl_khr_3d_image_writes
cl_khr_byte_addressable_store
cl_khr_fp16
Lasterror is set.
CLDeviceMBS.GlobalMemoryCacheLineSize as UInt32
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | OpenCL | MBS MacFrameworks Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Lasterror is set.
CLDeviceMBS.GlobalMemoryCacheSize as UInt64
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | OpenCL | MBS MacFrameworks Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Lasterror is set.
CLDeviceMBS.GlobalMemoryCacheType as UInt32
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | OpenCL | MBS MacFrameworks Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
See kCacheMemType* constants.
Lasterror is set.
CLDeviceMBS.GlobalMemorySize as UInt64
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | OpenCL | MBS MacFrameworks Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Lasterror is set.
CLDeviceMBS.Image2DMaxHeight as UInt32
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | OpenCL | MBS MacFrameworks Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
The minimum value is 8192 if ImageSupport is true.
Lasterror is set.
CLDeviceMBS.Image2DMaxWidth as UInt32
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | OpenCL | MBS MacFrameworks Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
The minimum value is 8192 if ImageSupport is true.
Lasterror is set.
CLDeviceMBS.Image3DMaxDepth as UInt32
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | OpenCL | MBS MacFrameworks Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
The minimum value is 2048 if ImageSupport is true.
Lasterror is set.
CLDeviceMBS.Image3DMaxHeight as UInt32
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | OpenCL | MBS MacFrameworks Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
The minimum value is 2048 if ImageSupport is true.
Lasterror is set.
CLDeviceMBS.Image3DMaxWidth as UInt32
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | OpenCL | MBS MacFrameworks Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
The minimum value is 2048 if ImageSupport is true.
Lasterror is set.
CLDeviceMBS.ImageSupport as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | OpenCL | MBS MacFrameworks Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Lasterror is set.
CLDeviceMBS.LocalMemorySize as UInt64
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | OpenCL | MBS MacFrameworks Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
The minimum value is 16 KB.
Lasterror is set.
CLDeviceMBS.LocalMemType as UInt32
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | OpenCL | MBS MacFrameworks Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
This can be set to kMemTypeLocal implying dedicated local memory storage such as SRAM, or kMemTypeGlobal.
Lasterror is set.
CLDeviceMBS.MaxClockFrequency as UInt32
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | OpenCL | MBS MacFrameworks Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Lasterror is set.
CLDeviceMBS.MaxComputeUnits as UInt32
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | OpenCL | MBS MacFrameworks Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
The minimum value is 1.
Lasterror is set.
CLDeviceMBS.MaxConstantArgs as UInt32
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | OpenCL | MBS MacFrameworks Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
The minimum value is 8.
Lasterror is set.
CLDeviceMBS.MaxConstantBufferSize as UInt64
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | OpenCL | MBS MacFrameworks Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
The minimum value is 64 KB.
Lasterror is set.
CLDeviceMBS.MaxMemoryAllocSize as UInt64
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | OpenCL | MBS MacFrameworks Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
The minimum value is max (1/4th of GlobalMemorySize, 128*1024*1024)
Lasterror is set.
CLDeviceMBS.MaxParameterSize as UInt32
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | OpenCL | MBS MacFrameworks Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
The minimum value is 256.
Lasterror is set.
CLDeviceMBS.MaxReadImageArgs as UInt32
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | OpenCL | MBS MacFrameworks Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Lasterror is set.
The minimum value is 128 if ImageSupport is true.
CLDeviceMBS.MaxSamplers as UInt32
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | OpenCL | MBS MacFrameworks Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
The minimum value is 16 if ImageSupport is true.
Lasterror is set.
CLDeviceMBS.MaxWorkGroupSize as UInt32
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | OpenCL | MBS MacFrameworks Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
(Refer to EnqueueNDRangeKernel). The minimum value is 1.
Lasterror is set.
CLDeviceMBS.MaxWorkItemDimensions as UInt32
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | OpenCL | MBS MacFrameworks Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
(Refer to EnqueueNDRangeKernel). The minimum value is 3.
Lasterror is set.
CLDeviceMBS.MaxWriteImageArgs as UInt32
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | OpenCL | MBS MacFrameworks Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
The minimum value is 8 if ImageSupport is true.
Lasterror is set.
CLDeviceMBS.MemoryBaseAddressAlign as UInt32
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | OpenCL | MBS MacFrameworks Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Lasterror is set.
CLDeviceMBS.MinDataTypeAlignSize as UInt32
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | OpenCL | MBS MacFrameworks Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Lasterror is set.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | OpenCL | MBS MacFrameworks Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Lasterror is set.
CLDeviceMBS.Platform as CLPlatformMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | OpenCL | MBS MacFrameworks Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Lasterror is set.
CLDeviceMBS.PreferredVectorWidthChar as UInt32
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | OpenCL | MBS MacFrameworks Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
The vector width is defined as the number of scalar elements that can be stored in the vector.
Lasterror is set.
CLDeviceMBS.PreferredVectorWidthDouble as UInt32
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | OpenCL | MBS MacFrameworks Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
The vector width is defined as the number of scalar elements that can be stored in the vector.
If the cl_khr_fp64 extension is not supported, this function must return 0.
Lasterror is set.
CLDeviceMBS.PreferredVectorWidthFloat as UInt32
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | OpenCL | MBS MacFrameworks Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
The vector width is defined as the number of scalar elements that can be stored in the vector.
Lasterror is set.
CLDeviceMBS.PreferredVectorWidthInt as UInt32
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | OpenCL | MBS MacFrameworks Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
The vector width is defined as the number of scalar elements that can be stored in the vector.
Lasterror is set.
CLDeviceMBS.PreferredVectorWidthLong as UInt32
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | OpenCL | MBS MacFrameworks Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
The vector width is defined as the number of scalar elements that can be stored in the vector.
Lasterror is set.
CLDeviceMBS.PreferredVectorWidthShort as UInt32
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | OpenCL | MBS MacFrameworks Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
The vector width is defined as the number of scalar elements that can be stored in the vector.
Lasterror is set.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | OpenCL | MBS MacFrameworks Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Returns the profile name supported by the device (see note). The profile name returned can be one of the following strings:
FULL_PROFILE - if the device supports the OpenCL specification (functionality defined as part of the core specification and does not require any extensions to be supported).
EMBEDDED_PROFILE - if the device supports the OpenCL embedded profile.
Lasterror is set.
CLDeviceMBS.ProfilingTimerResolution as UInt32
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | OpenCL | MBS MacFrameworks Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Lasterror is set.
CLDeviceMBS.QueueProperties as UInt64
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | OpenCL | MBS MacFrameworks Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
See kQueueOutOfOrderExecModeEnable and kQueueProfilingEnable.
Lasterror is set.
CLDeviceMBS.SingleFPConfig as UInt64
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | OpenCL | MBS MacFrameworks Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
The mandated minimum floating-point capability is kFPRoundToNearest+kFPInfNAN.
Lasterror is set.
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | OpenCL | MBS MacFrameworks Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
Lasterror is set.
CLDeviceMBS.VendorID as UInt32
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
method | OpenCL | MBS MacFrameworks Plugin | 11.1 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
An example of a unique device identifier could be the PCIe ID.
Lasterror is set.
The items on this page are in the following plugins: MBS MacFrameworks Plugin.