SFML logo
  • Main Page
  • Namespaces
  • Classes
  • Files
  • File List

VideoMode.hpp

00001 
00002 //
00003 // SFML - Simple and Fast Multimedia Library
00004 // Copyright (C) 2007-2009 Laurent Gomila (laurent.gom@gmail.com)
00005 //
00006 // This software is provided 'as-is', without any express or implied warranty.
00007 // In no event will the authors be held liable for any damages arising from the use of this software.
00008 //
00009 // Permission is granted to anyone to use this software for any purpose,
00010 // including commercial applications, and to alter it and redistribute it freely,
00011 // subject to the following restrictions:
00012 //
00013 // 1. The origin of this software must not be misrepresented;
00014 //    you must not claim that you wrote the original software.
00015 //    If you use this software in a product, an acknowledgment
00016 //    in the product documentation would be appreciated but is not required.
00017 //
00018 // 2. Altered source versions must be plainly marked as such,
00019 //    and must not be misrepresented as being the original software.
00020 //
00021 // 3. This notice may not be removed or altered from any source distribution.
00022 //
00024 
00025 #ifndef SFML_VIDEOMODE_HPP
00026 #define SFML_VIDEOMODE_HPP
00027 
00029 // Headers
00031 #include <SFML/Config.hpp>
00032 #include <cstdlib>
00033 
00034 
00035 namespace sf
00036 {
00041 class SFML_API VideoMode
00042 {
00043 public :
00044 
00051     VideoMode();
00052 
00061     VideoMode(unsigned int width, unsigned int height, unsigned int bitsPerPixel = 32);
00062 
00069     static VideoMode GetDesktopMode();
00070 
00083     static VideoMode GetMode(std::size_t index);
00084 
00095     static std::size_t GetModesCount();
00096 
00107     bool IsValid() const;
00108 
00110     // Member data
00112     unsigned int Width;        
00113     unsigned int Height;       
00114     unsigned int BitsPerPixel; 
00115 };
00116 
00129 SFML_API bool operator ==(const VideoMode& left, const VideoMode& right);
00130 
00143 SFML_API bool operator !=(const VideoMode& left, const VideoMode& right);
00144 
00145 } // namespace sf
00146 
00147 
00148 #endif // SFML_VIDEOMODE_HPP
00149 
00150 

 ::  Copyright © 2007-2008 Laurent Gomila, all rights reserved  ::  Documentation generated by doxygen 1.5.2  ::