Documentation of SFML 2.4.1

Warning: this page refers to an old version of SFML. Click here to switch to the latest version.
VideoMode.hpp
1 //
3 // SFML - Simple and Fast Multimedia Library
4 // Copyright (C) 2007-2016 Laurent Gomila (laurent@sfml-dev.org)
5 //
6 // This software is provided 'as-is', without any express or implied warranty.
7 // In no event will the authors be held liable for any damages arising from the use of this software.
8 //
9 // Permission is granted to anyone to use this software for any purpose,
10 // including commercial applications, and to alter it and redistribute it freely,
11 // subject to the following restrictions:
12 //
13 // 1. The origin of this software must not be misrepresented;
14 // you must not claim that you wrote the original software.
15 // If you use this software in a product, an acknowledgment
16 // in the product documentation would be appreciated but is not required.
17 //
18 // 2. Altered source versions must be plainly marked as such,
19 // and must not be misrepresented as being the original software.
20 //
21 // 3. This notice may not be removed or altered from any source distribution.
22 //
24 
25 #ifndef SFML_VIDEOMODE_HPP
26 #define SFML_VIDEOMODE_HPP
27 
29 // Headers
31 #include <SFML/Window/Export.hpp>
32 #include <vector>
33 
34 
35 namespace sf
36 {
41 class SFML_WINDOW_API VideoMode
42 {
43 public:
44 
51  VideoMode();
52 
61  VideoMode(unsigned int modeWidth, unsigned int modeHeight, unsigned int modeBitsPerPixel = 32);
62 
69  static VideoMode getDesktopMode();
70 
85  static const std::vector<VideoMode>& getFullscreenModes();
86 
97  bool isValid() const;
98 
100  // Member data
102  unsigned int width;
103  unsigned int height;
104  unsigned int bitsPerPixel;
105 };
106 
117 SFML_WINDOW_API bool operator ==(const VideoMode& left, const VideoMode& right);
118 
129 SFML_WINDOW_API bool operator !=(const VideoMode& left, const VideoMode& right);
130 
141 SFML_WINDOW_API bool operator <(const VideoMode& left, const VideoMode& right);
142 
153 SFML_WINDOW_API bool operator >(const VideoMode& left, const VideoMode& right);
154 
165 SFML_WINDOW_API bool operator <=(const VideoMode& left, const VideoMode& right);
166 
177 SFML_WINDOW_API bool operator >=(const VideoMode& left, const VideoMode& right);
178 
179 } // namespace sf
180 
181 
182 #endif // SFML_VIDEOMODE_HPP
183 
184 
unsigned int width
Video mode width, in pixels.
Definition: VideoMode.hpp:102
unsigned int height
Video mode height, in pixels.
Definition: VideoMode.hpp:103
unsigned int bitsPerPixel
Video mode pixel depth, in bits per pixels.
Definition: VideoMode.hpp:104
VideoMode defines a video mode (width, height, bpp)
Definition: VideoMode.hpp:41