xn::MapMetaData Class Reference

#include <XnCppWrapper.h>

Inheritance diagram for xn::MapMetaData:

List of all members.

Public Member Functions
	MapMetaData (XnPixelFormat format, const XnUInt8 **ppData)
XnUInt32	XRes () const
XnUInt32 &	XRes ()
XnUInt32	YRes () const
XnUInt32 &	YRes ()
XnUInt32	XOffset () const
XnUInt32 &	XOffset ()
XnUInt32	YOffset () const
XnUInt32 &	YOffset ()
XnUInt32	FullXRes () const
XnUInt32 &	FullXRes ()
XnUInt32	FullYRes () const
XnUInt32 &	FullYRes ()
XnUInt32	FPS () const
XnUInt32 &	FPS ()
XnPixelFormat	PixelFormat () const
const XnMapMetaData *	GetUnderlying () const
XnMapMetaData *	GetUnderlying ()
XnUInt32	BytesPerPixel () const
XnStatus	AllocateData (XnUInt32 nXRes, XnUInt32 nYRes)
XnStatus	ReAdjust (XnUInt32 nXRes, XnUInt32 nYRes, const XnUInt8 *pExternalBuffer)
Protected Member Functions
XnPixelFormat &	PixelFormatImpl ()

---

Detailed Description

Represents a MetaData object for generators producing pixel-map-based outputs

---

Constructor & Destructor Documentation

xn::MapMetaData::MapMetaData	(	XnPixelFormat	format,
		const XnUInt8 **	ppData
	)		[inline]

Ctor. Meant to be used by inheriting classes.

Parameters:

format	[in] Pixel Format
ppData	[in] A pointer to the data member of the meta data object

---

Member Function Documentation

XnStatus xn::MapMetaData::AllocateData	(	XnUInt32	nXRes,
		XnUInt32	nYRes
	)		[inline]

Allocated a writable buffer. If a previous buffer was allocated it will be freed (or reused if possible). Also see Meta Data Objects.

Parameters:

nXRes	[in] The number of required columns in the map.
nYRes	[in] The number of required rows in the map.

XnUInt32 xn::MapMetaData::BytesPerPixel

(

)

const [inline]

Gets the number of bytes each pixel occupies.

XnUInt32 xn::MapMetaData::FPS

(

)

const [inline]

Gets the FPS in which frame was generated.

XnUInt32& xn::MapMetaData::FPS

(

)

[inline]

Gets the FPS in which frame was generated.

XnUInt32 xn::MapMetaData::FullXRes

(

)

const [inline]

Gets the number of columns in the full frame (entire field-of-view, ignoring cropping).

XnUInt32& xn::MapMetaData::FullXRes

(

)

[inline]

Gets the number of columns in the full frame (entire field-of-view, ignoring cropping).

XnUInt32 xn::MapMetaData::FullYRes

(

)

const [inline]

Gets the number of rows in the full frame (entire field-of-view, ignoring cropping).

XnUInt32& xn::MapMetaData::FullYRes

(

)

[inline]

Gets the number of rows in the full frame (entire field-of-view, ignoring cropping).

const XnMapMetaData* xn::MapMetaData::GetUnderlying

(

)

const [inline]

Gets the C object that is wrapped by this object.

Reimplemented from xn::OutputMetaData.

Reimplemented in xn::SceneMetaData, xn::IRMetaData, xn::ImageMetaData, and xn::DepthMetaData.

XnMapMetaData* xn::MapMetaData::GetUnderlying

(

)

[inline]

Gets the C object that is wrapped by this object.

Reimplemented from xn::OutputMetaData.

Reimplemented in xn::SceneMetaData, xn::IRMetaData, xn::ImageMetaData, and xn::DepthMetaData.

XnPixelFormat xn::MapMetaData::PixelFormat

(

)

const [inline]

Gets the pixel format of the pixel-map.

Reimplemented in xn::ImageMetaData.

XnPixelFormat& xn::MapMetaData::PixelFormatImpl

(

)

[inline, protected]

XnStatus xn::MapMetaData::ReAdjust	(	XnUInt32	nXRes,
		XnUInt32	nYRes,
		const XnUInt8 *	pExternalBuffer
	)		[inline]

Changes dimensions of the pixel-map.

Parameters:

nXRes	[in] Number of columns in the map
nYRes	[in] Number of rows in the map
pExternalBuffer	[in] Optional. An external buffer to be used. If NULL is passed, a buffer will be allocated.

XnUInt32 xn::MapMetaData::XOffset

(

)

const [inline]

Gets the offset, in columns, of the buffer within the field of view (0 if cropping is off).

XnUInt32& xn::MapMetaData::XOffset

(

)

[inline]

Gets the offset, in columns, of the buffer within the field of view (0 if cropping is off).

XnUInt32 xn::MapMetaData::XRes

(

)

const [inline]

Gets the actual number of columns in the frame (after cropping)

XnUInt32& xn::MapMetaData::XRes

(

)

[inline]

Gets the actual number of columns in the frame (after cropping)

XnUInt32 xn::MapMetaData::YOffset

(

)

const [inline]

Gets the offset, in rows, of the buffer within the field of view (0 if cropping is off).

XnUInt32& xn::MapMetaData::YOffset

(

)

[inline]

Gets the offset, in rows, of the buffer within the field of view (0 if cropping is off).

XnUInt32 xn::MapMetaData::YRes

(

)

const [inline]

Gets the actual number of rows in the frame (after cropping)

XnUInt32& xn::MapMetaData::YRes

(

)

[inline]

Gets the actual number of rows in the frame (after cropping)

---

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

• XnCppWrapper.h