cl::Platform Class Reference

Class interface for cl_platform_id. More...

#include <cl.hpp>

Inheritance diagram for cl::Platform:

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

Static Public Member Functions
static cl_int	get (VECTOR_CLASS< 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=NULL)
	Gets the first available platform, returning it by value.
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
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

Constructor & Destructor Documentation

Platform() [1/2]

cl::Platform::Platform ( const Platform &  platform )

inline

Copy constructor.

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

Platform() [2/2]

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.

Member Function Documentation

get() [1/3]

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

inlinestatic

Gets the first available platform, returning it by value.

Wraps clGetPlatformIDs(), returning the first result.

get() [2/3]

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

inlinestatic

Gets the first available platform.

Wraps clGetPlatformIDs(), returning the first result.

get() [3/3]

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

inlinestatic

Gets a list of available platforms.

Wraps clGetPlatformIDs().

Referenced by cl::Context::Context().

getDevices()

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().

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.

operator=() [2/2]

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

inline

Assignment operator from Platform.

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