cl::Device Class Reference

Class interface for cl_device_id. More...

#include <cl.hpp>

Inheritance diagram for cl::Device:

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...
	Device (const Device &dev)
	Copy constructor 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...
Device &	operator= (const cl_device_id &rhs)
	Assignment operator from cl_device_id. More...
Device &	operator= (const Device &dev)
	Copy assignment to forward copy to the superclass correctly. Required for MSVC. More...
Public Member Functions inherited from cl::detail::Wrapper< cl_device_id >
cl_type	operator() () const
cl_type &	operator() ()
Wrapper< cl_type > &	operator= (const Wrapper< cl_type > &rhs)
Wrapper< cl_type > &	operator= (const cl_type &rhs)
	Wrapper ()
	Wrapper (const cl_type &obj)
	Wrapper (const Wrapper< cl_type > &rhs)
	~Wrapper ()

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	release () const
cl_int	retain () 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 2019 of file cl.hpp.

Constructor & Destructor Documentation

cl::Device::Device ( )

inline

Default constructor - initializes to NULL.

Definition at line 2023 of file cl.hpp.

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

cl::Device::Device ( const Device &  dev )

inline

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

Definition at line 2050 of file cl.hpp.

Member Function Documentation

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

inlinestatic

Returns the first device on the default context.

See also

Context::getDefault()

Definition at line 2787 of file cl.hpp.

template<typename T >

cl_int cl::Device::getInfo ( cl_device_info  name, T *  param  ) const

inline

Wrapper for clGetDeviceInfo().

Definition at line 2079 of file cl.hpp.

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

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

inline

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

Definition at line 2055 of file cl.hpp.

---

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

• cl.hpp