Class interface for cl_device_id. More...
#include <opencl.hpp>
Public Member Functions | |
| Device () | |
| Default constructor - initializes to NULL. More... | |
| 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. More... | |
| Device & | operator= (const Device &dev) |
| Copy assignment to forward copy to the superclass correctly. Required for MSVC. More... | |
| Device (Device &&dev) CL_HPP_NOEXCEPT_ | |
| Move constructor to forward move to the superclass correctly. Required for MSVC. More... | |
| Device & | operator= (Device &&dev) |
| Move assignment to forward move 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_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. More... | |
| 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... | |
 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() () |
| cl_type | get () const |
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 2175 of file opencl.hpp.
Constructor & Destructor Documentation
◆ Device() [1/4]
|
inline |
Default constructor - initializes to NULL.
Definition at line 2212 of file opencl.hpp.
◆ Device() [2/4]
|
inlineexplicit |
Constructor from cl_device_id.
This simply copies the device ID value, which is an inexpensive operation.
Definition at line 2218 of file opencl.hpp.
◆ Device() [3/4]
|
inline |
Copy constructor to forward copy to the superclass correctly. Required for MSVC.
Definition at line 2263 of file opencl.hpp.
◆ Device() [4/4]
|
inline |
Move constructor to forward move to the superclass correctly. Required for MSVC.
Definition at line 2277 of file opencl.hpp.
Member Function Documentation
◆ createSubDevices()
|
inline |
◆ getDefault()
|
inlinestatic |
Returns the first device on the default context.
- See also
- Context::getDefault()
Definition at line 2225 of file opencl.hpp.
◆ getDeviceAndHostTimer()
|
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 2343 of file opencl.hpp.
◆ getHostTimer()
|
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 2319 of file opencl.hpp.
◆ getInfo() [1/2]
|
inline |
Wrapper for clGetDeviceInfo().
Definition at line 2290 of file opencl.hpp.
◆ getInfo() [2/2]
|
inline |
Wrapper for clGetDeviceInfo() that returns by value.
Definition at line 2300 of file opencl.hpp.
◆ operator=() [1/3]
|
inline |
Assignment operator from cl_device_id.
This simply copies the device ID value, which is an inexpensive operation.
Definition at line 2254 of file opencl.hpp.
◆ operator=() [2/3]
Copy assignment to forward copy to the superclass correctly. Required for MSVC.
Definition at line 2268 of file opencl.hpp.
◆ operator=() [3/3]
Move assignment to forward move to the superclass correctly. Required for MSVC.
Definition at line 2282 of file opencl.hpp.
◆ setDefault()
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 2243 of file opencl.hpp.
The documentation for this class was generated from the following file:
