include/eq/client/wgl/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_WGL_WINDOW_H
#define EQ_WGL_WINDOW_H

#include <eq/client/glWindow.h>       // base class
#include <eq/client/gl.h>             // for HPBUFFERARB from wglew.h
#include <eq/client/wgl/types.h>

namespace eq
{
namespace wgl
{
    class WindowIF : public GLWindow
    {
    public:
        WindowIF( eq::Window* parent ) : GLWindow( parent ) {}

        virtual ~WindowIF() {}

        EQ_API virtual HGLRC getWGLContext() const = 0;

        EQ_API virtual HWND getWGLWindowHandle() const = 0;

        EQ_API virtual HPBUFFERARB getWGLPBufferHandle() const = 0;

        EQ_API virtual HDC getWGLDC() const = 0;

        virtual HDC getWGLAffinityDC() { return 0; }

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

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

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

        EQ_API virtual ~Window( );

        EQ_API virtual void setWGLContext( HGLRC context );


        EQ_API virtual void setWGLWindowHandle( HWND handle );
        
        EQ_API virtual void setWGLPBufferHandle( HPBUFFERARB handle );

        virtual HWND getWGLWindowHandle() const { return _wglWindow; }

        virtual HPBUFFERARB getWGLPBufferHandle() const { return _wglPBuffer; }

        virtual HDC getWGLDC() const { return _wglDC; }

        virtual HGLRC getWGLContext() const { return _wglContext; }

        const EventHandler* getWGLEventHandler() const 
            { return _wglEventHandler; }

        EQ_API virtual bool configInit();

        EQ_API virtual void configExit( );

        EQ_API virtual bool initWGLAffinityDC();

        EQ_API virtual void exitWGLAffinityDC();

        EQ_API virtual HDC getWGLAffinityDC();

        EQ_API virtual HDC createWGLDisplayDC();

        EQ_API virtual int chooseWGLPixelFormat();

        EQ_API virtual bool configInitWGLDrawable( int pixelFormat );

        EQ_API virtual bool configInitWGLWindow( int pixelFormat );

        EQ_API virtual bool configInitWGLPBuffer( int pixelFormat );

        EQ_API virtual bool configInitWGLFBO( int pixelFormat );

        EQ_API virtual HGLRC createWGLContext();

        EQ_API virtual void destroyWGLContext( HGLRC context );

        EQ_API virtual void initEventHandler();

        EQ_API virtual void exitEventHandler();

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

        EQ_API virtual void swapBuffers();

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


        void leaveNVSwapBarrier();

        EQ_API virtual bool processEvent( const WindowEvent& event );

    protected:
        enum WGLDCType
        {
            WGL_DC_NONE,     
            WGL_DC_WINDOW,   
            WGL_DC_PBUFFER,  
            WGL_DC_AFFINITY, 
            WGL_DC_DISPLAY   
        };

        void setWGLDC( HDC dc, const WGLDCType type );

        EQ_API WGLEWContext* wglewGetContext();

        Pipe* getWGLPipe();

    private:

        HWND             _wglWindow;
        HPBUFFERARB      _wglPBuffer;
        HGLRC            _wglContext;

        HDC              _wglDC;
        WGLDCType        _wglDCType;
        HDC              _wglAffinityDC;

        EventHandler* _wglEventHandler;
        BOOL          _screenSaverActive;

        uint32_t         _wglNVSwapGroup;

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

        HWND _createWGLWindow( int pixelFormat, const PixelViewport& pvp );

        int _chooseWGLPixelFormatARB( HDC pfDC );

        int _chooseWGLPixelFormat( HDC pfDC );

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