Public Member Functions | Friends | List of all members
openni::VideoMode Class Reference

#include <OpenNI.h>

Inheritance diagram for openni::VideoMode:
Inheritance graph
[legend]

Public Member Functions

int getFps () const
 
PixelFormat getPixelFormat () const
 
int getResolutionX () const
 
int getResolutionY () const
 
VideoModeoperator= (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
 

Additional Inherited Members

- Private Attributes inherited from OniVideoMode
int fps
 
OniPixelFormat pixelFormat
 
int resolutionX
 
int resolutionY
 

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 203 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 211 of file OpenNI.h.

openni::VideoMode::VideoMode ( const VideoMode other)
inline

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

Parameters
[in]otherExisting VideoMode to copy.

Definition at line 219 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 261 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 243 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 249 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 255 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]otherExisting VideoMode to copy settings from.

Definition at line 230 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]fpsDesired new frame rate, measured in frames per second.

Definition at line 290 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]formatDesired new pixel format for this VideoMode.

Definition at line 269 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]resolutionXDesired new horizontal resolution in pixels.
[in]resolutionYDesired new vertical resolution in pixels.

Definition at line 278 of file OpenNI.h.

Friends And Related Function Documentation

friend class SensorInfo
friend

Definition at line 292 of file OpenNI.h.

friend class VideoFrameRef
friend

Definition at line 294 of file OpenNI.h.

friend class VideoStream
friend

Definition at line 293 of file OpenNI.h.


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


libfreenect
Author(s): Hector Martin, Josh Blake, Kyle Machulis, OpenKinect community
autogenerated on Thu Jun 6 2019 19:25:39