openni::VideoMode Class Reference

#include <OpenNI.h>

Inheritance diagram for openni::VideoMode:

List of all members.

Public Member Functions
int	getFps () const
PixelFormat	getPixelFormat () const
int	getResolutionX () const
int	getResolutionY () const
VideoMode &	operator= (const VideoMode &other)
void	setFps (int fps)
void	setPixelFormat (PixelFormat format)
void	setResolution (int resolutionX, int resolutionY)
	VideoMode ()
	VideoMode (const VideoMode &other)
Friends
class	SensorInfo
class	VideoFrameRef
class	VideoStream

---

Detailed Description

Encapsulates a group of settings for a VideoStream. Settings stored include frame rate, resolution, and pixel format.

This class is used as an input for changing the settings of a VideoStream, as well as an output for reporting the current settings of that class. It is also used by SensorInfo to report available video modes of a stream.

Recommended practice is to use SensorInfo::getSupportedVideoModes() to obtain a list of valid video modes, and then to use items from that list to pass new settings to VideoStream. This is much less likely to produce an invalid video mode than instantiating and manually changing objects of this class.

Definition at line 221 of file OpenNI.h.

---

Constructor & Destructor Documentation

openni::VideoMode::VideoMode

(

)

[inline]

Default constructor, creates an empty VideoMode object. Application programs should, in most cases, use the copy constructor to copy an existing valid video mode. This is much less error prone that creating and attempting to configure a new VideoMode from scratch.

Definition at line 229 of file OpenNI.h.

openni::VideoMode::VideoMode

(

const VideoMode &

other

)

[inline]

Copy constructor, creates a new VideoMode identical to an existing VideoMode.

Parameters:

[in]

other

Existing VideoMode to copy.

Definition at line 237 of file OpenNI.h.

---

Member Function Documentation

int openni::VideoMode::getFps

(

)

const [inline]

Getter function for the frame rate of this VideoMode.

Returns:

Current frame rate, measured in frames per second.

Definition at line 279 of file OpenNI.h.

PixelFormat openni::VideoMode::getPixelFormat

(

)

const [inline]

Getter function for the pixel format of this VideoMode.

Returns:

Current pixel format setting of this VideoMode.

Definition at line 261 of file OpenNI.h.

int openni::VideoMode::getResolutionX

(

)

const [inline]

Getter function for the X resolution of this VideoMode.

Returns:

Current horizontal resolution of this VideoMode, in pixels.

Definition at line 267 of file OpenNI.h.

int openni::VideoMode::getResolutionY

(

)

const [inline]

Getter function for the Y resolution of this VideoMode.

Returns:

Current vertical resolution of this VideoMode, in pixels.

Definition at line 273 of file OpenNI.h.

VideoMode& openni::VideoMode::operator=

(

const VideoMode &

other

)

[inline]

Assignment operator. Sets the pixel format, frame rate, and resolution of this VideoMode to equal that of a different VideoMode.

Parameters:

[in]

other

Existing VideoMode to copy settings from.

Definition at line 248 of file OpenNI.h.

void openni::VideoMode::setFps

(

int

fps

)

[inline]

Setter function for the frame rate. Application use of this function is not recommended. Instead, use SensorInfo::getSupportedVideoModes() to obtain a list of valid video modes.

Parameters:

[in]

fps

Desired new frame rate, measured in frames per second.

Definition at line 308 of file OpenNI.h.

void openni::VideoMode::setPixelFormat

(

PixelFormat

format

)

[inline]

Setter function for the pixel format of this VideoMode. Application use of this function is not recommended. Instead, use SensorInfo::getSupportedVideoModes() to obtain a list of valid video modes.

Parameters:

[in]

format

Desired new pixel format for this VideoMode.

Definition at line 287 of file OpenNI.h.

void openni::VideoMode::setResolution	(	int	resolutionX,
		int	resolutionY
	)		[inline]

Setter function for the resolution of this VideoMode. Application use of this function is not recommended. Instead, use SensorInfo::getSupportedVideoModes() to obtain a list of valid video modes.

Parameters:

[in]	resolutionX	Desired new horizontal resolution in pixels.
[in]	resolutionY	Desired new vertical resolution in pixels.

Definition at line 296 of file OpenNI.h.

---

Friends And Related Function Documentation

friend class SensorInfo [friend]

Definition at line 310 of file OpenNI.h.

friend class VideoFrameRef [friend]

Definition at line 312 of file OpenNI.h.

friend class VideoStream [friend]

Definition at line 311 of file OpenNI.h.

---

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

• OpenNI.h