OpenCL::Platform Class Reference

#include <opencl_platform.h>

Inheritance diagram for OpenCL::Platform:

Public Member Functions
cl_platform_id	id () const
QString	profile () const
QString	version () const
QString	name () const
QString	vendor () const
const QStringList &	extensions () const
int	deviceSize () const
OpenCL::Device *	device (int index) const

Static Public Member Functions
static int	size ()
static OpenCL::Platform *	get (int index)

Detailed Description

This provides information about a single OpenCL platform along with static methods for iterating through all available platforms. This also provides methods for iterating through all OpenCL devices of their respective platform. This class is not intended to be instantiated on its own but instead queried through the static methods. Any pointer to a platform the static methods return will exist for the lifetime of the ACE program.

Member Function Documentation

device()

OpenCL::Device * Platform::device

(

int

index

)

const

Returns a pointer to the OpenCL device contained in this platform with the given index. If the index is out of range then an exception is thrown.

Parameters

index

Index of OpenCL device of this platform whose pointer is returned.

Returns

Pointer to OpenCL device of this platform with the given index.

deviceSize()

int Platform::deviceSize

(

)

const

Returns the number of OpenCL devices this platform contains.

Returns

Number of OpenCL devices this platform contains.

extensions()

const QStringList & Platform::extensions

(

)

const

Returns the OpenCL extensions this platform supports.

Returns

OpenCL extensions this platform supports.

get()

OpenCL::Platform * Platform::get ( int  index )

static

Returns a pointer to the OpenCL platform with the given index. If the index is out of range an exception is thrown.

Parameters

index

Index of OpenCL platform whose reference is returned.

Returns

Pointer to OpenCL platform with given index.

id()

cl_platform_id Platform::id

(

)

const

Returns the OpenCL platform ID for this platform object.

Returns

OpenCL platform ID for this object.

name()

QString Platform::name

(

)

const

Returns the name of this platform.

Returns

Name of this platform.

profile()

QString Platform::profile

(

)

const

Returns the profile of this platform.

Returns

Profile of this platform.

size()

int Platform::size ( )

static

Returns the number of OpenCL platforms that exist.

Returns

Number of OpenCL platforms.

vendor()

QString Platform::vendor

(

)

const

Returns the vendor of this platform.

Returns

Vendor of this platform.

version()

QString Platform::version

(

)

const

Returns the OpenCL version used by this platform.

Returns

OpenCL version used by this platform.

---

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

• opencl_platform.h
• opencl_platform.cpp