window.h

Go to the documentation of this file.

/* Copyright (c) 2005-2015, Stefan Eilemann <eile@equalizergraphics.com>
 *                          Cedric Stalder <cedric.stalder@gmail.com>
 *                          Daniel Nachbaur <danielnachbaur@gmail.com>
 *
 * 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_WINDOW_H
#define EQ_WINDOW_H

#include <eq/types.h>
#include <eq/notifierInterface.h> // base class
#include <eq/windowSettings.h>    // template param
#include <eq/visitorResult.h>     // enum

#include <eq/fabric/renderContext.h>     // member
#include <eq/fabric/window.h>            // base class
#include <eq/util/bitmapFont.h>          // member
#include <eq/util/objectManager.h>       // member


namespace eq
{
class Window : public fabric::Window< Pipe, Window, Channel, WindowSettings >,
               public NotifierInterface
{
public:
    EQ_API explicit Window( Pipe* parent );

    EQ_API virtual ~Window();

    EQ_API co::CommandQueue* getPipeThreadQueue(); 
    EQ_API co::CommandQueue* getCommandThreadQueue(); 
    EQ_API uint32_t getCurrentFrame() const; 

    EQ_API const Node* getNode() const;

    EQ_API Node*       getNode();

    EQ_API const Config* getConfig() const;

    EQ_API Config*       getConfig();

    EQ_API ClientPtr getClient();

    EQ_API ServerPtr getServer();

    bool isRunning() const { return (_state == STATE_RUNNING); }

    bool isStopped() const { return (_state == STATE_STOPPED); }

    EQ_API bool getRenderContext( const int32_t x, const int32_t y,
                                  RenderContext& context ) const;

    EQ_API void setSharedContextWindow( const Window* sharedContextWindow );

    EQ_API const Window* getSharedContextWindow() const;

    util::ObjectManager& getObjectManager() { return _objectManager; }

    const util::ObjectManager& getObjectManager() const
        { return _objectManager; }

    EQ_API const util::BitmapFont* getSmallFont();

    EQ_API const util::BitmapFont* getMediumFont();

    EQ_API const GLEWContext* glewGetContext() const;

    EQ_API const GLEWContext* getTransferGlewContext() const;

    EQ_API uint32_t getColorFormat() const;

    EQ_API virtual void flush() const;

    EQ_API virtual void finish() const;

    EQ_API virtual void swapBuffers();

    EQ_API virtual void drawFPS();

    float getFPS() const { return _avgFPS; }

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

    EQ_API virtual void doneCurrent() const;

    EQ_API virtual void bindFrameBuffer() const;

    EQ_API virtual void bindDrawFrameBuffer() const;

    EQ_API virtual void updateFrameBuffer() const;

    EQ_API virtual void notifyViewportChanged();

    EQ_API void setSystemWindow( SystemWindow* window );

    const SystemWindow* getSystemWindow() const { return _systemWindow; }

    SystemWindow* getSystemWindow() { return _systemWindow; }

    const SystemPipe* getSystemPipe() const;

    SystemPipe* getSystemPipe();

    bool createTransferWindow();

    void deleteTransferWindow();

    SystemWindow* getTransferWindow();
    const SystemWindow* getTransferWindow() const; 


    EQ_API EventOCommand sendError( const uint32_t error ) final;

    EQ_API virtual bool processEvent( const Event& event );

protected:
    friend class Pipe;

    EQ_API virtual void attach( const uint128_t& id, const uint32_t instanceID );

    EQ_API void startFrame( const uint32_t frameNumber );

    EQ_API void releaseFrame( const uint32_t frameNumber );

    EQ_API void releaseFrameLocal( const uint32_t frameNumber );

    EQ_API virtual bool configInit( const uint128_t& initID );

    EQ_API virtual bool configInitSystemWindow( const uint128_t& initID );

    EQ_API virtual bool configInitGL( const uint128_t& initID );

    EQ_API virtual bool configExit();

    EQ_API virtual bool configExitSystemWindow();

    virtual bool configExitGL() { return true; }

    EQ_API virtual void frameStart( const uint128_t& frameID,
                                    const uint32_t frameNumber );

    EQ_API virtual void frameFinish( const uint128_t& frameID,
                                     const uint32_t frameNumber );

    EQ_API virtual void frameDrawFinish( const uint128_t& frameID,
                                         const uint32_t frameNumber );

private:
    enum State
    {
        STATE_STOPPED,
        STATE_INITIALIZING,
        STATE_RUNNING,
        STATE_FAILED
    };

    const Window* _sharedContextWindow;

    SystemWindow* _transferWindow;

    SystemWindow* _systemWindow;

    State _state;

    util::ObjectManager _objectManager;

    float _lastTime;

    float _avgFPS;

    std::vector< RenderContext > _renderContexts[2];
    enum
    {
        FRONT = 0,
        BACK  = 1
    };

    int64_t _lastSwapTime;

    Channels _grabbedChannels;

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

    void _addRenderContext( const RenderContext& context );
    friend class Channel;

    Channels _getEventChannels( const PointerEvent& event );

    void _setupObjectManager();
    void _releaseObjectManager();

    void _updateFPS();

    void _enterBarrier( co::ObjectVersion barrier );

    void _updateEvent( Event& event );

    /* The command functions. */
    bool _cmdCreateChannel( co::ICommand& command );
    bool _cmdDestroyChannel(co::ICommand& command );
    bool _cmdConfigInit( co::ICommand& command );
    bool _cmdConfigExit( co::ICommand& command );
    bool _cmdFrameStart( co::ICommand& command );
    bool _cmdFrameFinish( co::ICommand& command );
    bool _cmdThrottleFramerate( co::ICommand& command );
    bool _cmdFlush( co::ICommand& command );
    bool _cmdFinish( co::ICommand& command );
    bool _cmdBarrier( co::ICommand& command );
    bool _cmdNVBarrier( co::ICommand& command );
    bool _cmdSwap( co::ICommand& command );
    bool _cmdFrameDrawFinish( co::ICommand& command );

    LB_TS_VAR( _pipeThread )
};
}

#endif // EQ_WINDOW_H