ASL  0.1.7
Advanced Simulation Library
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:
Inheritance graph
[legend]
Collaboration diagram for cl::Device:
Collaboration graph
[legend]

Public Member Functions

 Device ()
 Default constructor - initializes to NULL. More...
 
__CL_EXPLICIT_CONSTRUCTORS Device (const cl_device_id &device)
 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. More...
 
Deviceoperator= (const Device &dev)
 Copy assignment to forward copy to the superclass correctly. Required for MSVC. More...
 
template<typename T >
cl_int getInfo (cl_device_info name, T *param) const
 Wrapper for clGetDeviceInfo(). More...
 
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. More...
 
- Public Member Functions inherited from cl::detail::Wrapper< cl_device_id >
 Wrapper ()
 
 Wrapper (const cl_type &obj)
 
 ~Wrapper ()
 
 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_typeoperator() ()
 

Static Public Member Functions

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

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 1906 of file cl.hpp.

Constructor & Destructor Documentation

◆ Device() [1/3]

cl::Device::Device ( )
inline

Default constructor - initializes to NULL.

Definition at line 1910 of file cl.hpp.

◆ Device() [2/3]

__CL_EXPLICIT_CONSTRUCTORS 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.

Definition at line 1916 of file cl.hpp.

◆ Device() [3/3]

cl::Device::Device ( const Device dev)
inline

Copy constructor to forward copy to the superclass correctly. Required for MSVC.

Definition at line 1937 of file cl.hpp.

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()

Definition at line 2664 of file cl.hpp.

◆ getInfo() [1/2]

template<typename T >
cl_int cl::Device::getInfo ( cl_device_info  name,
T *  param 
) const
inline

Wrapper for clGetDeviceInfo().

Definition at line 1966 of file cl.hpp.

◆ getInfo() [2/2]

template<cl_int name>
detail::param_traits<detail::cl_device_info, name>::param_type cl::Device::getInfo ( cl_int *  err = NULL) const
inline

Wrapper for clGetDeviceInfo() that returns by value.

Definition at line 1976 of file cl.hpp.

◆ 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.

Definition at line 1928 of file cl.hpp.

◆ operator=() [2/2]

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

Copy assignment to forward copy to the superclass correctly. Required for MSVC.

Definition at line 1942 of file cl.hpp.


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