OpenCL_platforms_list Class Reference

#include <oclutils.h>

List of all members.

Public Member Functions
void	Initialize (const std::string &_preferred_platform, const bool _use_locking=true)
	Function that initializes a platform list.
void	Print () const
	Function that prints information about all platforms in the list.
void	Print_Preferred () const
	Function that prints information about preferred platform and the device that will be used.
std::string	Get_Running_Platform ()
	Obtains the active platform.
bool	Use_Locking () const
	Function that obtains locking status.
OpenCL_platform &	operator[] (const std::string key)
	Overload array operator for accesing platforms in the list.
void	Set_Preferred_OpenCL (const int _preferred_device=-1)
	Function that sets the preferred device in the preferred platform.

---

Member Function Documentation

std::string OpenCL_platforms_list::Get_Running_Platform

(

)

[inline]

Obtains the active platform.

Returns:

preferred platform.

void OpenCL_platforms_list::Initialize	(	const std::string &	_preferred_platform,
		const bool	_use_locking = true
	)

Function that initializes a platform list.

Parameters:

_preferred_platform	preferred platform name amd, nvdia, intel, apple or -1 to select the first in the list.
_use_locking	choose if device locking will be used.

OpenCL_platform & OpenCL_platforms_list::operator[]

(

const std::string

key

)

Overload array operator for accesing platforms in the list.

Parameters:

key	platform name.

void OpenCL_platforms_list::Print

(

)

const

Function that prints information about all platforms in the list.

void OpenCL_platforms_list::Print_Preferred

(

)

const

Function that prints information about preferred platform and the device that will be used.

void OpenCL_platforms_list::Set_Preferred_OpenCL

(

const int

_preferred_device = -1

)

Function that sets the preferred device in the preferred platform.

Parameters:

_preferred_device

id of the preferred device.

bool OpenCL_platforms_list::Use_Locking

(

)

const [inline]

Function that obtains locking status.

Returns:

locking status.

---

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

• src/gcvl/opencl/oclutils.h
• src/gcvl/opencl/oclutils.cpp