Clarify what "ID" means

Change-Id: Idfc3e90acf8fecaff5d11964c2197bf1610f558b
This commit is contained in:
Tor Lillqvist
2014-12-22 14:29:29 +02:00
parent 2116f511bd
commit c14a6d0d35

View File

@@ -43,18 +43,29 @@ interface XOpenCLSelection : com::sun::star::uno::XInterface
void disableAutomaticDeviceSelection(); void disableAutomaticDeviceSelection();
/** /**
* Set the OpenCL device with the platform ID and device ID * Select the OpenCL device with the given platform and device
* Uses the ID of the platform and the device * number. The platform number corresponds to an index into the
* sequence returned by getOpenCLPlatforms, and the device number
* corresponds to an index into the sequence of devices in that
* platform.
*/ */
void selectOpenCLDevice( [in] long platform, [in] long device ); void selectOpenCLDevice( [in] long platform, [in] long device );
/** /**
* returns the platform id of the currently selected device * returns the index of the platform of the currently selected
* device. This is an index into the sequence that
* getOpenCLPlatforms returns in the current instance of
* LibreOffice (and not some a priori defined identifier for an
* OpenCL platform).
*/ */
long getPlatformID(); long getPlatformID();
/** /**
* returns the device id of the currently selected device * returns the index of the currently selected device. This is an
* index into the sequence of devices in the OpenCLPLatform object
* the device is part of in the current instance of LibreOffice
* (and not some a priori defined identifier for a specific model
* of device accessed through a specific platform).
*/ */
long getDeviceID(); long getDeviceID();