Window.h

/*
 * Gamedev Framework (gf)
 * Copyright (C) 2016-2017 Julien Bernard
 *
 * 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.
 *
 * Part of this file comes from SFML, with the same license:
 * Copyright (C) 2007-2015 Laurent Gomila (laurent@sfml-dev.org)
 */
#ifndef GF_WINDOW_H
#define GF_WINDOW_H

#include <string>

#include "Clock.h"
#include "Flags.h"
#include "Library.h"
#include "Portability.h"
#include "StringRef.h"
#include "Time.h"
#include "Vector.h"

struct SDL_Window;

namespace gf {
#ifndef DOXYGEN_SHOULD_SKIP_THIS
inline namespace v1 {
#endif

  struct Event;

  enum class WindowHints : uint32_t {
    Resizable = 0x0001, 
    Visible   = 0x0002, 
    Decorated = 0x0004, 
  };

  using WindowFlags = Flags<WindowHints>;
#ifndef DOXYGEN_SHOULD_SKIP_THIS
}

template<>
struct EnableBitmaskOperators<WindowHints> {
  static constexpr bool value = true;
};

inline namespace v1 {
#endif

  class GF_API Window {
  public:

    Window(StringRef title, Vector2u size, WindowFlags hints = WindowFlags(All));

    ~Window();

    Window(const Window&) = delete;

    Window& operator=(const Window&) = delete;

    bool isOpen();

    void close();

    void setTitle(StringRef title);

    Vector2i getPosition() const;

    void setPosition(Vector2i position);

    Vector2u getSize() const;

    void setSize(Vector2u size);

    Vector2u getFramebufferSize() const;

    void setFullscreen(bool full = true);

    void toggleFullscreen();

    bool isFullscreen() const {
      return m_isFullscreen;
    }

    void minimize();

    void restore();

    void maximize();

    void show();

    void hide();

    void setVisible(bool visible = true);

    void setDecorated(bool decorated = true);

    bool isFocused() const;

    bool isMinimized() const;

    bool isResizable() const;

    bool isVisible() const;

    bool isDecorated() const;

    bool pollEvent(Event& event);

    bool waitEvent(Event& event);

    void setVerticalSyncEnabled(bool enabled);

    bool isVerticalSyncEnabled() const;

    void setFramerateLimit(unsigned int limit);

    void display();

    void setMouseCursorVisible(bool visible);

    void setMouseCursorGrabbed(bool grabbed);

  private:
    Library m_lib; // to automatically initialize SDL

  private:
    SDL_Window *m_window;
    void *m_context;
    bool m_shouldClose;
    bool m_isFullscreen;

    // framerate limit handling
    Clock m_clock;
    Time m_duration;
  };

#ifndef DOXYGEN_SHOULD_SKIP_THIS
}
#endif

}

#endif // GL_WINDOW_H