cl::Platform Class Reference

Class interface for cl_platform_id. More...

`#include <cl.hpp>`

Inheritance diagram for cl::Platform:
[legend]
Collaboration diagram for cl::Platform:
[legend]

## Public Member Functions

| Platform ()
| Default constructor - initializes to NULL. More...
__CL_EXPLICIT_CONSTRUCTORS | Platform (const cl_platform_id &platform)
| Constructor from cl_platform_id. More...
Platform & | operator= (const cl_platform_id &rhs)
| Assignment operator from cl_platform_id. More...
cl_int | getInfo (cl_platform_info name, STRING_CLASS *param) const
| Wrapper for clGetPlatformInfo(). More...
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. More...
cl_int | getDevices (cl_device_type type, VECTOR_CLASS< Device > *devices) const
| Gets a list of devices for this platform. More...
| Platform ()
| Default constructor - initializes to NULL. More...
__CL_EXPLICIT_CONSTRUCTORS | Platform (const cl_platform_id &platform)
| Constructor from cl_platform_id. More...
Platform & | operator= (const cl_platform_id &rhs)
| Assignment operator from cl_platform_id. More...
cl_int | getInfo (cl_platform_info name, STRING_CLASS *param) const
| Wrapper for clGetPlatformInfo(). More...
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. More...
cl_int | getDevices (cl_device_type type, VECTOR_CLASS< Device > *devices) const
| Gets a list of devices for this platform. More...
Public Member Functions inherited from cl::detail::Wrapper< cl_platform_id >
| Wrapper ()
| Wrapper (const cl_type &obj)
| Wrapper (const Wrapper< cl_type > &rhs)
| Wrapper ()
| Wrapper (const cl_type &obj)
| Wrapper (const Wrapper< cl_type > &rhs)
| ~Wrapper ()
| ~Wrapper ()
Wrapper< cl_type > & | operator= (const Wrapper< cl_type > &rhs)
Wrapper< cl_type > & | operator= (const cl_type &rhs)
Wrapper< cl_type > & | operator= (const Wrapper< cl_type > &rhs)
Wrapper< cl_type > & | operator= (const cl_type &rhs)
cl_type | operator() () const
cl_type & | operator() ()
cl_type | operator() () const
cl_type & | operator() ()

## Static Public Member Functions

static cl_int | get (VECTOR_CLASS< 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...
static Platform | getDefault (cl_int *errResult=NULL)
static cl_int | get (VECTOR_CLASS< 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...
static Platform | getDefault (cl_int *errResult=NULL)

## Additional Inherited Members

Public Types inherited from cl::detail::Wrapper< cl_platform_id >
typedef cl_platform_id | cl_type
typedef cl_platform_id | cl_type
Protected Member Functions inherited from cl::detail::Wrapper< cl_platform_id >
cl_int | retain () const
cl_int | retain () const
cl_int | release () 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 2059 of file cl.hpp.

## Constructor & Destructor Documentation

## Platform() [1/4]

cl::Platform::Platform | ( |  | ) |

inline

Default constructor - initializes to NULL.

Definition at line 2063 of file cl.hpp.

## Platform() [2/4]

__CL_EXPLICIT_CONSTRUCTORS cl::Platform::Platform | ( | const cl_platform_id & | platform | ) |

inline

Constructor from cl_platform_id.

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

Definition at line 2069 of file cl.hpp.

## Platform() [3/4]

cl::Platform::Platform | ( |  | ) |

inline

Default constructor - initializes to NULL.

Definition at line 2063 of file cl.hpp.

## Platform() [4/4]

__CL_EXPLICIT_CONSTRUCTORS cl::Platform::Platform | ( | const cl_platform_id & | platform | ) |

inline

Constructor from cl_platform_id.

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

Definition at line 2069 of file cl.hpp.

## Member Function Documentation

## get() [1/6]

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

inline static

Gets the first available platform, returning it by value.

Wraps clGetPlatformIDs(), returning the first result.

Definition at line 2269 of file cl.hpp.

## get() [2/6]

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

inline static

Gets the first available platform, returning it by value.

Wraps clGetPlatformIDs(), returning the first result.

Definition at line 2269 of file cl.hpp.

## get() [3/6]

static cl_int cl::Platform::get | ( | Platform * | platform | ) |

inline static

Gets the first available platform.

Wraps clGetPlatformIDs(), returning the first result.

Definition at line 2240 of file cl.hpp.

## get() [4/6]

static cl_int cl::Platform::get | ( | Platform * | platform | ) |

inline static

Gets the first available platform.

Wraps clGetPlatformIDs(), returning the first result.

Definition at line 2240 of file cl.hpp.

## get() [5/6]

static cl_int cl::Platform::get | ( | VECTOR_CLASS< Platform > * | platforms | ) |

inline static

Gets a list of available platforms.

Wraps clGetPlatformIDs().

Definition at line 2211 of file cl.hpp.

## get() [6/6]

static cl_int cl::Platform::get | ( | VECTOR_CLASS< Platform > * | platforms | ) |

inline static

Gets a list of available platforms.

Wraps clGetPlatformIDs().

Definition at line 2211 of file cl.hpp.

## getDefault() [1/2]

static Platform cl::Platform::getDefault | ( | cl_int * | errResult = `NULL` | ) |

inline static

Definition at line 2299 of file cl.hpp.

## getDefault() [2/2]

static Platform cl::Platform::getDefault | ( | cl_int * | errResult = `NULL` | ) |

inline static

Definition at line 2299 of file cl.hpp.

## getDevices() [1/2]

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

inline

Gets a list of devices for this platform.

Wraps clGetDeviceIDs().

Definition at line 2107 of file cl.hpp.

## getDevices() [2/2]

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

inline

Gets a list of devices for this platform.

Wraps clGetDeviceIDs().

Definition at line 2107 of file cl.hpp.

## getInfo() [1/4]

template<cl_int name>

detail::param_traits<detail::cl_platform_info, name>::param_type cl::Platform::getInfo | ( | cl_int * | err = `NULL` | ) | const

inline

Wrapper for clGetPlatformInfo() that returns by value.

Definition at line 2092 of file cl.hpp.

## getInfo() [2/4]

template<cl_int name>

detail::param_traits<detail::cl_platform_info, name>::param_type cl::Platform::getInfo | ( | cl_int * | err = `NULL` | ) | const

inline

Wrapper for clGetPlatformInfo() that returns by value.

Definition at line 2092 of file cl.hpp.

## getInfo() [3/4]

cl_int cl::Platform::getInfo | ( | cl_platform_info | name,
|  | STRING_CLASS * | param
| ) |  | const

inline

Wrapper for clGetPlatformInfo().

Definition at line 2082 of file cl.hpp.

## getInfo() [4/4]

cl_int cl::Platform::getInfo | ( | cl_platform_info | name,
|  | STRING_CLASS * | param
| ) |  | const

inline

Wrapper for clGetPlatformInfo().

Definition at line 2082 of file cl.hpp.

## operator=() [1/2]

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

## operator=() [2/2]

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

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

- /build/asl-1Fw6fH/asl-0.1.7/debian/tmp/usr/include/ASL/acl/cl.hpp