OpenCL C++ Bindings
cl::Platform Class Reference

Class interface for cl_platform_id. More...

Inheritance diagram for cl::Platform:
cl::detail::Wrapper< cl_platform_id >

Public Member Functions

 Platform ()
 Default constructor - initializes to NULL.
 
 Platform (const cl_platform_id &platform, bool retainObject=false)
 Constructor from cl_platform_id. More...
 
Platformoperator= (const cl_platform_id &rhs)
 Assignment operator from cl_platform_id. More...
 
cl_int getInfo (cl_platform_info name, string *param) const
 Wrapper for clGetPlatformInfo().
 
template<cl_int name>
detail::param_traits< detail::cl_platform_info, name >::param_type getInfo (cl_int *err=NULL) 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. More...
 
cl_int unloadCompiler ()
 Wrapper for clUnloadCompiler().
 
- Public Member Functions inherited from cl::detail::Wrapper< cl_platform_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() ()
 
const cl_type get () const
 
cl_type get ()
 

Static Public Member Functions

static Platform getDefault (cl_int *errResult=NULL)
 
static Platform setDefault (const Platform &default_platform)
 
static cl_int get (vector< Platform > *platforms)
 Gets a list of available platforms. More...
 
static cl_int get (Platform *platform)
 Gets the first available platform. More...
 
static Platform get (cl_int *errResult=NULL)
 Gets the first available platform, returning it by value. More...
 

Additional Inherited Members

- Public Types inherited from cl::detail::Wrapper< cl_platform_id >
typedef cl_platform_id cl_type
 
- Protected Member Functions inherited from cl::detail::Wrapper< cl_platform_id >
cl_int retain () const
 
cl_int release () const
 
- Protected Attributes inherited from cl::detail::Wrapper< cl_platform_id >
cl_type object_
 

Detailed Description

Class interface for cl_platform_id.

Note
Copies of these objects are inexpensive, since they don't 'own' any underlying resources or data structures.
See also
cl_platform_id

Definition at line 2192 of file cl2.hpp.

Constructor & Destructor Documentation

cl::Platform::Platform ( const cl_platform_id &  platform,
bool  retainObject = false 
)
inlineexplicit

Constructor from cl_platform_id.

Parameters
retainObjectwill 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 2274 of file cl2.hpp.

Member Function Documentation

static cl_int cl::Platform::get ( vector< Platform > *  platforms)
inlinestatic

Gets a list of available platforms.

Wraps clGetPlatformIDs().

Definition at line 2466 of file cl2.hpp.

static cl_int cl::Platform::get ( Platform platform)
inlinestatic

Gets the first available platform.

Wraps clGetPlatformIDs(), returning the first result.

Definition at line 2501 of file cl2.hpp.

static Platform cl::Platform::get ( cl_int *  errResult = NULL)
inlinestatic

Gets the first available platform, returning it by value.

Returns
Returns a valid platform if one is available. If no platform is available will return a null platform. Throws an exception if no platforms are available or an error condition occurs. Wraps clGetPlatformIDs(), returning the first result.

Definition at line 2520 of file cl2.hpp.

cl_int cl::Platform::getDevices ( cl_device_type  type,
vector< Device > *  devices 
) const
inline

Gets a list of devices for this platform.

Wraps clGetDeviceIDs().

Definition at line 2338 of file cl2.hpp.

Platform& cl::Platform::operator= ( const cl_platform_id &  rhs)
inline

Assignment operator from cl_platform_id.

This simply copies the platform ID value, which is an inexpensive operation.

Definition at line 2281 of file cl2.hpp.

static Platform cl::Platform::setDefault ( const Platform default_platform)
inlinestatic

Modify the default platform to be used by subsequent operations. Will only set the default if no default was previously created.

Returns
updated default platform. Should be compared to the passed value to ensure that it was updated.

Definition at line 2305 of file cl2.hpp.


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