LibreOffice
LibreOffice 4.4 SDK API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | List of all members
XOpenCLSelection Interface Reference

import"XOpenCLSelection.idl";

Inheritance diagram for XOpenCLSelection:
XInterface

Public Member Functions

boolean isOpenCLEnabled ()
 Returns true if calculation with OpenCL is enabled (at all). More...
 
void enableOpenCL ([in] boolean enable)
 Enables or disables use of OpenCL for calculations. More...
 
void enableAutomaticDeviceSelection ([in] boolean force)
 Enables automatic OpenCL Device Selection. More...
 
void disableAutomaticDeviceSelection ()
 Disbales automatic OpenCL Device Selection. More...
 
void selectOpenCLDevice ([in] long platform, [in] long device)
 Set the OpenCL device with the platform ID and device ID Uses the ID of the platform and the device. More...
 
long getPlatformID ()
 returns the platform id of the currently selected device More...
 
long getDeviceID ()
 returns the device id of the currently selected device More...
 
sequence< OpenCLPlatformgetOpenCLPlatforms ()
 lists all OpenCL devices and platforms More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Member Function Documentation

void disableAutomaticDeviceSelection ( )

Disbales automatic OpenCL Device Selection.

void enableAutomaticDeviceSelection ( [in] boolean  force)

Enables automatic OpenCL Device Selection.

Parameters
forceforces a new evaluation of the best device
void enableOpenCL ( [in] boolean  enable)

Enables or disables use of OpenCL for calculations.

When using this API to enable OpenCL the configuration parameters are set to their built-in default values, not ones read from the installation of user-specific configuration.

long getDeviceID ( )

returns the device id of the currently selected device

sequence< OpenCLPlatform > getOpenCLPlatforms ( )

lists all OpenCL devices and platforms

long getPlatformID ( )

returns the platform id of the currently selected device

boolean isOpenCLEnabled ( )

Returns true if calculation with OpenCL is enabled (at all).

The actual use of OpenCL for a formula is also affected by the configuration settings specifying whether OpenCL is used for all opcodes or just for a subset, and the black- and whitelists of OpenCL implementations that are in use.

void selectOpenCLDevice ( [in] long  platform,
[in] long  device 
)

Set the OpenCL device with the platform ID and device ID Uses the ID of the platform and the device.


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