include/eq/client/glx/window.h

/* Copyright (c) 2005-2012, 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_GLX_WINDOW_H
#define EQ_GLX_OS_WINDOW_H

#include <eq/client/glx/types.h>
#include <eq/client/glWindow.h>       // base class

namespace eq
{
namespace glx
{
    class WindowIF : public GLWindow
    {
    public:
        WindowIF( eq::Window* parent ) : GLWindow( parent ) {}
        virtual ~WindowIF() {}

        virtual GLXContext getGLXContext() const = 0;

        virtual XID getXDrawable() const = 0;

        virtual Display* getXDisplay() = 0;

        EQ_API virtual bool processEvent( const WindowEvent& event ) = 0;
    };

    class Window : public WindowIF
    {
    public:
        Window( eq::Window* parent, Display* xDisplay = 0,
                GLXEWContext* glxewContext = 0 );

        virtual ~Window();

        virtual bool configInit();

        virtual void configExit();

        virtual GLXFBConfig* chooseGLXFBConfig();

        virtual GLXContext createGLXContext( GLXFBConfig* fbConfig );

        virtual bool configInitGLXDrawable( GLXFBConfig* fbConfig );
        
        virtual bool configInitGLXWindow( GLXFBConfig* fbConfig );

        virtual bool configInitGLXPBuffer( GLXFBConfig* fbConfig );

        EQ_API virtual void initEventHandler();

        EQ_API virtual void exitEventHandler();

        virtual GLXContext getGLXContext() const { return _glXContext; }

        virtual XID getXDrawable() const { return _xDrawable; }

        virtual Display* getXDisplay() { return _xDisplay; }

        GLXEWContext* glxewGetContext() { return _glxewContext; }

        virtual void setXDrawable( XID drawable );

        virtual void setGLXContext( GLXContext context );

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

        virtual void swapBuffers();

        virtual void joinNVSwapBarrier( const uint32_t group,
                                        const uint32_t barrier );

        void leaveNVSwapBarrier();

        EQ_API virtual bool processEvent( const WindowEvent& event );

    private:
        Display*   _xDisplay;
        XID        _xDrawable;
        GLXContext _glXContext;
        uint32_t _glXNVSwapGroup;

        EventHandler* _glXEventHandler;

        GLXEWContext* _glxewContext;

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

        XID _createGLXWindow( GLXFBConfig* fbConfig, const PixelViewport& pvp );

        void _initSwapSync();
    };
}
}
#endif // EQ_GLX_OS_WINDOW_H