Window.hpp

Go to the documentation of this file.

#pragma once

#include <Gosu/Fwd.hpp>
#include <Gosu/Input.hpp>
#include <Gosu/Platform.hpp>
#include <memory>
#include <string>

namespace Gosu
{
    class Window
    {
        struct Impl;
        const std::unique_ptr<Impl> pimpl;

    public:
        Window(unsigned width, unsigned height, bool fullscreen = false,
            double update_interval = 16.666666, bool resizable = false);
        virtual ~Window();

        unsigned width() const;
        unsigned height() const;
        bool fullscreen() const;
        bool resizable() const;
        void resize(unsigned width, unsigned height, bool fullscreen);

        double update_interval() const;
        void set_update_interval(double update_interval);

        std::string caption() const;
        void set_caption(const std::string& caption);

        virtual void show();

        virtual bool tick();

        virtual void close();

        virtual void update() {}

        virtual void draw() {}

        virtual bool needs_redraw() const { return true; }

        virtual bool needs_cursor() const { return true; }

        virtual void lose_focus() {}

        virtual void release_memory() {}

        virtual void button_down(Gosu::Button);

        virtual void button_up(Gosu::Button) {}

        virtual void gamepad_connected(int index) {}

        virtual void gamepad_disconnected(int index) {}

        virtual void drop(const std::string& filename) {}

        // Ignore when SWIG is wrapping this class for Ruby/Gosu.
        #ifndef SWIG
        // Callbacks for touch events. So far these are only used on iOS.
        virtual void touch_began(Touch touch) {}
        virtual void touch_moved(Touch touch) {}
        virtual void touch_ended(Touch touch) {}
        virtual void touch_cancelled(Touch touch) {}

        const Graphics& graphics() const;
        Graphics& graphics();

        const Input& input() const;
        Input& input();
        #endif

        #ifdef GOSU_IS_IPHONE
        void* uikit_window() const;
        #endif
    };

    unsigned screen_width(Window* window = nullptr);

    unsigned screen_height(Window* window = nullptr);

    unsigned available_width(Window* window = nullptr);

    unsigned available_height(Window* window = nullptr);
}