OpenCL C++ Bindings
cl::Device Class Reference

Class interface for cl_device_id. More...

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

Public Member Functions

 Device ()
 Default constructor - initializes to NULL.
 
 Device (const cl_device_id &device, bool retainObject=false)
 Constructor from cl_device_id. More...
 
Deviceoperator= (const cl_device_id &rhs)
 Assignment operator from cl_device_id. More...
 
 Device (const Device &dev)
 Copy constructor to forward copy to the superclass correctly. Required for MSVC.
 
Deviceoperator= (const Device &dev)
 Copy assignment to forward copy to the superclass correctly. Required for MSVC.
 
 Device (Device &&dev) CL_HPP_NOEXCEPT_
 Move constructor to forward move to the superclass correctly. Required for MSVC.
 
Deviceoperator= (Device &&dev)
 Move assignment to forward move to the superclass correctly. Required for MSVC.
 
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.
 
cl_int createSubDevices (const cl_device_partition_property *properties, vector< Device > *devices)
 Wrapper for clCreateSubDevices(). More...
 
- Public Member Functions inherited from cl::detail::Wrapper< cl_device_id >
 Wrapper (const cl_type &obj, bool retainObject)
 
 Wrapper (const Wrapper< cl_type > &rhs)
 
 Wrapper (Wrapper< cl_type > &&rhs) CL_HPP_NOEXCEPT_
 
Wrapper< cl_type > & operator= (const Wrapper< cl_type > &rhs)
 
Wrapper< cl_type > & operator= (Wrapper< cl_type > &&rhs)
 
Wrapper< cl_type > & operator= (const cl_type &rhs)
 
const cl_type & operator() () const
 
cl_type & operator() ()
 
const cl_type get () const
 
cl_type get ()
 

Static Public Member Functions

static Device getDefault (cl_int *errResult=NULL)
 Returns the first device on the default context. More...
 
static Device setDefault (const Device &default_device)
 

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

Definition at line 1959 of file cl2.hpp.

Constructor & Destructor Documentation

cl::Device::Device ( const cl_device_id &  device,
bool  retainObject = false 
)
inlineexplicit

Constructor from cl_device_id.

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

Definition at line 2002 of file cl2.hpp.

Member Function Documentation

cl_int cl::Device::createSubDevices ( const cl_device_partition_property *  properties,
vector< Device > *  devices 
)
inline

Wrapper for clCreateSubDevices().

CL 1.2 version

Definition at line 2100 of file cl2.hpp.

static Device cl::Device::getDefault ( cl_int *  errResult = NULL)
inlinestatic

Returns the first device on the default context.

See also
Context::getDefault()

Definition at line 2009 of file cl2.hpp.

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.

Definition at line 2038 of file cl2.hpp.

static Device cl::Device::setDefault ( const Device default_device)
inlinestatic

Modify the default device to be used by subsequent operations. Will only set the default if no default was previously created.

Returns
updated default device. Should be compared to the passed value to ensure that it was updated.

Definition at line 2027 of file cl2.hpp.


The documentation for this class was generated from the following file: