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
The default compute device address space size specified as an unsigned integer value in bits.
Example
dim Devices(-1) as CLDeviceMBS = OpenCLMBS.AllDevices(CLDeviceMBS.kDeviceTypeAll)

for each p as CLDeviceMBS in Devices
MsgBox p.Name+": "+str(p.AddressBits)
next

Currently supported values are 32 or 64 bits.
Lasterror is set.

Some examples using this method:

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
Returns true if the device is available and false if the device is not available.

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
Returns false if the implementation does not have a compiler available to compile the program source.

Is true if the compiler is available. This can be false for the embededed platform profile only.
Lasterror is set.

Some examples using this method:

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
The OpenCL device type.

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
OpenCL version string.

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
OpenCL software driver version string in the form major_number.minor_number.

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
Returns true if the OpenCL device is a little endian device and false otherwise.

Lasterror is set.

Some examples using this method:

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 true if the device implements error correction for the memories, caches, registers etc. in the device.

Returns false if the device does not implement error correction. This can be a requirement for certain clients of OpenCL.
Lasterror is set.

Some examples using this method:

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
Describes the execution capabilities of the device.

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
Returns a space separated list of extension names.
Example
// show msgbox with all extensions for first device

dim devices(-1) as CLDeviceMBS = OpenCLMBS.AllDevices(CLDeviceMBS.kDeviceTypeAll)
dim device as CLDeviceMBS = devices(0)

dim extensions(-1) as string = split(device.Extensions," ")

dim lines(-1) as string

for each extension as string in extensions
lines.append extension
next

MsgBox Join(lines,EndOfLine)

(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
Size of global memory cache line in bytes.

Lasterror is set.

Some examples using this method:

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
Size of global memory cache in bytes.

Lasterror is set.

Some examples using this method:

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
Type of global memory cache supported.

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
Size of global device memory in bytes.

Lasterror is set.

Some examples using this method:

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
Max height of 2D image in pixels.

The minimum value is 8192 if ImageSupport is true.
Lasterror is set.

Some examples using this method:

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
Max width of 2D image in pixels.

The minimum value is 8192 if ImageSupport is true.
Lasterror is set.

Some examples using this method:

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
Max depth of 3D image in pixels.

The minimum value is 2048 if ImageSupport is true.
Lasterror is set.

Some examples using this method:

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
Max height of 3D image in pixels.

The minimum value is 2048 if ImageSupport is true.
Lasterror is set.

Some examples using this method:

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
Max width of 3D image in pixels.

The minimum value is 2048 if ImageSupport is true.
Lasterror is set.

Some examples using this method:

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
Returns true if images are supported by the OpenCL device and false otherwise.

Lasterror is set.

Some examples using this method:

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
Size of local memory arena in bytes.

The minimum value is 16 KB.
Lasterror is set.

Some examples using this method:

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
Type of local memory supported.

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
Maximum configured clock frequency of the device in MHz.

Lasterror is set.

Some examples using this method:

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 number of parallel compute cores on the OpenCL device.

The minimum value is 1.
Lasterror is set.

Some examples using this method:

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
Max number of arguments declared with the __constant qualifier in a kernel.

The minimum value is 8.
Lasterror is set.

Some examples using this method:

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
Max size in bytes of a constant buffer allocation.

The minimum value is 64 KB.
Lasterror is set.

Some examples using this method:

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
Max size of memory object allocation in bytes.

The minimum value is max (1/4th of GlobalMemorySize, 128*1024*1024)
Lasterror is set.

Some examples using this method:

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
Max size in bytes of the arguments that can be passed to a kernel.

The minimum value is 256.
Lasterror is set.

Some examples using this method:

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
Max number of simultaneous image objects that can be read by a kernel.

Lasterror is set.
The minimum value is 128 if ImageSupport is true.

Some examples using this method:

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
Maximum number of samplers that can be used in a kernel.

The minimum value is 16 if ImageSupport is true.
Lasterror is set.

Some examples using this method:

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
Maximum number of work-items in a work-group executing a kernel using the data parallel execution model.

(Refer to EnqueueNDRangeKernel). The minimum value is 1.
Lasterror is set.

Some examples using this method:

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
Maximum dimensions that specify the global and local work-item IDs used by the data parallel execution model.

(Refer to EnqueueNDRangeKernel). The minimum value is 3.
Lasterror is set.

Some examples using this method:

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
Max number of simultaneous image objects that can be written to by a kernel.

The minimum value is 8 if ImageSupport is true.
Lasterror is set.

Some examples using this method:

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
Describes the alignment in bits of the base address of any allocated memory object.

Lasterror is set.

Some examples using this method:

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
The smallest alignment in bytes which can be used for any data type.

Lasterror is set.

Some examples using this method:

CLDeviceMBS.Name as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
method OpenCL MBS MacFrameworks Plugin 11.1 ✅ Yes ❌ No ❌ No ✅ Yes All
Device name string.
Example
dim Devices(-1) as CLDeviceMBS = OpenCLMBS.AllDevices(CLDeviceMBS.kDeviceTypeAll)

for each p as CLDeviceMBS in Devices
MsgBox p.Name
next

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
The platform associated with this device.

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
Preferred native vector width size for built-in scalar types that can be put into vectors.

The vector width is defined as the number of scalar elements that can be stored in the vector.
Lasterror is set.

Some examples using this method:

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
Preferred native vector width size for built-in scalar types that can be put into vectors.

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.

Some examples using this method:

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
Preferred native vector width size for built-in scalar types that can be put into vectors.

The vector width is defined as the number of scalar elements that can be stored in the vector.
Lasterror is set.

Some examples using this method:

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
Preferred native vector width size for built-in scalar types that can be put into vectors.

The vector width is defined as the number of scalar elements that can be stored in the vector.
Lasterror is set.

Some examples using this method:

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
Preferred native vector width size for built-in scalar types that can be put into vectors.

The vector width is defined as the number of scalar elements that can be stored in the vector.
Lasterror is set.

Some examples using this method:

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
Preferred native vector width size for built-in scalar types that can be put into vectors.

The vector width is defined as the number of scalar elements that can be stored in the vector.
Lasterror is set.

Some examples using this method:

CLDeviceMBS.Profile as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
method OpenCL MBS MacFrameworks Plugin 11.1 ✅ Yes ❌ No ❌ No ✅ Yes All
OpenCL profile string.

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
Describes the resolution of device timer. This is measured in nanoseconds.

Lasterror is set.

Some examples using this method:

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
Describes the command-queue properties supported by the device.

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
Describes single precision floating-point capability of the device.

The mandated minimum floating-point capability is kFPRoundToNearest+kFPInfNAN.
Lasterror is set.

CLDeviceMBS.Vendor as String

Type Topic Plugin Version macOS Windows Linux iOS Targets
method OpenCL MBS MacFrameworks Plugin 11.1 ✅ Yes ❌ No ❌ No ✅ Yes All
Vendor name string.

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
A unique device vendor identifier.

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.


The biggest plugin in space...