Skip to main content

Module device

Module device 

Source
Expand description

OIDN logical device (CPU or GPU backend) and physical device queries. Full API: type-based and physical-ID/UUID/LUID/PCI/CUDA/HIP/Metal device creation.

Structs§

OidnDevice
Open Image Denoise logical device.

Enums§

OidnDeviceType
OIDN device type (CPU, GPU backends, or default auto-select).

Functions§

get_physical_device_bool
Returns a boolean parameter of the physical device. name is e.g. "type", "name".
get_physical_device_data
Returns opaque data and its size for the physical device. Pointer valid until next OIDN call.
get_physical_device_int
Returns an integer parameter of the physical device.
get_physical_device_string
Returns a string parameter of the physical device. Pointer valid until next OIDN call.
is_cpu_device_supported
Whether the CPU device is supported.
is_cuda_device_supported
Whether the given CUDA device ID is supported.
is_hip_device_supported
Whether the given HIP device ID is supported.
is_metal_device_supported
Whether the given Metal device (MTLDevice, passed as raw pointer) is supported.
num_physical_devices
Number of physical devices supported by OIDN. Valid IDs are 0 .. num_physical_devices().
take_global_error
Returns the first unqueried error for the current thread (e.g. from a failed device creation) and clears it. Can be called without a device to check why OidnDevice::new() or similar failed.