VideoMode.hpp
1
2//
3// SFML - Simple and Fast Multimedia Library
4// Copyright (C) 2007-2009 Laurent Gomila (laurent.gom@gmail.com)
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/Config.hpp>
32#include <cstdlib>
33
34
35namespace sf
36{
42class SFML_API VideoMode
43{
44public :
45
50 VideoMode();
51
60 VideoMode(unsigned int ModeWidth, unsigned int ModeHeight, unsigned int ModeBpp = 32);
61
69
80 static VideoMode GetMode(std::size_t Index);
81
88 static std::size_t GetModesCount();
89
96 bool IsValid() const;
97
106 bool operator ==(const VideoMode& Other) const;
107
116 bool operator !=(const VideoMode& Other) const;
117
119 // Member data
121 unsigned int Width;
122 unsigned int Height;
123 unsigned int BitsPerPixel;
124
125private :
126
130 static void InitializeModes();
131};
132
133} // namespace sf
134
135
136#endif // SFML_VIDEOMODE_HPP
VideoMode()
Default constructor.
Definition VideoMode.cpp:67
static VideoMode GetDesktopMode()
Get the current desktop video mode.
Definition VideoMode.cpp:91
static std::size_t GetModesCount()
Get valid video modes count.
static VideoMode GetMode(std::size_t Index)
Get a valid video mode Index must be in range [0, GetModesCount()[ Modes are sorted from best to wors...
bool IsValid() const
Tell whether or not the video mode is supported.
unsigned int Width
Video mode width, in pixels.
unsigned int BitsPerPixel
Video mode pixel depth, in bits per pixels.
unsigned int Height
Video mode height, in pixels.