VideoMode.hpp

Warning

This page refers to an old version of SFML. Click here to switch to the latest version.

• Main Page
• Namespaces
• Classes
• Files

• File List
• File Members

• SFML
• include
• SFML
• Window

VideoMode.hpp

Go to the documentation of this file.

//
// SFML - Simple and Fast Multimedia Library
// Copyright (C) 2007-2009 Laurent Gomila (laurent.gom@gmail.com)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
//    you must not claim that you wrote the original software.
//    If you use this software in a product, an acknowledgment
//    in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
//    and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//
 
#ifndef SFML_VIDEOMODE_HPP
#define SFML_VIDEOMODE_HPP

// Headers
#include <SFML/Config.hpp>
#include <cstdlib>
 
 
namespace sf
{
class SFML_API VideoMode
{
public :

    VideoMode();

    VideoMode(unsigned int ModeWidth, unsigned int ModeHeight, unsigned int ModeBpp = 32);

    static VideoMode GetDesktopMode();

    static VideoMode GetMode(std::size_t Index);

    static std::size_t GetModesCount();

    bool IsValid() const;

    bool operator ==(const VideoMode& Other) const;

    bool operator !=(const VideoMode& Other) const;

    // Member data
    unsigned int Width;        
    unsigned int Height;       
    unsigned int BitsPerPixel; 
 
private :

    static void InitializeModes();
};
 
} // namespace sf
 
 
#endif // SFML_VIDEOMODE_HPP