efc218a495287f0f957c486a94d6b2e58a2da318
[blender.git] / intern / ghost / intern / GHOST_DisplayManager.h
1 /**
2  * $Id$
3  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version. The Blender
9  * Foundation also sells licenses for use in proprietary software under
10  * the Blender License.  See http://www.blender.org/BL/ for information
11  * about this.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21  *
22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
23  * All rights reserved.
24  *
25  * The Original Code is: all of this file.
26  *
27  * Contributor(s): none yet.
28  *
29  * ***** END GPL/BL DUAL LICENSE BLOCK *****
30  */
31
32 /**
33
34  * $Id$
35  * Copyright (C) 2001 NaN Technologies B.V.
36  * @author      Maarten Gribnau
37  * @date        September 21, 2001
38  */
39
40 #ifndef _GHOST_DISPLAY_MANAGER_H_
41 #define _GHOST_DISPLAY_MANAGER_H_
42
43 #include "GHOST_Types.h"
44
45 #ifdef WIN32
46 #pragma warning (disable:4786) // suppress stl-MSVC debug info warning
47 #endif // WIN32
48
49 #include <vector>
50
51 /**
52  * Manages system displays  (platform independent implementation).
53  */
54
55 class GHOST_DisplayManager
56 {
57 public:
58         enum { kMainDisplay = 0 };
59         /**
60          * Constructor.
61          */
62         GHOST_DisplayManager(void);
63         
64         /**
65          * Destructor.
66          */
67         virtual ~GHOST_DisplayManager(void);
68
69         /**
70          * Initializes the list with devices and settings.
71          * @return Indication of success.
72          */
73         virtual GHOST_TSuccess initialize(void);
74
75         /**
76          * Returns the number of display devices on this system.
77          * @param numDisplays The number of displays on this system.
78          * @return Indication of success.
79          */
80         virtual GHOST_TSuccess getNumDisplays(GHOST_TUns8& numDisplays) const;
81
82         /**
83          * Returns the number of display settings for this display device.
84          * @param display The index of the display to query with 0 <= display < getNumDisplays().
85          * @param setting The number of settings of the display device with this index.
86          * @return Indication of success.
87          */
88         virtual GHOST_TSuccess getNumDisplaySettings(GHOST_TUns8 display, GHOST_TInt32& numSettings) const;
89
90         /**
91          * Returns the current setting for this display device. 
92          * @param display The index of the display to query with 0 <= display < getNumDisplays().
93          * @param index   The setting index to be returned.
94          * @param setting The setting of the display device with this index.
95          * @return Indication of success.
96          */
97         virtual GHOST_TSuccess getDisplaySetting(GHOST_TUns8 display, GHOST_TInt32 index, GHOST_DisplaySetting& setting) const;
98
99         /**
100          * Returns the current setting for this display device. 
101          * @param display The index of the display to query with 0 <= display < getNumDisplays().
102          * @param setting The current setting of the display device with this index.
103          * @return Indication of success.
104          */
105         virtual GHOST_TSuccess getCurrentDisplaySetting(GHOST_TUns8 display, GHOST_DisplaySetting& setting) const;
106
107         /**
108          * Changes the current setting for this display device.
109          * The setting given to this method is matched againts the available diplay settings.
110          * The best match is activated (@see findMatch()).
111          * @param display The index of the display to query with 0 <= display < getNumDisplays().
112          * @param setting The setting of the display device to be matched and activated.
113          * @return Indication of success.
114          */
115         virtual GHOST_TSuccess setCurrentDisplaySetting(GHOST_TUns8 display, const GHOST_DisplaySetting& setting);
116
117 protected:
118         typedef std::vector<GHOST_DisplaySetting> GHOST_DisplaySettings;
119
120         /**
121          * Finds the best display settings match.
122          * @param display       The index of the display device.
123          * @param setting       The setting to match.
124          * @param match         The optimal display setting.
125          * @return Indication of success.
126          */
127         GHOST_TSuccess findMatch(GHOST_TUns8 display, const GHOST_DisplaySetting& setting, GHOST_DisplaySetting& match) const;
128
129         /**
130          * Retrieves settings for each display device and stores them.
131          * @return Indication of success.
132          */
133         GHOST_TSuccess initializeSettings(void);
134         
135         /** Tells whether the list of display modes has been stored already. */
136         bool m_settingsInitialized;
137         /** The list with display settings for the main display. */
138         std::vector<GHOST_DisplaySettings> m_settings;
139 };
140
141
142 #endif // _GHOST_DISPLAY_MANAGER_H_