Window/Window.hpp

Warning

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

• Main Page
• Related Pages
• Topics
• Namespaces
• Classes
• Files

• File List
• File Members

• SFML
• include
• SFML
• Window

Window/Window.hpp

Go to the documentation of this file.

//
// SFML - Simple and Fast Multimedia Library
// Copyright (C) 2007-2016 Laurent Gomila (laurent@sfml-dev.org)
//
// 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_WINDOW_HPP
#define SFML_WINDOW_HPP

// Headers
#include <SFML/Window/Export.hpp>
#include <SFML/Window/ContextSettings.hpp>
#include <SFML/Window/VideoMode.hpp>
#include <SFML/Window/WindowHandle.hpp>
#include <SFML/Window/WindowStyle.hpp>
#include <SFML/Window/GlResource.hpp>
#include <SFML/System/Clock.hpp>
#include <SFML/System/Vector2.hpp>
#include <SFML/System/NonCopyable.hpp>
#include <SFML/System/String.hpp>
 
 
namespace sf
{
namespace priv
{
    class GlContext;
    class WindowImpl;
}
 
class Event;

class SFML_WINDOW_API Window : GlResource, NonCopyable
{
public:

    Window();

    Window(VideoMode mode, const String& title, Uint32 style = Style::Default, const ContextSettings& settings = ContextSettings());

    explicit Window(WindowHandle handle, const ContextSettings& settings = ContextSettings());

    virtual ~Window();

    void create(VideoMode mode, const String& title, Uint32 style = Style::Default, const ContextSettings& settings = ContextSettings());

    void create(WindowHandle handle, const ContextSettings& settings = ContextSettings());

    void close();

    bool isOpen() const;

    const ContextSettings& getSettings() const;

    bool pollEvent(Event& event);

    bool waitEvent(Event& event);

    Vector2i getPosition() const;

    void setPosition(const Vector2i& position);

    Vector2u getSize() const;

    void setSize(const Vector2u& size);

    void setTitle(const String& title);

    void setIcon(unsigned int width, unsigned int height, const Uint8* pixels);

    void setVisible(bool visible);

    void setVerticalSyncEnabled(bool enabled);

    void setMouseCursorVisible(bool visible);

    void setMouseCursorGrabbed(bool grabbed);

    void setKeyRepeatEnabled(bool enabled);

    void setFramerateLimit(unsigned int limit);

    void setJoystickThreshold(float threshold);

    bool setActive(bool active = true) const;

    void requestFocus();

    bool hasFocus() const;

    void display();

    WindowHandle getSystemHandle() const;
 
protected:

    virtual void onCreate();

    virtual void onResize();
 
private:

    bool filterEvent(const Event& event);

    void initialize();

    // Member data
    priv::WindowImpl* m_impl;           
    priv::GlContext*  m_context;        
    Clock             m_clock;          
    Time              m_frameTimeLimit; 
    Vector2u          m_size;           
};
 
} // namespace sf
 
 
#endif // SFML_WINDOW_HPP