openni::VideoMode类 参考

#include <OpenNI.h>

继承自 OniVideoMode .

Public 成员函数
	VideoMode ()
	VideoMode (const VideoMode &other)
VideoMode &	operator= (const VideoMode &other)
PixelFormat	getPixelFormat () const
int	getResolutionX () const
int	getResolutionY () const
int	getFps () const
void	setPixelFormat (PixelFormat format)
void	setResolution (int resolutionX, int resolutionY)
void	setFps (int fps)

友元
class	SensorInfo
class	VideoStream
class	VideoFrameRef

详细描述

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.

构造及析构函数说明

VideoMode() [1/2]

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.

VideoMode() [2/2]

openni::VideoMode::VideoMode ( const VideoMode &  other )

inline

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

参数

[in]

other

Existing VideoMode to copy.

成员函数说明

getFps()

int openni::VideoMode::getFps ( ) const

inline

Getter function for the frame rate of this VideoMode.

返回

Current frame rate, measured in frames per second.

getPixelFormat()

PixelFormat openni::VideoMode::getPixelFormat ( ) const

inline

Getter function for the pixel format of this VideoMode.

返回

Current pixel format setting of this VideoMode.

getResolutionX()

int openni::VideoMode::getResolutionX ( ) const

inline

Getter function for the X resolution of this VideoMode.

返回

Current horizontal resolution of this VideoMode, in pixels.

getResolutionY()

int openni::VideoMode::getResolutionY ( ) const

inline

Getter function for the Y resolution of this VideoMode.

返回

Current vertical resolution of this VideoMode, in pixels.

operator=()

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.

参数

[in]

other

Existing VideoMode to copy settings from.

setFps()

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.

参数

[in]

fps

Desired new frame rate, measured in frames per second.

setPixelFormat()

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.

参数

[in]

format

Desired new pixel format for this VideoMode.

setResolution()

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.

参数

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

---

该类的文档由以下文件生成:

• D:/16、基础SDK/OpenNI2SDK/doc-new/OpenNI2.3-SDK Doc/zh/Include/OpenNI.h