Window.hpp

Go to the documentation of this file.

#ifndef GOSU_WINDOW_HPP
#define GOSU_WINDOW_HPP

#include <Gosu/Fwd.hpp>
#include <Gosu/Platform.hpp>
#include <Gosu/Input.hpp>
#include <boost/scoped_ptr.hpp>
#include <boost/shared_ptr.hpp>
#include <boost/function.hpp>
#include <string>

#ifdef GOSU_IS_WIN
#include <windows.h>
#endif

namespace Gosu
{
    class Window
    {
        struct Impl;
        boost::scoped_ptr<Impl> pimpl;

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

        std::wstring caption() const;
        void setCaption(const std::wstring& caption);
        
        double updateInterval() const;

        void show();
        void close();

        virtual void update() {}
        virtual void draw() {}
        
        virtual bool needsRedraw() const { return true; }
        
        virtual void buttonDown(Gosu::Button) {}
        virtual void buttonUp(Gosu::Button) {}
        
        // Ignore when SWIG is wrapping this class for Ruby/Gosu.
        #ifndef SWIG
        
        const Graphics& graphics() const;
        Graphics& graphics();
        
        const Input& input() const;
        Input& input();
        
        #ifdef GOSU_IS_WIN
        // Only on Windows, used for integrating with GUI toolkits.
        HWND handle() const;
        virtual LRESULT handleMessage(UINT message, WPARAM wparam,
            LPARAM lparam);
        #endif
        
        #ifdef GOSU_IS_UNIX
        // Context for creating shared contexts.
        // Only on Unices (so far).
        typedef boost::shared_ptr<boost::function<void()> > SharedContext;
        SharedContext createSharedContext();
        #endif
        
        #ifdef GOSU_IS_IPHONE
        // iPhone-only callbacks for touch events.
        // Note that it does not hurt to override them even if you compile
        // for another platform; if you don't specify "virtual" the code
        // should even be stripped away cleanly.
        virtual void touchesBegan(const Touches& touches) {}
        virtual void touchesMoved(const Touches& touches) {}
        virtual void touchesEnded(const Touches& touches) {}
        // Currently known touches.
        const Touches& currentTouches() const;
        #endif        
        
        #endif
        
        // Deprecated.
        const Audio& audio() const;
        Audio& audio();
    };
}

#endif

Documentation not clear enough? Please go to one of the places listed on http://www.libgosu.org/ and leave feedback. Thanks!