/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */

#include <com/sun/star/sheet/opencl/OpenCLPlatform.idl>

module com { module sun { module star { module sheet { module opencl {

interface XOpenCLSelection : com::sun::star::uno::XInterface
{

    /**
     * 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.
     */
    boolean isOpenCLEnabled();

    /**
     * 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.
     */
    void enableOpenCL( [in] boolean enable );

    /**
     * Enables automatic OpenCL Device Selection
     * @param force forces a new evaluation of the best device
     */
    void enableAutomaticDeviceSelection( [in] boolean force );

    /**
     * Disbales automatic OpenCL Device Selection
     */
    void disableAutomaticDeviceSelection();

    /**
     * Set the OpenCL device with the platform ID and device ID
     * Uses the ID of the platform and the device
     */
    void selectOpenCLDevice( [in] long platform, [in] long device );

    /**
     * returns the platform id of the currently selected device
     */
    long getPlatformID();

    /**
     * returns the device id of the currently selected device
     */
    long getDeviceID();

    /**
     * lists all OpenCL devices and platforms
     */
    sequence< OpenCLPlatform > getOpenCLPlatforms();

};

}; }; }; }; };

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
