systemWindow.h

/* Copyright (c) 2005-2013, Stefan Eilemann <eile@equalizergraphics.com>
 *                    2009, 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/client/types.h>
#include <eq/client/window.h>         // Window::IAttribute enum

namespace eq
{
    class SystemWindow
    {
    public:
        EQ_API SystemWindow( Window* parent );

        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 bindFrameBuffer() 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;

        EQ_API bool configInitFBO();

        EQ_API void configExitFBO();

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

        Window* getWindow() { return _window; }

        const Window* getWindow() const { return _window; }

        EQ_API Pipe* getPipe();

        EQ_API const Pipe* getPipe() const;

        EQ_API Node* getNode();

        EQ_API const Node* getNode() const;

        EQ_API Config* getConfig();

        EQ_API const Config* getConfig() const;

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

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

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

        EQ_API void setError( const int32_t error );

        EQ_API eq::fabric::Error getError() const;

        EQ_API virtual bool processEvent( const Event& event );

    private:
        Window* const _window;

        struct Private;
        Private* _private; // placeholder for binary-compatible changes
    };
}


#endif // EQ_SYSTEM_WINDOW_H