Class wrapping OSVR_DisplayConfig objects, optionally managing shared ownership. More...

#include <osvr/ClientKit/Display.h>

Public Member Functions
	DisplayConfig ()
	Empty constructor - constructs a config where valid() is false.

	DisplayConfig (ClientContext &ctx)
	Retrieve a display config, owning it and managing its lifetime.

	DisplayConfig (UnderlyingDisplayConfigPtr const &ptr)
	Construct from a shared pointer to the underlying display config, taking shared ownership.

	DisplayConfig (OSVR_DisplayConfig disp)
	Construct from a (presumably-externally-managed) raw display config, not affecting lifetime.

bool	valid () const
	Checks the validity of the contained pointer.

bool	checkStartup () const
	Checks if the display is fully configured and ready, including first pose. More...

OSVR_DisplayInputCount	getNumDisplayInputs () const
	Returns number of inputs for this display. More...

osvr::clientkit::DisplayDimensions	getDisplayDimensions (OSVR_DisplayInputCount displayInputIndex) const
	Returns display dimensions for a display input. More...

Child-related methods
OSVR_ViewerCount	getNumViewers () const

Viewer	getViewer (OSVR_ViewerCount viewer) const

Eye	getEye (OSVR_ViewerCount viewer, OSVR_EyeCount eye) const

Surface	getSurface (OSVR_ViewerCount viewer, OSVR_EyeCount eye, OSVR_SurfaceCount surface) const

Iteration methods
template<typename F >
void	forEachViewer (F OSVR_CLIENTKIT_FUNCTOR_REF functor)

template<typename F >
void	forEachEye (F OSVR_CLIENTKIT_FUNCTOR_REF functor)

template<typename F >
void	forEachSurface (F OSVR_CLIENTKIT_FUNCTOR_REF functor)

Identification getters
}
OSVR_DisplayConfig	getDisplayConfig () const
	Gets the raw OSVR_DisplayConfig.

UnderlyingDisplayConfigPtr	getOwningPtr () const
	Gets a copy of the owning pointer, if we hold shared ownership over this DisplayConfig.

Related Functions
(Note that these are not member functions.)
bool	operator== (DisplayConfig const &lhs, DisplayConfig const &rhs)
	Equality operator for clientkit::DisplayConfig - does not consider the ownership status in the comparison. More...

bool	operator== (DisplayConfig const &lhs, OSVR_DisplayConfig rhs)
	Equality operator for clientkit::DisplayConfig. More...

bool	operator== (OSVR_DisplayConfig lhs, DisplayConfig const &rhs)
	Equality operator for clientkit::DisplayConfig. More...

bool	operator!= (DisplayConfig const &lhs, DisplayConfig const &rhs)
	Inequality operator for clientkit::DisplayConfig - does not consider the ownership status in the comparison. More...

bool	operator!= (DisplayConfig const &lhs, OSVR_DisplayConfig rhs)
	Inequality operator for clientkit::DisplayConfig. More...

bool	operator!= (OSVR_DisplayConfig lhs, DisplayConfig const &rhs)
	Inequality operator for clientkit::DisplayConfig. More...

Detailed Description

Class wrapping OSVR_DisplayConfig objects, optionally managing shared ownership.

Definition at line 409 of file Display.h.

Member Function Documentation

bool osvr::clientkit::DisplayConfig::checkStartup ( ) const

inline

Checks if the display is fully configured and ready, including first pose.

See also: osvrClientCheckDisplayStartup()

Definition at line 458 of file Display.h.

OSVR_DisplayInputCount osvr::clientkit::DisplayConfig::getNumDisplayInputs ( ) const

inline

Returns number of inputs for this display.

See also: osvrClientGetNumDisplayInputs()

Definition at line 466 of file Display.h.

osvr::clientkit::DisplayDimensions osvr::clientkit::DisplayConfig::getDisplayDimensions ( OSVR_DisplayInputCount displayInputIndex ) const

inline

Returns display dimensions for a display input.

See also: osvrClientGetDisplayDimensions()

Definition at line 479 of file Display.h.

template<typename F >

void osvr::clientkit::DisplayConfig::forEachViewer ( F OSVR_CLIENTKIT_FUNCTOR_REF functor )

inline

For each viewer...

Definition at line 524 of file Display.h.

template<typename F >

void osvr::clientkit::DisplayConfig::forEachEye ( F OSVR_CLIENTKIT_FUNCTOR_REF functor )

inline

For each viewer...

Definition at line 533 of file Display.h.

template<typename F >

void osvr::clientkit::DisplayConfig::forEachSurface ( F OSVR_CLIENTKIT_FUNCTOR_REF functor )

inline

For each viewer...

Definition at line 542 of file Display.h.

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

osvr/ClientKit/Display.h

Public Member Functions

Related Functions

Detailed Description

Member Function Documentation