OpenCL_platform Class Reference

#include <oclutils.h>

List of all members.

Public Member Functions
	OpenCL_platform ()
	Default constructor.
void	Initialize (std::string _key, int id_offset, cl_platform_id _id, OpenCL_platforms_list *_platform_list, const std::string preferred_platform)
	Function that initializes all the platform parameters.
OpenCL_device &	Preferred_OpenCL ()
	Obtains the preferred OpenCL device.
cl_device_id &	Preferred_OpenCL_Device ()
	Obtains the preferred OpenCL device id.
cl_context &	Preferred_OpenCL_Device_Context ()
	Obtains the preferred OpenCL device context.
OpenCL_platforms_list *	Platform_List () const
	Obtains the parent OpenCL platform list.
void	Print_Preferred () const
	Function that prints the preferred device info.
std::string	Key () const
	Obtains the platform key.
std::string const	Name () const
	Obtains the platform name.
cl_platform_id	Id () const
	Obtains the platform id.
int	Id_Offset () const
	Obtains the platform id offset.
void	Lock_Best_Device ()
	Function that tries to lock the best device available in the platform for use.
void	Print () const
	Function that prints information about the platform.
Public Attributes
OpenCL_devices_list	devices_list

---

Constructor & Destructor Documentation

OpenCL_platform::OpenCL_platform

(

)

Default constructor.

---

Member Function Documentation

cl_platform_id OpenCL_platform::Id

(

)

const [inline]

Obtains the platform id.

Returns:

platform id.

int OpenCL_platform::Id_Offset

(

)

const [inline]

Obtains the platform id offset.

Returns:

platform id offset.

void OpenCL_platform::Initialize	(	std::string	_key,
		int	_id_offset,
		cl_platform_id	_id,
		OpenCL_platforms_list *	_platform_list,
		const std::string	preferred_platform
	)

Function that initializes all the platform parameters.

Parameters:

_key	platform key.
_id_offset	platform id offset value.
_id	platform id.
_platform_list	pointer to the platform list.
preferred_platform	preferred platform name.

std::string OpenCL_platform::Key

(

)

const [inline]

Obtains the platform key.

Returns:

platform key.

void OpenCL_platform::Lock_Best_Device

(

)

Function that tries to lock the best device available in the platform for use.

std::string const OpenCL_platform::Name

(

)

const [inline]

Obtains the platform name.

Returns:

platform name.

OpenCL_platforms_list* OpenCL_platform::Platform_List

(

)

const [inline]

Obtains the parent OpenCL platform list.

Returns:

parent OpenCL platform list.

OpenCL_device& OpenCL_platform::Preferred_OpenCL

(

)

[inline]

Obtains the preferred OpenCL device.

Returns:

preferred OpenCL device.

cl_device_id& OpenCL_platform::Preferred_OpenCL_Device

(

)

[inline]

Obtains the preferred OpenCL device id.

Returns:

preferred OpenCL device id.

cl_context& OpenCL_platform::Preferred_OpenCL_Device_Context

(

)

[inline]

Obtains the preferred OpenCL device context.

Returns:

preferred OpenCL device context.

void OpenCL_platform::Print

(

)

const

Function that prints information about the platform.

void OpenCL_platform::Print_Preferred

(

)

const

Function that prints the preferred device info.

---

Member Data Documentation

OpenCL_devices_list OpenCL_platform::devices_list

---

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

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