xn::ImageMetaData Class Reference
[C++ Reference]

#include <XnCppWrapper.h>

Inheritance diagram for xn::ImageMetaData:
[legend]

List of all members.

Public Member Functions

 ImageMetaData ()
void InitFrom (const ImageMetaData &other)
XnStatus InitFrom (const ImageMetaData &other, XnUInt32 nXRes, XnUInt32 nYRes, XnPixelFormat format, const XnUInt8 *pExternalBuffer)
XnStatus AllocateData (XnUInt32 nXRes, XnUInt32 nYRes, XnPixelFormat format)
XnStatus CopyFrom (const ImageMetaData &other)
XnStatus ReAdjust (XnUInt32 nXRes, XnUInt32 nYRes, XnPixelFormat format, const XnUInt8 *pExternalBuffer=NULL)
XnPixelFormat PixelFormat () const
XnPixelFormatPixelFormat ()
XnUInt8 * WritableData ()
const XnRGB24PixelRGB24Data () const
const XnRGB24Pixel *& RGB24Data ()
XnRGB24PixelWritableRGB24Data ()
const XnYUV422DoublePixelYUV422Data () const
const XnYUV422DoublePixel *& YUV422Data ()
XnYUV422DoublePixelWritableYUV422Data ()
const XnGrayscale8PixelGrayscale8Data () const
const XnGrayscale8Pixel *& Grayscale8Data ()
XnGrayscale8PixelWritableGrayscale8Data ()
const XnGrayscale16PixelGrayscale16Data () const
const XnGrayscale16Pixel *& Grayscale16Data ()
XnGrayscale16PixelWritableGrayscale16Data ()
const xn::ImageMap & ImageMap () const
xn::ImageMap & WritableImageMap ()
const xn::RGB24Map & RGB24Map () const
xn::RGB24Map & WritableRGB24Map ()
const xn::Grayscale8Map & Grayscale8Map () const
xn::Grayscale8Map & WritableGrayscale8Map ()
const xn::Grayscale16Map & Grayscale16Map () const
xn::Grayscale16Map & WritableGrayscale16Map ()
const XnImageMetaDataGetUnderlying () const
XnImageMetaDataGetUnderlying ()

Detailed Description

Represents a MetaData object for generators producing image-maps.


Constructor & Destructor Documentation

xn::ImageMetaData::ImageMetaData (  )  [inline]

Ctor.


Member Function Documentation

XnStatus xn::ImageMetaData::AllocateData ( XnUInt32  nXRes,
XnUInt32  nYRes,
XnPixelFormat  format 
) [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] Requested number of columns in the map
nYRes [in] Requested number of rows in the map
format [in] Requested pixel format
XnStatus xn::ImageMetaData::CopyFrom ( const ImageMetaData other  )  [inline]

Performs a deep-copy of another Meta Data object (including a duplication of the data buffer)

Parameters:
other [in] source object

XnImageMetaData* xn::ImageMetaData::GetUnderlying (  )  [inline]

Gets the C object that is wrapped by this object.

Reimplemented from xn::MapMetaData.

const XnImageMetaData* xn::ImageMetaData::GetUnderlying (  )  const [inline]

Gets the C object that is wrapped by this object.

Reimplemented from xn::MapMetaData.

const XnGrayscale16Pixel*& xn::ImageMetaData::Grayscale16Data (  )  [inline]

Gets a pointer to the data.

const XnGrayscale16Pixel* xn::ImageMetaData::Grayscale16Data (  )  const [inline]

Gets a pointer to the data.

const xn::Grayscale16Map& xn::ImageMetaData::Grayscale16Map (  )  const [inline]

Gets a light object wrapping the image-map.

const XnGrayscale8Pixel*& xn::ImageMetaData::Grayscale8Data (  )  [inline]

Gets a pointer to the data.

const XnGrayscale8Pixel* xn::ImageMetaData::Grayscale8Data (  )  const [inline]

Gets a pointer to the data.

const xn::Grayscale8Map& xn::ImageMetaData::Grayscale8Map (  )  const [inline]

Gets a light object wrapping the image-map.

const xn::ImageMap& xn::ImageMetaData::ImageMap (  )  const [inline]

Gets a light object wrapping the image-map.

XnStatus xn::ImageMetaData::InitFrom ( const ImageMetaData other,
XnUInt32  nXRes,
XnUInt32  nYRes,
XnPixelFormat  format,
const XnUInt8 *  pExternalBuffer 
) [inline]

Shallow copies another Image Meta Data object, and then ReAdjust it.

Parameters:
other [in] source object
nXRes [in] requested number of columns in the map
nYRes [in] requested number of rows in the map
format [in] requested pixel format
pExternalBuffer [in] Optional. An external buffer matching requested resolution. If NULL, A buffer will be allocated.
void xn::ImageMetaData::InitFrom ( const ImageMetaData other  )  [inline]

Shallow-Copies an Image Meta Data object. Note that the data buffer is not copied, and that both object will point to the same buffer.

Parameters:
other [in] source object.
XnPixelFormat& xn::ImageMetaData::PixelFormat (  )  [inline]

Gets the pixel format.

XnPixelFormat xn::ImageMetaData::PixelFormat (  )  const [inline]

Gets the pixel format.

Reimplemented from xn::MapMetaData.

XnStatus xn::ImageMetaData::ReAdjust ( XnUInt32  nXRes,
XnUInt32  nYRes,
XnPixelFormat  format,
const XnUInt8 *  pExternalBuffer = NULL 
) [inline]

Parameters:
nXRes [in] Requested number of columns in the map
nYRes [in] Requested number of rows in the map
format [in] Requested pixel format
pExternalBuffer [in] Optional. An external buffer to be used. If NULL is passed, a buffer will be allocated.
const XnRGB24Pixel*& xn::ImageMetaData::RGB24Data (  )  [inline]

Gets a pointer to the data.

const XnRGB24Pixel* xn::ImageMetaData::RGB24Data (  )  const [inline]

Gets a pointer to the data.

const xn::RGB24Map& xn::ImageMetaData::RGB24Map (  )  const [inline]

Gets a light object wrapping the image-map.

XnUInt8* xn::ImageMetaData::WritableData (  )  [inline]

Gets a pointer to the writable buffer (see Meta Data Objects).

Reimplemented from xn::OutputMetaData.

XnGrayscale16Pixel* xn::ImageMetaData::WritableGrayscale16Data (  )  [inline]

Gets a pointer to the writable buffer (see Meta Data Objects).

xn::Grayscale16Map& xn::ImageMetaData::WritableGrayscale16Map (  )  [inline]

Gets a light object wrapping the writable image-map.

XnGrayscale8Pixel* xn::ImageMetaData::WritableGrayscale8Data (  )  [inline]

Gets a pointer to the writable buffer (see Meta Data Objects).

xn::Grayscale8Map& xn::ImageMetaData::WritableGrayscale8Map (  )  [inline]

Gets a light object wrapping the writable image-map.

xn::ImageMap& xn::ImageMetaData::WritableImageMap (  )  [inline]

Gets a light object wrapping the writable image-map.

XnRGB24Pixel* xn::ImageMetaData::WritableRGB24Data (  )  [inline]

Gets a pointer to the writable buffer (see Meta Data Objects).

xn::RGB24Map& xn::ImageMetaData::WritableRGB24Map (  )  [inline]

Gets a light object wrapping the writable image-map.

XnYUV422DoublePixel* xn::ImageMetaData::WritableYUV422Data (  )  [inline]

Gets a pointer to the writable buffer (see Meta Data Objects).

const XnYUV422DoublePixel*& xn::ImageMetaData::YUV422Data (  )  [inline]

Gets a pointer to the data.

const XnYUV422DoublePixel* xn::ImageMetaData::YUV422Data (  )  const [inline]

Gets a pointer to the data.


The documentation for this class was generated from the following file:
Generated on Fri Nov 9 22:59:09 2012 for OpenNI 1.3.2 by  doxygen 1.6.3