Struct ocl::Device

pub struct Device(_);

An individual device identifier (an OpenCL device_id).

Methods

impl Device

fn first(platform: Platform) -> Device

Returns the first available device on a platform.

Errors

fn specifier() -> DeviceSpecifier

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

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.

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.

fn list(platform: &Platform,
        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.

fn list_all(platform: &Platform) -> 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.

fn list_select(platform: &Platform,
               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.

fn list_select_wrap(platform: &Platform,
                    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

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

Returns a list of Devices from a list of DeviceIdCores

fn name(&self) -> String

Returns the device name.

fn vendor(&self) -> String

Returns the device vendor as a string.

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

Returns the maximum workgroup size.

Errors

Returns any OpenCL error.

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

Returns info about the device.

fn to_string(&self) -> String

Returns a string containing a formatted list of device properties.

fn as_core(&self) -> &DeviceIdCore

Returns the underlying DeviceIdCore.

Methods from Deref<Target=DeviceIdCore>

unsafe fn as_ptr(&self) -> *mut c_void

Returns a pointer.

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

Returns the looked up and parsed OpenCL version for this device.

Trait Implementations

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 Copy for Device

impl Debug for Device

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl ClDeviceIdPtr for Device

unsafe fn as_ptr(&self) -> *mut c_void

impl<'a> ClDeviceIdPtr for &'a Device

unsafe fn as_ptr(&self) -> *mut c_void

impl Into<String> for Device

fn into(self) -> String

Performs the conversion.

impl Into<DeviceIdCore> for Device

fn into(self) -> DeviceIdCore

Performs the conversion.

impl Display for Device

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

Formats the value using the given formatter.

impl AsRef<Device> for Device

fn as_ref(&self) -> &Device

Performs the conversion.

impl Deref for Device

type Target = DeviceIdCore

The resulting type after dereferencing

fn deref(&self) -> &DeviceIdCore

The method called to dereference a value

impl DerefMut for Device

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

The method called to mutably dereference a value