Struct ocl::Device

#[repr(C)]
pub struct Device(/* private fields */);

An individual device identifier (an OpenCL device_id).

Implementations

impl Device

pub fn first<P: Borrow<Platform>>(platform: P) -> OclResult<Device>

Returns the first available device on a platform.

pub fn by_idx_wrap<P: Borrow<Platform>>( platform: P, device_idx_wrap: usize ) -> OclResult<Device>

Returns a single device specified by a wrapped index.

pub fn specifier() -> DeviceSpecifier

Returns a DeviceSpecifier useful for precisely specifying a set of devices.

pub fn resolve_idxs( idxs: &[usize], devices: &[Device] ) -> OclResult<Vec<Device>>

Resolves a list of indices into a list of valid devices.

devices is the set of all indexable devices.

Errors

All indices in idxs must be valid. Use resolve_idxs_wrap for index lists which may contain out of bounds indices.

pub fn resolve_idxs_wrap(idxs: &[usize], devices: &[Device]) -> Vec<Device>

Resolves a list of indices into a list of valid devices.

devices is the set of all indexable devices.

Wraps indices around using modulo (%) so that every index is valid.

pub fn list<P: Borrow<Platform>>( platform: P, device_types: Option<DeviceType> ) -> OclResult<Vec<Device>>

Returns a list of all devices avaliable for a given platform which optionally match the flags set in the bitfield, device_types.

Setting device_types to None will return a list of all avaliable devices for platform regardless of type.

Errors

Returns an Err(ocl::core::Error::Status {...}) enum variant upon any OpenCL error. Calling .status() on the returned error will return an Option(``[ocl::core::Status]``) which can be unwrapped then matched to determine the precise reason for failure.

pub fn list_all<P: Borrow<Platform>>(platform: P) -> OclResult<Vec<Device>>

Returns a list of all devices avaliable for a given platform.

Equivalent to ::list(platform, None).

See ::list for other error information.

pub fn list_select<P: Borrow<Platform>>( platform: P, device_types: Option<DeviceType>, idxs: &[usize] ) -> OclResult<Vec<Device>>

Returns a list of devices filtered by type then selected using a list of indices.

Errors

All indices in idxs must be valid.

See ::list for other error information.

pub fn list_select_wrap<P: Borrow<Platform>>( platform: P, device_types: Option<DeviceType>, idxs: &[usize] ) -> OclResult<Vec<Device>>

Returns a list of devices filtered by type then selected using a wrapping list of indices.

Wraps indices around (%) so that every index is valid.

Errors

See ::list

pub fn list_from_core(devices: Vec<DeviceIdCore>) -> Vec<Device>

Returns a list of Devices from a list of DeviceIdCores

pub fn name(&self) -> OclResult<String>

Returns the device name.

pub fn vendor(&self) -> OclResult<String>

Returns the device vendor as a string.

pub fn max_wg_size(&self) -> OclResult<usize>

Returns the maximum workgroup size or an error.

pub fn mem_base_addr_align(&self) -> OclResult<u32>

Returns the memory base address alignment offset or an error.

pub fn is_available(&self) -> OclResult<bool>

Returns whether or not the device is available for use.

pub fn info_raw(&self, info_kind: u32) -> OclResult<Vec<u8>>

Returns raw info about the device, as a vector of bytes. Intended for use with non-standard OpenCL extensions.

pub fn info(&self, info_kind: DeviceInfo) -> OclResult<DeviceInfoResult>

Returns info about the device.

pub fn to_string(&self) -> String

Returns a string containing a formatted list of device properties.

pub fn as_core(&self) -> &DeviceIdCore

Returns the underlying DeviceIdCore.

Methods from Deref<Target = DeviceIdCore>

pub fn as_raw(&self) -> *mut c_void

Returns a pointer.

pub fn version(&self) -> Result<OpenclVersion, Error>

Returns the queried and parsed OpenCL version for this device.

Trait Implementations

impl AsRef<Device> for Device

fn as_ref(&self) -> &Device

Converts this type into a shared reference of the (usually inferred) input type.

impl<'a> ClDeviceIdPtr for &'a Device

fn as_ptr(&self) -> cl_device_id

impl ClDeviceIdPtr for Device

fn as_ptr(&self) -> cl_device_id

impl Clone for Device

fn clone(&self) -> Device

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Device

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for Device

type Target = DeviceId

The resulting type after dereferencing.

fn deref(&self) -> &DeviceIdCore

Dereferences the value.

impl DerefMut for Device

fn deref_mut(&mut self) -> &mut DeviceIdCore

Mutably dereferences the value.

impl Display for Device

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> From<&'a Device> for DeviceSpecifier

fn from(device: &'a Device) -> DeviceSpecifier

Converts to this type from the input type.

impl From<Device> for DeviceId

fn from(d: Device) -> DeviceIdCore

Converts to this type from the input type.

impl From<Device> for DeviceSpecifier

fn from(device: Device) -> DeviceSpecifier

Converts to this type from the input type.

impl From<Device> for String

fn from(d: Device) -> String

Converts to this type from the input type.

impl From<DeviceId> for Device

fn from(core: DeviceIdCore) -> Device

Converts to this type from the input type.

impl Hash for Device

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Device

fn eq(&self, other: &Device) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Device

impl Eq for Device

impl StructuralPartialEq for Device