Class interface for cl_device_id.
More...
|
| Device () |
| Default constructor - initializes to NULL.
|
|
| Device (const cl_device_id &device, bool retainObject=false) |
| Constructor from cl_device_id. More...
|
|
Device & | operator= (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.
|
|
Device & | operator= (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.
|
|
Device & | operator= (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_device_info 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_ulong | getHostTimer (cl_int *error=nullptr) |
|
std::pair< cl_ulong, cl_ulong > | getDeviceAndHostTimer (cl_int *error=nullptr) |
|
cl_int | createSubDevices (const cl_device_partition_property *properties, vector< Device > *devices) |
| Wrapper for clCreateSubDevices(). More...
|
|
| 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() () |
|
cl_type | get () const |
|
|
typedef cl_device_id | cl_type |
|
cl_int | retain () const |
|
cl_int | release () const |
|
static bool | isReferenceCountable (cl_device_id device) |
|
cl_type | object_ |
|
bool | referenceCountable_ |
|
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 2071 of file cl2.hpp.
◆ Device()
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 2114 of file cl2.hpp.
◆ createSubDevices()
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 2259 of file cl2.hpp.
◆ getDefault()
static Device cl::Device::getDefault |
( |
cl_int * |
errResult = NULL | ) |
|
|
inlinestatic |
◆ getDeviceAndHostTimer()
std::pair<cl_ulong, cl_ulong> cl::Device::getDeviceAndHostTimer |
( |
cl_int * |
error = nullptr | ) |
|
|
inline |
Return a synchronized pair of host and device timestamps as seen by device. Use to correlate the clocks and get the host timer only using getHostTimer as a lower cost mechanism in between calls. The resolution of the host timer may be queried with the CL_PLATFORM_HOST_TIMER_RESOLUTION query. The resolution of the device timer may be queried with the CL_DEVICE_PROFILING_TIMER_RESOLUTION query.
- Returns
- A pair of (device timer, host timer) timer values.
Definition at line 2239 of file cl2.hpp.
◆ getHostTimer()
cl_ulong cl::Device::getHostTimer |
( |
cl_int * |
error = nullptr | ) |
|
|
inline |
Return the current value of the host clock as seen by the device. The resolution of the device timer may be queried with the CL_DEVICE_PROFILING_TIMER_RESOLUTION query.
- Returns
- The host timer value.
Definition at line 2215 of file cl2.hpp.
◆ operator=()
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 2150 of file cl2.hpp.
◆ setDefault()
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 2139 of file cl2.hpp.
The documentation for this class was generated from the following file: