Wrapper for a viewer, eye, and surface bound to a display config. DOES NOT provide lifetime management for the associated display config! More...

#include <osvr/ClientKit/Display.h>

Public Member Functions
	Surface (OSVR_DisplayConfig disp, OSVR_ViewerCount viewer, OSVR_EyeCount eye, OSVR_SurfaceCount surface)

RelativeViewport	getRelativeViewport () const
	Gets the video-input-relative viewport corresponding to this surface. More...

void	getProjectionMatrix (double near, double far, OSVR_MatrixConventions flags, double matrix[OSVR_MATRIX_SIZE]) const
	Gets the projection matrix. More...

void	getProjectionMatrix (float near, float far, OSVR_MatrixConventions flags, float matrix[OSVR_MATRIX_SIZE]) const

ProjectionClippingPlanes	getProjectionClippingPlanes () const
	Gets the clipping planes. More...

bool	isDistortionRequested () const
	Determines if the description of the surface requests any distortion to be performed. More...

OSVR_DistortionPriority	getRadialDistortionPriority ()
	Get the priority/availability of radial distortion parameters for this surface. Negative values (canonically, OSVR_DISTORTION_PRIORITY_UNAVAILABLE) indicate that this distortion strategy is not available/parameterized for the surface in question. Larger values indicate more highly-preferred distortion strategies. More...

OSVR_RadialDistortionParameters	getRadialDistortion ()
	Get the radial distortion parameters. More...

Identification getters
OSVR_DisplayConfig	getDisplayConfig () const

OSVR_ViewerCount	getViewerID () const

OSVR_EyeCount	getEyeID () const

OSVR_SurfaceCount	getSurfaceID () const

Related Functions
(Note that these are not member functions.)
bool	operator== (Surface const &lhs, Surface const &rhs)
	Equality operator for clientkit::Surface. More...

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

Detailed Description

Wrapper for a viewer, eye, and surface bound to a display config. DOES NOT provide lifetime management for the associated display config!

Definition at line 117 of file Display.h.

Member Function Documentation

RelativeViewport osvr::clientkit::Surface::getRelativeViewport ( ) const

inline

Gets the video-input-relative viewport corresponding to this surface.

See also: osvrClientGetRelativeViewportForViewerEyeSurface()

Definition at line 127 of file Display.h.

void osvr::clientkit::Surface::getProjectionMatrix	(	double	near,
		double	far,
		OSVR_MatrixConventions	flags,
		double	matrix[OSVR_MATRIX_SIZE]
	)		const

inline

Gets the projection matrix.

See also: osvrClientGetViewerEyeSurfaceProjectionMatrixd

Definition at line 143 of file Display.h.

void osvr::clientkit::Surface::getProjectionMatrix	(	float	near,
		float	far,
		OSVR_MatrixConventions	flags,
		float	matrix[OSVR_MATRIX_SIZE]
	)		const

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 157 of file Display.h.

ProjectionClippingPlanes osvr::clientkit::Surface::getProjectionClippingPlanes ( ) const

inline

Gets the clipping planes.

See also: osvrClientGetViewerEyeSurfaceProjectionClippingPlanes

Definition at line 173 of file Display.h.

bool osvr::clientkit::Surface::isDistortionRequested ( ) const

inline

Determines if the description of the surface requests any distortion to be performed.

See also: osvrClientDoesViewerEyeSurfaceWantDistortion()

Definition at line 190 of file Display.h.

OSVR_DistortionPriority osvr::clientkit::Surface::getRadialDistortionPriority ( )

inline

Get the priority/availability of radial distortion parameters for this surface. Negative values (canonically, OSVR_DISTORTION_PRIORITY_UNAVAILABLE) indicate that this distortion strategy is not available/parameterized for the surface in question. Larger values indicate more highly-preferred distortion strategies.

See also: osvrClientGetViewerEyeSurfaceRadialDistortionPriority()

Definition at line 208 of file Display.h.

OSVR_RadialDistortionParameters osvr::clientkit::Surface::getRadialDistortion ( )

inline

Get the radial distortion parameters.

Will only succeed if getRadialDistortionPriority() is non-negative.

See also: osvrClientGetViewerEyeSurfaceRadialDistortionPriority()

Definition at line 222 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