Equalizer  2.0.0
Parallel Rendering Framework
eq::wgl::WindowIF Class Referenceabstract

The interface defining the minimum functionality for a WGL window. More...

#include <window.h>

+ Inheritance diagram for eq::wgl::WindowIF:
+ Collaboration diagram for eq::wgl::WindowIF:

Public Member Functions

 WindowIF (NotifierInterface &parent, const WindowSettings &settings)
 Construct a new WGL window for the given eq::Window. More...
 
virtual ~WindowIF ()
 Destruct the WGL window. More...
 
virtual EQ_API HGLRC getWGLContext () const =0
 
virtual EQ_API HWND getWGLWindowHandle () const =0
 
virtual EQ_API HPBUFFERARB getWGLPBufferHandle () const =0
 
virtual EQ_API HDC getWGLDC () const =0
 
virtual HDC getWGLAffinityDC ()
 
virtual bool processEvent (EventType type, SizeEvent &event)
 Process a (re)size event. More...
 
virtual bool processEvent (EventType type, PointerEvent &event)
 Process a mouse event. More...
 
virtual bool processEvent (EventType type, KeyEvent &event)
 Process a keyboard event. More...
 
virtual bool processEvent (EventType type, AxisEvent &event)
 Process an axis event. More...
 
virtual bool processEvent (EventType type, ButtonEvent &event)
 Process a button event. More...
 
virtual bool processEvent (EventType)
 Process a stateless event. More...
 
- Public Member Functions inherited from eq::GLWindow
EQ_API GLWindow (NotifierInterface &parent, const WindowSettings &settings)
 Construct a new OpenGL window. More...
 
virtual EQ_API ~GLWindow ()
 Destruct a new OpenGL window. More...
 
EQ_API void makeCurrent (const bool cache=true) const override
 Bind the FBO and update the current cache. More...
 
EQ_API void doneCurrent () const override
 Unbind the FBO and remove context from current cache. More...
 
EQ_API bool isCurrent () const
 
virtual EQ_API void initGLEW ()
 Initialize the GLEW context for this window. More...
 
virtual EQ_API void exitGLEW ()
 De-initialize the GLEW context. More...
 
EQ_API const GLEWContext * glewGetContext () const override
 Get the GLEW context for this window. More...
 
EQ_API void queryDrawableConfig (DrawableConfig &) override
 Set up the drawable config by querying the current context. More...
 
EQ_API void bindFrameBuffer () const override
 Bind the window's FBO, if it uses an FBO drawable. More...
 
EQ_API void bindDrawFrameBuffer () const override
 Bind the window's draw FBO, used for multisampling. More...
 
EQ_API void updateFrameBuffer () const override
 Update the window's FBO from the multisampled FBO. More...
 
EQ_API void flush () override
 Flush all command buffers. More...
 
EQ_API void finish () override
 Finish execution of all commands. More...
 
virtual EQ_API bool configInitFBO ()
 Build and initialize the FBO. More...
 
virtual EQ_API void configExitFBO ()
 Destroy the FBO. More...
 
EQ_API const util::FrameBufferObjectgetFrameBufferObject () const override
 
EQ_API util::FrameBufferObjectgetFrameBufferObject () override
 
- Public Member Functions inherited from eq::SystemWindow
EQ_API SystemWindow (NotifierInterface &parent, const WindowSettings &settings)
 Create a new SystemWindow for the given eq::Window. More...
 
virtual EQ_API ~SystemWindow ()
 Destroy the SystemWindow. More...
 
EQ_API EventOCommand sendError (const uint32_t error)
 Send a window error event to the application node. More...
 
EQ_API bool processEvent (EventType type)
 Process a stateless event. More...
 
EQ_API bool processEvent (EventType type, SizeEvent &event)
 Process a (re)size event. More...
 
EQ_API bool processEvent (EventType type, PointerEvent &event)
 Process a mouse event. More...
 
EQ_API bool processEvent (EventType type, KeyEvent &event)
 Process a keyboard event. More...
 
EQ_API bool processEvent (EventType type, AxisEvent &event)
 Process an axis event. More...
 
EQ_API bool processEvent (EventType type, ButtonEvent &event)
 Process a button event. More...
 
EQ_API void setPixelViewport (const PixelViewport &pvp)
 Set the window's pixel viewport wrt its parent pipe. More...
 
EQ_API const PixelViewport & getPixelViewport () const
 
EQ_API uint32_t getColorFormat () const
 
EQ_API void setName (const std::string &name)
 Set the window's name. More...
 
EQ_API const std::string & getName () const
 
EQ_API int32_t getIAttribute (const WindowSettings::IAttribute attr) const
 
EQ_API const SystemWindowgetSharedContextWindow () const
 
virtual EQ_API bool configInit ()=0
 Initialize this system window. More...
 
virtual EQ_API void configExit ()=0
 De-initialize this system window. More...
 
virtual EQ_API void swapBuffers ()=0
 Swap the front and back buffer. More...
 
virtual EQ_API void joinNVSwapBarrier (const uint32_t group, const uint32_t barrier)=0
 Join a NV_swap_group. More...
 

Detailed Description

The interface defining the minimum functionality for a WGL window.

Definition at line 33 of file wgl/window.h.

Constructor & Destructor Documentation

eq::wgl::WindowIF::WindowIF ( NotifierInterface parent,
const WindowSettings settings 
)
inline

Construct a new WGL window for the given eq::Window.

Version
1.7.2

Definition at line 37 of file wgl/window.h.

virtual eq::wgl::WindowIF::~WindowIF ( )
inlinevirtual

Destruct the WGL window.

Version
1.0

Definition at line 41 of file wgl/window.h.

Member Function Documentation

virtual HDC eq::wgl::WindowIF::getWGLAffinityDC ( )
inlinevirtual
Returns
the Win32 affinity device context, if used.
Version
1.0

Reimplemented in eq::wgl::Window.

Definition at line 59 of file wgl/window.h.

virtual EQ_API HGLRC eq::wgl::WindowIF::getWGLContext ( ) const
pure virtual
Returns
the WGL rendering context.
Version
1.0

Implemented in eq::wgl::Window.

virtual EQ_API HDC eq::wgl::WindowIF::getWGLDC ( ) const
pure virtual
Returns
the Win32 device context used for the current drawable.
Version
1.0

Implemented in eq::wgl::Window.

virtual EQ_API HPBUFFERARB eq::wgl::WindowIF::getWGLPBufferHandle ( ) const
pure virtual
Returns
the Win32 off screen PBuffer handle.
Version
1.0

Implemented in eq::wgl::Window.

virtual EQ_API HWND eq::wgl::WindowIF::getWGLWindowHandle ( ) const
pure virtual
Returns
the Win32 window handle.
Version
1.0

Implemented in eq::wgl::Window.

virtual bool eq::wgl::WindowIF::processEvent ( EventType  type,
SizeEvent &  event 
)
inlinevirtual

Process a (re)size event.

Returns
true if the event was handled.

Definition at line 62 of file wgl/window.h.

References eq::SystemWindow::processEvent().

+ Here is the call graph for this function:

virtual bool eq::wgl::WindowIF::processEvent ( EventType  type,
PointerEvent &  event 
)
inlinevirtual

Process a mouse event.

Returns
true if the event was handled.

Reimplemented in eq::wgl::Window.

Definition at line 66 of file wgl/window.h.

References eq::SystemWindow::processEvent().

+ Here is the call graph for this function:

virtual bool eq::wgl::WindowIF::processEvent ( EventType  type,
KeyEvent &  event 
)
inlinevirtual

Process a keyboard event.

Returns
true if the event was handled.

Definition at line 70 of file wgl/window.h.

References eq::SystemWindow::processEvent().

+ Here is the call graph for this function:

virtual bool eq::wgl::WindowIF::processEvent ( EventType  type,
AxisEvent &  event 
)
inlinevirtual

Process an axis event.

Returns
true if the event was handled.

Definition at line 74 of file wgl/window.h.

References eq::SystemWindow::processEvent().

+ Here is the call graph for this function:

virtual bool eq::wgl::WindowIF::processEvent ( EventType  type,
ButtonEvent &  event 
)
inlinevirtual

Process a button event.

Returns
true if the event was handled.

Definition at line 78 of file wgl/window.h.

References eq::SystemWindow::processEvent().

+ Here is the call graph for this function:

virtual bool eq::wgl::WindowIF::processEvent ( EventType  )
inlinevirtual

Process a stateless event.

Returns
true if the event was handled.

Reimplemented in eq::wgl::Window.

Definition at line 82 of file wgl/window.h.


The documentation for this class was generated from the following file: