OpenCL C++ Bindings
|
Class interface for cl_platform_id. More...
#include <opencl.hpp>
Public Member Functions | |
Platform () | |
Default constructor - initializes to nullptr. | |
Platform (const cl_platform_id &platform, bool retainObject=false) | |
Constructor from cl_platform_id. | |
Platform & | operator= (const cl_platform_id &rhs) |
Assignment operator from cl_platform_id. | |
template<typename T> | |
cl_int | getInfo (cl_platform_info name, T *param) const |
Wrapper for clGetPlatformInfo(). | |
template<cl_platform_info name> | |
detail::param_traits< detail::cl_platform_info, name >::param_type | getInfo (cl_int *err=nullptr) const |
Wrapper for clGetPlatformInfo() that returns by value. | |
cl_int | getDevices (cl_device_type type, vector< Device > *devices) const |
Gets a list of devices for this platform. | |
cl_int | unloadCompiler () |
Wrapper for clUnloadCompiler(). | |
![]() | |
Wrapper (const cl_type &obj, bool retainObject) | |
Wrapper (const Wrapper< cl_type > &rhs) | |
Wrapper (Wrapper< cl_type > &&rhs) 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 Platform | getDefault (cl_int *errResult=nullptr) |
static Platform | setDefault (const Platform &default_platform) |
static cl_int | get (vector< Platform > *platforms) |
Gets a list of available platforms. | |
static cl_int | get (Platform *platform) |
Gets the first available platform. | |
static Platform | get (cl_int *errResult=nullptr) |
Gets the first available platform, returning it by value. | |
Additional Inherited Members | |
![]() | |
typedef cl_platform_id | cl_type |
![]() | |
cl_int | retain () const |
cl_int | release () const |
![]() | |
cl_type | object_ |
Class interface for cl_platform_id.
Definition at line 2695 of file opencl.hpp.
|
inline |
Default constructor - initializes to nullptr.
Definition at line 2768 of file opencl.hpp.
|
inlineexplicit |
Constructor from cl_platform_id.
retainObject | will cause the constructor to retain its cl object. Defaults to false to maintain compatibility with earlier versions. This simply copies the platform ID value, which is an inexpensive operation. |
Definition at line 2777 of file opencl.hpp.
|
inlinestatic |
Gets the first available platform, returning it by value.
Definition at line 3031 of file opencl.hpp.
|
inlinestatic |
Gets the first available platform.
Wraps clGetPlatformIDs(), returning the first result.
Definition at line 3012 of file opencl.hpp.
|
inlinestatic |
Gets a list of available platforms.
Wraps clGetPlatformIDs().
Definition at line 2977 of file opencl.hpp.
|
inlinestatic |
Definition at line 2790 of file opencl.hpp.
|
inline |
Gets a list of devices for this platform.
Wraps clGetDeviceIDs().
Definition at line 2842 of file opencl.hpp.
|
inline |
Wrapper for clGetPlatformInfo() that returns by value.
Definition at line 2827 of file opencl.hpp.
|
inline |
Wrapper for clGetPlatformInfo().
Definition at line 2817 of file opencl.hpp.
|
inline |
Assignment operator from cl_platform_id.
This simply copies the platform ID value, which is an inexpensive operation.
Definition at line 2784 of file opencl.hpp.
Modify the default platform to be used by subsequent operations. Will only set the default if no default was previously created.
Definition at line 2808 of file opencl.hpp.
|
inline |
Wrapper for clUnloadCompiler().
Definition at line 3045 of file opencl.hpp.