systemWindow.h

/* Copyright (c) 2005-2016, Stefan Eilemann <eile@equalizergraphics.com>
 *                          Daniel Nachbaur <danielnachbaur@gmail.com>
 *                          Maxim Makhinya
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 2.1 as published
 * by the Free Software Foundation.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef EQ_SYSTEM_WINDOW_H
#define EQ_SYSTEM_WINDOW_H

#include <eq/types.h>
#include <eq/windowSettings.h> // WindowSettings::IAttribute enum

namespace eq
{
class SystemWindow
{
public:
    EQ_API SystemWindow( NotifierInterface& parent,
                         const WindowSettings& settings );

    EQ_API virtual ~SystemWindow();

    EQ_API virtual bool configInit() = 0;

    EQ_API virtual void configExit() = 0;

    EQ_API virtual void makeCurrent( const bool cache = true ) const = 0;

    EQ_API virtual void doneCurrent() const = 0;

    EQ_API virtual void bindFrameBuffer() const = 0;

    EQ_API virtual void bindDrawFrameBuffer() const = 0;

    EQ_API virtual void updateFrameBuffer() const = 0;

    EQ_API virtual void swapBuffers() = 0;

    EQ_API virtual void flush() = 0;

    EQ_API virtual void finish() = 0;

    EQ_API virtual void joinNVSwapBarrier( const uint32_t group,
                                           const uint32_t barrier ) = 0;

    virtual const util::FrameBufferObject* getFrameBufferObject()
        const { return 0; }
    virtual util::FrameBufferObject* getFrameBufferObject() { return 0; }

    EQ_API virtual void queryDrawableConfig( DrawableConfig& dc ) = 0;

    virtual const GLEWContext* glewGetContext() const { return 0; }

    EQ_API EventOCommand sendError( const uint32_t error );

    EQ_API bool processEvent( EventType type );

    EQ_API bool processEvent( EventType type, SizeEvent& event );

    EQ_API bool processEvent( EventType type, PointerEvent& event );

    EQ_API bool processEvent( EventType type, KeyEvent& event );

    EQ_API bool processEvent( EventType type, AxisEvent& event );

    EQ_API bool processEvent( EventType type, ButtonEvent& event );

    EQ_API void setPixelViewport( const PixelViewport& pvp );

    EQ_API const PixelViewport& getPixelViewport() const;

    EQ_API uint32_t getColorFormat() const;

    EQ_API void setName( const std::string& name );

    EQ_API const std::string& getName() const;

    EQ_API int32_t getIAttribute( const WindowSettings::IAttribute attr ) const;

    EQ_API const SystemWindow* getSharedContextWindow() const;

private:
    NotifierInterface& _parent;
    WindowSettings _settings;
};
}


#endif // EQ_SYSTEM_WINDOW_H