xn::ImageGenerator Class Reference

#include <XnCppWrapper.h>

Inheritance diagram for xn::ImageGenerator:

List of all members.

Public Member Functions
const XnGrayscale16Pixel *	GetGrayscale16ImageMap () const
const XnGrayscale8Pixel *	GetGrayscale8ImageMap () const
const XnUInt8 *	GetImageMap () const
void	GetMetaData (ImageMetaData &metaData) const
XnPixelFormat	GetPixelFormat () const
const XnRGB24Pixel *	GetRGB24ImageMap () const
const XnYUV422DoublePixel *	GetYUV422ImageMap () const
	ImageGenerator (XnNodeHandle hNode=NULL)
XnBool	IsPixelFormatSupported (XnPixelFormat Format) const
XnStatus	RegisterToPixelFormatChange (StateChangedHandler handler, void *pCookie, XnCallbackHandle &hCallback)
XnStatus	SetPixelFormat (XnPixelFormat Format)
void	UnregisterFromPixelFormatChange (XnCallbackHandle hCallback)
XnStatus	Create (Context &context, Query *pQuery=NULL, EnumerationErrors *pErrors=NULL)

---

Detailed Description

Represents an image generator

Definition at line 2562 of file XnCppWrapper.h.

---

Constructor & Destructor Documentation

xn::ImageGenerator::ImageGenerator

(

XnNodeHandle

hNode = NULL

)

[inline]

Ctor

Parameters:

hNode

[in] Node handle

Definition at line 2570 of file XnCppWrapper.h.

---

Member Function Documentation

XnStatus xn::ImageGenerator::Create	(	Context &	context,
		Query *	pQuery = NULL,
		EnumerationErrors *	pErrors = NULL
	)		[inline]

Creates an image generator.

For full details and usage, see xnCreateImageGenerator

Definition at line 4579 of file XnCppWrapper.h.

const XnGrayscale16Pixel* xn::ImageGenerator::GetGrayscale16ImageMap

(

)

const [inline]

Gets the current Grayscale16 image-map. This map is updated after a call to xnWaitAndUpdateData(). It is assumed that the node is currently in Grayscale16 pixel format.

For full details and usage, see xnGetGrayscale16ImageMap

Definition at line 2612 of file XnCppWrapper.h.

const XnGrayscale8Pixel* xn::ImageGenerator::GetGrayscale8ImageMap

(

)

const [inline]

Gets the current Grayscale8 image-map. This map is updated after a call to xnWaitAndUpdateData(). It is assumed that the node is currently in Grayscale8 pixel format.

For full details and usage, see xnGetGrayscale8ImageMap

Definition at line 2604 of file XnCppWrapper.h.

const XnUInt8* xn::ImageGenerator::GetImageMap

(

)

const [inline]

Gets the current image-map as a byte buffer.

For full details, see xnGetImageMap().

Definition at line 2620 of file XnCppWrapper.h.

void xn::ImageGenerator::GetMetaData

(

ImageMetaData &

metaData

)

const [inline]

Gets the current image-map meta data.

For full details and usage, see xnGetImageMetaData

Definition at line 2580 of file XnCppWrapper.h.

XnPixelFormat xn::ImageGenerator::GetPixelFormat

(

)

const [inline]

Gets current pixel format.

For full details and usage, see xnGetPixelFormat

Definition at line 2644 of file XnCppWrapper.h.

const XnRGB24Pixel* xn::ImageGenerator::GetRGB24ImageMap

(

)

const [inline]

Gets the current RGB24 image-map. This map is updated after a call to xnWaitAndUpdateData(). It is assumed that the node is currently in RGB24 pixel format.

For full details and usage, see xnGetRGB24ImageMap

Definition at line 2588 of file XnCppWrapper.h.

const XnYUV422DoublePixel* xn::ImageGenerator::GetYUV422ImageMap

(

)

const [inline]

Gets the current YUV422 image-map. This map is updated after a call to xnWaitAndUpdateData(). It is assumed that the node is currently in YUV422 pixel format.

For full details and usage, see xnGetYUV422ImageMap

Definition at line 2596 of file XnCppWrapper.h.

XnBool xn::ImageGenerator::IsPixelFormatSupported

(

XnPixelFormat

Format

)

const [inline]

Checks if a specific pixel format is supported.

For full details and usage, see xnIsPixelFormatSupported

Definition at line 2628 of file XnCppWrapper.h.

XnStatus xn::ImageGenerator::RegisterToPixelFormatChange	(	StateChangedHandler	handler,
		void *	pCookie,
		XnCallbackHandle &	hCallback
	)		[inline]

Registers a callback function to pixel format changes.

For full details and usage, see xnRegisterToPixelFormatChange

Definition at line 2652 of file XnCppWrapper.h.

XnStatus xn::ImageGenerator::SetPixelFormat

(

XnPixelFormat

Format

)

[inline]

Sets the pixel format of the image map.

For full details and usage, see xnSetPixelFormat

Definition at line 2636 of file XnCppWrapper.h.

void xn::ImageGenerator::UnregisterFromPixelFormatChange

(

XnCallbackHandle

hCallback

)

[inline]

Unregisters a callback function which was registered using xnRegisterToPixelFormatChange.

For full details and usage, see xnUnregisterFromPixelFormatChange

Definition at line 2660 of file XnCppWrapper.h.

---

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

• XnCppWrapper.h