FiberVISH 0.2
Fish - The Fiber Bundle API for the Vish Visualization Shell
Public Member Functions | Static Public Member Functions | List of all members
cl::Device Class Reference

Class interface for cl_device_id. More...

#include <cl.hpp>

Inheritance diagram for cl::Device:
cl::detail::Wrapper< cl_device_id >

Public Member Functions

 Device ()
 Default constructor - initializes to NULL.
 
 Device (const Device &device)
 Copy constructor.
 
 Device (const cl_device_id &device)
 Constructor from cl_device_id.
 
Deviceoperator= (const Device &rhs)
 Assignment operator from Device.
 
Deviceoperator= (const cl_device_id &rhs)
 Assignment operator from cl_device_id.
 
template<typename T >
cl_int getInfo (cl_device_info name, T *param) const
 Wrapper for clGetDeviceInfo().
 
template<cl_int name>
detail::param_traits< detail::cl_device_info, name >::param_type getInfo (cl_int *err=NULL) const
 Wrapper for clGetDeviceInfo() that returns by value.
 
- Public Member Functions inherited from cl::detail::Wrapper< cl_device_id >
 Wrapper (const cl_type &obj)
 
 Wrapper (const Wrapper< cl_type > &rhs)
 
Wrapper< cl_type > & operator= (const Wrapper< cl_type > &rhs)
 
Wrapper< cl_type > & operator= (const cl_type &rhs)
 
cl_type operator() () const
 
cl_type & operator() ()
 

Static Public Member Functions

static Device getDefault (cl_int *err=NULL)
 Returns the first device on the default context.
 

Additional Inherited Members

- Public Types inherited from cl::detail::Wrapper< cl_device_id >
typedef cl_device_id cl_type
 
- Protected Member Functions inherited from cl::detail::Wrapper< cl_device_id >
cl_int retain () const
 
cl_int release () const
 
- Static Protected Member Functions inherited from cl::detail::Wrapper< cl_device_id >
static bool isReferenceCountable (cl_device_id device)
 
- Protected Attributes inherited from cl::detail::Wrapper< cl_device_id >
cl_type object_
 
bool referenceCountable_
 

Detailed Description

Class interface for cl_device_id.

Note
Copies of these objects are inexpensive, since they don't 'own' any underlying resources or data structures.
See also
cl_device_id

Constructor & Destructor Documentation

◆ Device() [1/2]

cl::Device::Device ( const Device device)
inline

Copy constructor.

This simply copies the device ID value, which is an inexpensive operation.

◆ Device() [2/2]

cl::Device::Device ( const cl_device_id &  device)
inline

Constructor from cl_device_id.

This simply copies the device ID value, which is an inexpensive operation.

Member Function Documentation

◆ getDefault()

Device cl::Device::getDefault ( cl_int *  err = NULL)
inlinestatic

Returns the first device on the default context.

See also
Context::getDefault()

References cl::Context::getDefault(), and cl::Context::getInfo().

◆ operator=() [1/2]

Device & cl::Device::operator= ( const cl_device_id &  rhs)
inline

Assignment operator from cl_device_id.

This simply copies the device ID value, which is an inexpensive operation.

◆ operator=() [2/2]

Device & cl::Device::operator= ( const Device rhs)
inline

Assignment operator from Device.

This simply copies the device ID value, which is an inexpensive operation.