Operator Reference

HALCON Operator Reference / System / Compute Devices
ClassesClasses | | Operators

get_compute_device_infoget_compute_device_infoGetComputeDeviceInfoGetComputeDeviceInfoget_compute_device_info (Operator)

get_compute_device_infoget_compute_device_infoGetComputeDeviceInfoGetComputeDeviceInfoget_compute_device_info — Get information on a compute device.

Signature

get_compute_device_info( : : DeviceIdentifier, InfoName : Info)

Herror get_compute_device_info(const Hlong DeviceIdentifier, const char* InfoName, char* Info)

Herror T_get_compute_device_info(const Htuple DeviceIdentifier, const Htuple InfoName, Htuple* Info)

void GetComputeDeviceInfo(const HTuple& DeviceIdentifier, const HTuple& InfoName, HTuple* Info)

static HTuple HComputeDevice::GetComputeDeviceInfo(Hlong DeviceIdentifier, const HString& InfoName)

static HTuple HComputeDevice::GetComputeDeviceInfo(Hlong DeviceIdentifier, const char* InfoName)

static HTuple HComputeDevice::GetComputeDeviceInfo(Hlong DeviceIdentifier, const wchar_t* InfoName)   ( Windows only)

static void HOperatorSet.GetComputeDeviceInfo(HTuple deviceIdentifier, HTuple infoName, out HTuple info)

static HTuple HComputeDevice.GetComputeDeviceInfo(int deviceIdentifier, string infoName)

def get_compute_device_info(device_identifier: int, info_name: str) -> Sequence[Union[str, int, float]]

def get_compute_device_info_s(device_identifier: int, info_name: str) -> Union[str, int, float]

Description

The operator get_compute_device_infoget_compute_device_infoGetComputeDeviceInfoGetComputeDeviceInfoget_compute_device_info returns information on a compute device. In contrast to get_compute_device_paramget_compute_device_paramGetComputeDeviceParamGetComputeDeviceParamget_compute_device_param, only static information is queried, so that the device does not have to be opened (see open_compute_deviceopen_compute_deviceOpenComputeDeviceOpenComputeDeviceopen_compute_device) and activated (see activate_compute_deviceactivate_compute_deviceActivateComputeDeviceActivateComputeDeviceactivate_compute_device).

The following information can be queried:

'vendor'

Vendor of the compute device.

'name'

Name of the compute device.

'platform_version'

Version of the compute device platform. E.g., OpenCL version in the case of OpenCL devices.

'driver_version'

Version of the device driver.

'extensions'

Supported OpenCL extensions.

'image_support'

'true'"true""true""true""true" if the device supports image objects.

'image2d_max_width'

Maximum width of OpenCL image objects.

'image2d_max_height'

Maximum height of OpenCL image objects.

'max_mem_alloc_size'

Maximum size (in bytes) of an OpenCL memory block.

Execution Information

  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).
  • Multithreading scope: global (may be called from any thread).
  • Processed without parallelization.

Parameters

DeviceIdentifierDeviceIdentifierDeviceIdentifierdeviceIdentifierdevice_identifier (input_control)  integer → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Compute device handle.

InfoNameInfoNameInfoNameinfoNameinfo_name (input_control)  string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Name of Information to query.

Default: 'name' "name" "name" "name" "name"

List of values: 'driver_version'"driver_version""driver_version""driver_version""driver_version", 'extensions'"extensions""extensions""extensions""extensions", 'image2d_max_height'"image2d_max_height""image2d_max_height""image2d_max_height""image2d_max_height", 'image2d_max_width'"image2d_max_width""image2d_max_width""image2d_max_width""image2d_max_width", 'image_support'"image_support""image_support""image_support""image_support", 'max_mem_alloc_size'"max_mem_alloc_size""max_mem_alloc_size""max_mem_alloc_size""max_mem_alloc_size", 'name'"name""name""name""name", 'platform_version'"platform_version""platform_version""platform_version""platform_version", 'vendor'"vendor""vendor""vendor""vendor"

InfoInfoInfoinfoinfo (output_control)  string(-array) → HTupleSequence[Union[str, int, float]]HTupleHtuple (string / integer / real) (string / int / long / double) (HString / Hlong / double) (char* / Hlong / double)

Returned information.

Result

The operator get_compute_device_infoget_compute_device_infoGetComputeDeviceInfoGetComputeDeviceInfoget_compute_device_info returns the value 2 ( H_MSG_TRUE) if the parameters are correct. Otherwise an exception will be raised.

Possible Predecessors

query_available_compute_devicesquery_available_compute_devicesQueryAvailableComputeDevicesQueryAvailableComputeDevicesquery_available_compute_devices

Possible Successors

activate_compute_deviceactivate_compute_deviceActivateComputeDeviceActivateComputeDeviceactivate_compute_device

Module

Foundation

ClassesClasses | | Operators