Equalizer  1.13.0
Parallel Rendering Framework
eq::fabric::WindowSettings Class Reference

A set of settings to setup an eq::fabric::Window. More...

#include <windowSettings.h>

+ Inheritance diagram for eq::fabric::WindowSettings:
+ Collaboration diagram for eq::fabric::WindowSettings:

Public Types

enum  IAttribute {
  IATTR_HINT_CORE_PROFILE, IATTR_HINT_OPENGL_MAJOR, IATTR_HINT_OPENGL_MINOR, IATTR_HINT_STEREO,
  IATTR_HINT_DOUBLEBUFFER, IATTR_HINT_FULLSCREEN, IATTR_HINT_DECORATION, IATTR_HINT_SWAPSYNC,
  IATTR_HINT_DRAWABLE, IATTR_HINT_STATISTICS, IATTR_HINT_SCREENSAVER, IATTR_HINT_GRAB_POINTER,
  IATTR_HINT_WIDTH, IATTR_HINT_HEIGHT, IATTR_PLANES_COLOR, IATTR_PLANES_ALPHA,
  IATTR_PLANES_DEPTH, IATTR_PLANES_STENCIL, IATTR_PLANES_ACCUM, IATTR_PLANES_ACCUM_ALPHA,
  IATTR_PLANES_SAMPLES, IATTR_LAST, IATTR_ALL = IATTR_LAST
}
 Window attributes. More...
 

Public Member Functions

EQFABRIC_API WindowSettings ()
 Create a new WindowSettings. More...
 
virtual EQFABRIC_API ~WindowSettings ()
 Destroy the WindowSettings. More...
 
EQFABRIC_API WindowSettings (const WindowSettings &rhs)
 
EQFABRIC_API WindowSettingsoperator= (const WindowSettings &rhs)
 
EQFABRIC_API bool setIAttribute (const IAttribute attr, const int32_t value)
 Set a window attribute. More...
 
EQFABRIC_API int32_t getIAttribute (const IAttribute attr) const
 
EQFABRIC_API const PixelViewportgetPixelViewport () const
 
EQFABRIC_API void setPixelViewport (const PixelViewport &pvp)
 Set the window's pixel viewport wrt its parent pipe. More...
 
EQFABRIC_API const std::string & getName () const
 
EQFABRIC_API void setName (const std::string &name)
 Set the window's name. More...
 
EQFABRIC_API void serialize (co::DataOStream &os) const
 
EQFABRIC_API void deserialize (co::DataIStream &is)
 

Detailed Description

A set of settings to setup an eq::fabric::Window.

Definition at line 32 of file fabric/windowSettings.h.

Member Enumeration Documentation

Window attributes.

Most of these attributes are used by the SystemWindow implementation to configure the window during configInit(). A SystemWindow implementation might not respect all attributes, e.g., IATTR_HINT_SWAPSYNC is not implemented by the GLXWindow. Please refer to the Programming Guide for details.

Version
1.0
Enumerator
IATTR_HINT_CORE_PROFILE 

Core profile context if possible.

IATTR_HINT_OPENGL_MAJOR 

Major version for GL context creation.

IATTR_HINT_OPENGL_MINOR 

Minor version for GL context creation.

IATTR_HINT_STEREO 

Active stereo.

IATTR_HINT_DOUBLEBUFFER 

Front and back buffer.

IATTR_HINT_FULLSCREEN 

Fullscreen drawable.

IATTR_HINT_DECORATION 

Window decorations.

IATTR_HINT_SWAPSYNC 

Swap sync on vertical retrace.

IATTR_HINT_DRAWABLE 

Window, pbuffer, FBO or OFF.

IATTR_HINT_STATISTICS 

Statistics gathering hint.

IATTR_HINT_SCREENSAVER 

Screensaver (de)activation (WGL)

IATTR_HINT_GRAB_POINTER 

Capture mouse outside window.

IATTR_HINT_WIDTH 

Default horizontal resolution.

IATTR_HINT_HEIGHT 

Default vertical resolution.

IATTR_PLANES_COLOR 

No of per-component color planes.

IATTR_PLANES_ALPHA 

No of alpha planes.

IATTR_PLANES_DEPTH 

No of z-buffer planes.

IATTR_PLANES_STENCIL 

No of stencil planes.

IATTR_PLANES_ACCUM 

No of accumulation buffer planes.

IATTR_PLANES_ACCUM_ALPHA 

No of alpha accum buffer planes.

IATTR_PLANES_SAMPLES 

No of multisample (AA) planes.

Definition at line 56 of file fabric/windowSettings.h.

Constructor & Destructor Documentation

EQFABRIC_API eq::fabric::WindowSettings::WindowSettings ( )

Create a new WindowSettings.

Version
1.7.2
virtual EQFABRIC_API eq::fabric::WindowSettings::~WindowSettings ( )
virtual

Destroy the WindowSettings.

Version
1.7.2

Reimplemented in eq::WindowSettings.

Member Function Documentation

EQFABRIC_API int32_t eq::fabric::WindowSettings::getIAttribute ( const IAttribute  attr) const
Returns
the value of a window attribute.
Version
1.7.2
EQFABRIC_API const std::string& eq::fabric::WindowSettings::getName ( ) const
Returns
the window's name.
Version
1.7.2
EQFABRIC_API const PixelViewport& eq::fabric::WindowSettings::getPixelViewport ( ) const
Returns
the window's pixel viewport wrt the parent pipe.
Version
1.7.2
EQFABRIC_API bool eq::fabric::WindowSettings::setIAttribute ( const IAttribute  attr,
const int32_t  value 
)

Set a window attribute.

Returns
true if the attribute was changed, false otherwise.
Version
1.7.2
EQFABRIC_API void eq::fabric::WindowSettings::setName ( const std::string &  name)

Set the window's name.

Version
1.7.2
EQFABRIC_API void eq::fabric::WindowSettings::setPixelViewport ( const PixelViewport pvp)

Set the window's pixel viewport wrt its parent pipe.

Parameters
pvpthe viewport in pixels.
Version
1.7.2

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