Window.h

/*
 * Gamedev Framework (gf)
 * Copyright (C) 2016-2022 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 <cstdint>
#include <string>
#include <vector>
 
#include "Clock.h"
#include "Flags.h"
#include "GraphicsApi.h"
#include "Library.h"
#include "Time.h"
#include "Vector.h"
 
struct SDL_Window;
 
namespace gf {
#ifndef DOXYGEN_SHOULD_SKIP_THIS
inline namespace v1 {
#endif
 
  struct Event;
  class Cursor;
 
  enum class WindowHints : uint32_t {
    Resizable = 0x0001, 
    Visible   = 0x0002, 
    Decorated = 0x0004, 
  };
 
  enum class EventFilter {
    TouchAsMouse  = 0x0001, 
    AnyWindow     = 0x0002, 
  };
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
}
 
template<>
struct EnableBitmaskOperators<WindowHints> {
  static constexpr bool value = true;
};
 
template<>
struct EnableBitmaskOperators<EventFilter> {
  static constexpr bool value = true;
};
 
inline namespace v1 {
#endif
 
  class GF_GRAPHICS_API Window {
  public:
 
    Window(const std::string& title, Vector2i size, Flags<WindowHints> hints = All);
 
    ~Window();
 
    Window(const Window&) = delete;
 
    Window& operator=(const Window&) = delete;
 
    bool isOpen();
 
    void close();
 
    void setTitle(const std::string& title);
 
    Vector2i getPosition() const;
 
    void setPosition(Vector2i position);
 
    Vector2i getSize() const;
 
    void setSize(Vector2i size);
 
    Vector2i getFramebufferSize() const;
 
    void setFullscreen(bool full = true);
 
    void toggleFullscreen();
 
    bool isFullscreen() const {
      return m_isFullscreen;
    }
 
    bool isMinimized() const;
 
    void minimize();
 
    void restore();
 
    bool isMaximized() const;
 
    void maximize();
 
    bool isVisible() const;
 
    void show();
 
    void hide();
 
    void setVisible(bool visible = true);
 
    bool isDecorated() const;
 
    void setDecorated(bool decorated = true);
 
    bool isFocused() const;
 
    bool isResizable() const;
 
    void setResizable(bool resizable = true);
 
 
    uint32_t getWindowId() const {
      return m_windowId;
    }
 
    bool pollEvent(Event& event, Flags<EventFilter> filters = None);
 
    bool waitEvent(Event& event, Flags<EventFilter> filters = None);
 
    void setVerticalSyncEnabled(bool enabled);
 
    bool isVerticalSyncEnabled() const;
 
    void setFramerateLimit(unsigned int limit);
 
    void display();
 
    void setMouseCursorVisible(bool visible);
 
    void setMouseCursorGrabbed(bool grabbed);
 
 
    void setMouseCursor(const Cursor& cursor);
 
  private:
    friend class SharedGraphics;
    friend class RenderWindow;
 
    void makeMainContextCurrent();
    void makeSharedContextCurrent();
    void makeNoContextCurrent();
 
  private:
    static std::vector<Event> g_pendingEvents;
 
    bool pickEventForWindow(uint32_t windowId, Event& event);
 
  private:
    Library m_lib; // to automatically initialize SDL
 
  private:
    SDL_Window *m_window;
    uint32_t m_windowId;
    void *m_mainContext;
    void *m_sharedContext;
    bool m_shouldClose;
    bool m_isFullscreen;
 
    // framerate limit handling
    Clock m_clock;
    Time m_duration;
 
    unsigned m_vao;
  };
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
}
#endif
 
}
 
#endif // GL_WINDOW_H