booster.h
Go to the documentation of this file.
/*
* Copyright © 2013 Canonical Ltd.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3 as
* published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* Authored by: Thomas Voß <thomas.voss@canonical.com>
*/
#ifndef UBUNTU_HARDWARE_BOOSTER_H_
#define UBUNTU_HARDWARE_BOOSTER_H_
#include <ubuntu/visibility.h>
#include <stdint.h>
#include <stddef.h>
#ifdef __cplusplus
extern "C" {
#endif
typedef enum
{
U_HARDWARE_BOOSTER_SCENARIO_USER_INTERACTION
} UbuntuHardwareBoosterScenario;
typedef UbuntuHardwareBoosterScenario UHardwareBoosterScenario;
typedef struct UbuntuHardwareBooster;
typedef UbuntuHardwareBooster UHardwareBooster;
UBUNTU_DLL_PUBLIC UHardwareBooster*
u_hardware_booster_new();
UBUNTU_DLL_PUBLIC void
u_hardware_booster_ref(UHardwareBooster*);
UBUNTU_DLL_PUBLIC void
u_hardware_booster_unref(UHardwareBooster*);
UBUNTU_DLL_PUBLIC void
u_hardware_booster_enable_scenario(UHardwareBooster*, UHardwareBoosterScenario);
UBUNTU_DLL_PUBLIC void
u_hardware_booster_disable_scenario(UHardwareBooster*, UHardwareBoosterScenario);
#ifdef __cplusplus
}
#endif
#endif // UBUNTU_HARDWARE_BOOSTER_H_
u_hardware_booster_enable_scenario
UBUNTU_DLL_PUBLIC void u_hardware_booster_enable_scenario(UHardwareBooster *, UHardwareBoosterScenario)
u_hardware_booster_disable_scenario
UBUNTU_DLL_PUBLIC void u_hardware_booster_disable_scenario(UHardwareBooster *, UHardwareBoosterScenario)
U_HARDWARE_BOOSTER_SCENARIO_USER_INTERACTION
Boost device performance to account for user interacting with device.
Definition: booster.h:33
u_hardware_booster_new
UBUNTU_DLL_PUBLIC UHardwareBooster * u_hardware_booster_new()
u_hardware_booster_new creates a new UHardwareBooster* instance with an initial referrence count of 1...
UHardwareBooster
UbuntuHardwareBooster UHardwareBooster
UbuntuHardwareBooster is an opaque type providing access to the performance booster capabilities of t...
Definition: booster.h:41
visibility.h
u_hardware_booster_ref
UBUNTU_DLL_PUBLIC void u_hardware_booster_ref(UHardwareBooster *)
u_hardware_booster_ref increases the reference count of booster by 1.
UHardwareBoosterScenario
UbuntuHardwareBoosterScenario UHardwareBoosterScenario
Enumerates all known performance boosting scenarios.
Definition: booster.h:37
UBUNTU_DLL_PUBLIC
#define UBUNTU_DLL_PUBLIC
Definition: visibility.h:26
UbuntuHardwareBoosterScenario
UbuntuHardwareBoosterScenario
Definition: booster.h:30
u_hardware_booster_unref
UBUNTU_DLL_PUBLIC void u_hardware_booster_unref(UHardwareBooster *)
u_hardware_booster_unref decreases the reference count of booster by 1.