linbox
Public Member Functions
OpenCLEnviron Class Reference

Container for all pertenant information needed to use an OpenCL device, compile kernels for the device, track resource usage, and gain exclusive access to the device. More...

#include <opencl-environ.h>

Public Member Functions

std::string getPlatformName () const
 getPlatformName() returns string with platform name
 
double getPlatformVersion () const
 getPlatformVersion() returns double with platform version
 
const std::vector< std::string > & getPlatformExtensions () const
 getPlatformExtensions() returns a constant reference to the vector with the platform extensions supported by this environ
 
const std::vector< std::string > & getDeviceExtensions () const
 getDeviceExtensions() returns a constant reference to the vector with the device extensions supported by this environ
 
unsigned int getIDNum () const
 getIDNum() returns the unsigned int with the OpenCLEnviron ID number
 
cl_context getContext () const
 getContext() accessor for the context associated with environ
 
cl_device_id getDevice () const
 getDevice() accessor for the device associated with environ
 
cl_command_queue getCommandQueue () const
 getCommandQueue() accessor for thecommand queue associated with environ
 
cl_int getErrorCode () const
 getErrorCode() accessor for the error code associated with environ
 
void setErrorCode (cl_int err)
 setErrorCode() accessor for setting error code associated with environ
 
unsigned long getMemCapacity () const
 getMemCapacity() accessor for the memory capacity associated with environ
 
unsigned long getMaxBufferSize () const
 getMaxBufferSize() accessor for the maximum buffer size associated with environ
 
unsigned long getMemInUse () const
 getMemInUse() accessor for the memory currently in use by the environ
 
unsigned long getMemAvailable () const
 getMemAvailable() accessor for the memory available in the environ
 
void memAllocated (unsigned long alloc)
 memAllocated() setter for updating the memory levels
 
void memDeallocated (unsigned long dealloc)
 memDeallocated() setter for updating the memory levels
 
bool isCPU () const
 isCPU() accessor for the device type in the environ
 
bool isGPU () const
 isGPU() accessor for the device type in the environ
 
bool isAccelerator () const
 isAccelerator() accessor for the device type in the environ
 
bool isOtherDevice () const
 isOtherDevice() accessor for the device type in the environ
 
void acquireEnviron ()
 acquireEnviron() accessor for gaining exclusive access to the environ
 
void releaseEnviron ()
 releaseEnviron() accessor for releasing exclusive access to the environ
 
pthread_mutex_t * getDeviceLock ()
 getDeviceLock() accessor for underlying lock in the environ
 

Detailed Description

Container for all pertenant information needed to use an OpenCL device, compile kernels for the device, track resource usage, and gain exclusive access to the device.

Complies to the OpenCL 1.0 spec


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