forked from opdenkamp/xbmc
-
Notifications
You must be signed in to change notification settings - Fork 14
/
DPMSSupport.h
89 lines (79 loc) · 3.41 KB
/
DPMSSupport.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
/*
* Copyright (C) 2009 Team XBMC
* http://xbmc.org
*
* This Program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2, or (at your option)
* any later version.
*
* 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with XBMC; see the file COPYING. If not, write to
* the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
* http://www.gnu.org/copyleft/gpl.html
*
*/
#ifndef DPMSSUPPORT_H
#define DPMSSUPPORT_H
#include <vector>
// This class encapsulates support for monitor power-saving features (DPMS).
// An instance is connected to a Surface, provides information on which
// power-saving features are available for that screen, and it is able to
// turn power-saving on an off.
// Note that SDL turns off DPMS timeouts at the beginning of the application.
class DPMSSupport
{
public:
// All known DPMS power-saving modes, on any platform.
enum PowerSavingMode
{
STANDBY, SUSPEND, OFF,
NUM_MODES
};
// Initializes an instance tied to the specified Surface. The Surface object
// must be alive for as long as this instance is in use.
DPMSSupport();
// Whether power-saving is supported on this screen.
bool IsSupported() const { return !m_supportedModes.empty(); }
// Which power-saving modes are supported, in the order of preference (i.e.
// the first mode should be the best choice).
const std::vector<PowerSavingMode>& GetSupportedModes() const
{
return m_supportedModes;
}
// Whether a given mode is supported.
bool IsModeSupported(PowerSavingMode mode) const;
// Untranslated name of the mode, for logging.
static const char* GetModeName(PowerSavingMode mode);
// Returns true if the given mode is valid (a member of PowerSavingMode).
// Returns false and logs an error message otherwise.
static bool CheckValidMode(PowerSavingMode mode);
// Turns on the specified power-saving mode, which must be valid
// and supported. Returns false if this failed.
bool EnablePowerSaving(PowerSavingMode mode);
// Turns off power-saving mode. You should only call this if the display
// is currently in a power-saving mode, to avoid visual artifacts.
bool DisablePowerSaving();
private:
std::vector<PowerSavingMode> m_supportedModes;
// Platform-specific code: add new #ifdef'ed implementations in the .cc file.
//
// Initializes DPMS support. Should populate m_supportedModes with the
// preferred order of the modes, if supported, otherwise leave it empty.
// If the latter, it should log a message about exactly why DPMS is not
// available.
void PlatformSpecificInit();
// Should turn on power-saving on the current platform. The mode is
// guaranteed to be one of m_supportedModes. Should return false on failure,
// and log a (platform-specific) ERROR message.
bool PlatformSpecificEnablePowerSaving(PowerSavingMode mode);
// Should turn off power-saving on the current platform. Should return
// false on failure and log a (platform-specific) ERROR message.
bool PlatformSpecificDisablePowerSaving();
};
#endif // DPMSSUPPORT_H