Public Member Functions | Private Member Functions | Private Attributes | Friends

cl::platform Class Reference

This class represents the information about a specific OpenCL platform. More...

#include <clinfo.hpp>

List of all members.

Public Member Functions

 platform (const platform &platform)
 Platform copy-constructor.
platformoperator= (const platform &platform)
 Platform assignment-operator.
 ~platform ()
 Platform destructor.
cl_platform_id platform_id () const
const std::string & profile () const
const std::string & version () const
const std::string & name () const
const std::string & vendor () const
const std::string & extensions () const
bool extension_supported (const std::string &extension_name) const
 Checks if an extension is supported.
cl_uint num_devices () const
 Returns the number of devices.
device get_device (cl_uint index) const
 Returns a specific device.

Private Member Functions

 platform (cl_platform_id platform_id)
 Platform constructor.

Private Attributes

cl_platform_id platform_id_
std::string profile_
std::string version_
std::string name_
std::string vendor_
std::string extensions_
cl_uint num_devices_
boost::scoped_array< cl_device_id > device_ids_

Friends

class driver

Detailed Description

This class represents the information about a specific OpenCL platform.

It contains all information as provided by the driver.


Constructor & Destructor Documentation

cl::platform::platform ( cl_platform_id  platform_id ) [private]

Platform constructor.

Parameters:
platform_idvalid OpenCL platform ID

Retrieves all available information on the given platform


Member Function Documentation

bool cl::platform::extension_supported ( const std::string &  extension_name ) const

Checks if an extension is supported.

Parameters:
extension_namethe name of the extension
Returns:
true if the extension is supported, false otherwise
device cl::platform::get_device ( cl_uint  index ) const

Returns a specific device.

Parameters:
indexzero-based index of the device requested
Returns:
an object representing the device
cl_uint cl::platform::num_devices (  ) const

Returns the number of devices.

Returns:
the number of devices in this platform

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