init_compute_deviceT_init_compute_deviceInitComputeDeviceInitComputeDeviceinit_compute_device (Operator)
Name
init_compute_deviceT_init_compute_deviceInitComputeDeviceInitComputeDeviceinit_compute_device — Initialize a compute device.
Signature
Description
init_compute_deviceinit_compute_deviceInitComputeDeviceInitComputeDeviceInitComputeDeviceinit_compute_device initializes a compute device and prepares a
list of operators given in OperatorsOperatorsOperatorsOperatorsoperatorsoperators for the execution on this
device. Further the device is activated for the current thread.
If init_compute_deviceinit_compute_deviceInitComputeDeviceInitComputeDeviceInitComputeDeviceinit_compute_device is not called or operators other than
those in OperatorsOperatorsOperatorsOperatorsoperatorsoperators are used on the device, the initialization
is performed on demand.
Use get_operator_infoget_operator_infoGetOperatorInfoGetOperatorInfoGetOperatorInfoget_operator_info to test if an operator qualifies for
execution on the compute device.
Attention
Be aware that the execution time of init_compute_deviceinit_compute_deviceInitComputeDeviceInitComputeDeviceInitComputeDeviceinit_compute_device depends
on the number of OperatorsOperatorsOperatorsOperatorsoperatorsoperators and may last up to several seconds.
Execution Information
- Multithreading type: reentrant (runs in parallel with non-exclusive operators).
- Multithreading scope: local (may only be called from the same thread in which the window, model, or tool instance was created).
- Processed without parallelization.
Parameters
DeviceHandleDeviceHandleDeviceHandleDeviceHandledeviceHandledevice_handle (input_control) compute_device → HComputeDevice, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Compute device handle.
OperatorsOperatorsOperatorsOperatorsoperatorsoperators (input_control) string-array → HTupleSequence[str]HTupleHtuple (string) (string) (HString) (char*)
List of operators to prepare.
Default:
'all'
"all"
"all"
"all"
"all"
"all"
List of values:
'all'"all""all""all""all""all", 'derivate_gauss'"derivate_gauss""derivate_gauss""derivate_gauss""derivate_gauss""derivate_gauss", 'sobel_amp'"sobel_amp""sobel_amp""sobel_amp""sobel_amp""sobel_amp"
Result
The operator init_compute_deviceinit_compute_deviceInitComputeDeviceInitComputeDeviceInitComputeDeviceinit_compute_device returns the
value 2 (
H_MSG_TRUE)
if the initialization was successful. Otherwise
an exception will be raised.
Possible Predecessors
query_available_compute_devicesquery_available_compute_devicesQueryAvailableComputeDevicesQueryAvailableComputeDevicesQueryAvailableComputeDevicesquery_available_compute_devices,
open_compute_deviceopen_compute_deviceOpenComputeDeviceOpenComputeDeviceOpenComputeDeviceopen_compute_device
Possible Successors
activate_compute_deviceactivate_compute_deviceActivateComputeDeviceActivateComputeDeviceActivateComputeDeviceactivate_compute_device
Module
Foundation