open_compute_deviceT_open_compute_deviceOpenComputeDeviceOpenComputeDevice (Operator)

Name

open_compute_deviceT_open_compute_deviceOpenComputeDeviceOpenComputeDevice — Open a compute device.

Signature

open_compute_device( : : DeviceIdentifier : DeviceHandle)

Description

open_compute_deviceopen_compute_deviceOpenComputeDeviceOpenComputeDeviceOpenComputeDevice opens the compute device referenced by DeviceIdentifierDeviceIdentifierDeviceIdentifierDeviceIdentifierdeviceIdentifier and returns DeviceHandleDeviceHandleDeviceHandleDeviceHandledeviceHandle. Enable computation on DeviceHandleDeviceHandleDeviceHandleDeviceHandledeviceHandle via activate_compute_deviceactivate_compute_deviceActivateComputeDeviceActivateComputeDeviceActivateComputeDevice.

DeviceHandleDeviceHandleDeviceHandleDeviceHandledeviceHandle must be obtained by query_available_compute_devicesquery_available_compute_devicesQueryAvailableComputeDevicesQueryAvailableComputeDevicesQueryAvailableComputeDevices.

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.

This operator returns a handle. Note that the state of an instance of this handle type may be changed by specific operators even though the handle is used as an input parameter by those operators.

Parameters

DeviceIdentifierDeviceIdentifierDeviceIdentifierDeviceIdentifierdeviceIdentifier (input_control) integer → (integer)

Compute device Identifier.

DeviceHandleDeviceHandleDeviceHandleDeviceHandledeviceHandle (output_control) compute_device → (handle)

Compute device handle.

Result

open_compute_deviceopen_compute_deviceOpenComputeDeviceOpenComputeDeviceOpenComputeDevice returns the value 2 (H_MSG_TRUE) if DeviceIdentifierDeviceIdentifierDeviceIdentifierDeviceIdentifierdeviceIdentifier is valid. Otherwise an exception will be raised.

Possible Predecessors

query_available_compute_devicesquery_available_compute_devicesQueryAvailableComputeDevicesQueryAvailableComputeDevicesQueryAvailableComputeDevices

Possible Successors

activate_compute_deviceactivate_compute_deviceActivateComputeDeviceActivateComputeDeviceActivateComputeDevice, init_compute_deviceinit_compute_deviceInitComputeDeviceInitComputeDeviceInitComputeDevice

Module

Foundation

Operators