OpenNI 1.3.2
Public Member Functions | List of all members
xn::ImageGenerator Class Reference

#include <XnCppWrapper.h>

Inheritance diagram for xn::ImageGenerator:
Inheritance graph

Public Member Functions

 ImageGenerator (XnNodeHandle hNode=NULL)
 ImageGenerator (const NodeWrapper &other)
void GetMetaData (ImageMetaData &metaData) const
const XnRGB24PixelGetRGB24ImageMap () const
const XnYUV422DoublePixelGetYUV422ImageMap () const
const XnGrayscale8PixelGetGrayscale8ImageMap () const
const XnGrayscale16PixelGetGrayscale16ImageMap () const
const XnUInt8 * GetImageMap () const
XnBool IsPixelFormatSupported (XnPixelFormat Format) const
XnStatus SetPixelFormat (XnPixelFormat Format)
XnPixelFormat GetPixelFormat () const
XnStatus RegisterToPixelFormatChange (StateChangedHandler handler, void *pCookie, XnCallbackHandle &hCallback)
void UnregisterFromPixelFormatChange (XnCallbackHandle hCallback)
XnStatus Create (Context &context, Query *pQuery=NULL, EnumerationErrors *pErrors=NULL)
- Public Member Functions inherited from xn::MapGenerator
 MapGenerator (XnNodeHandle hNode=NULL)
 MapGenerator (const NodeWrapper &other)
XnUInt32 GetSupportedMapOutputModesCount () const
XnStatus GetSupportedMapOutputModes (XnMapOutputMode *aModes, XnUInt32 &nCount) const
XnStatus SetMapOutputMode (const XnMapOutputMode &OutputMode)
XnStatus GetMapOutputMode (XnMapOutputMode &OutputMode) const
XnUInt32 GetBytesPerPixel () const
XnStatus RegisterToMapOutputModeChange (StateChangedHandler handler, void *pCookie, XnCallbackHandle &hCallback)
void UnregisterFromMapOutputModeChange (XnCallbackHandle hCallback)
const CroppingCapability GetCroppingCap () const
CroppingCapability GetCroppingCap ()
GeneralIntCapability GetBrightnessCap ()
GeneralIntCapability GetContrastCap ()
GeneralIntCapability GetHueCap ()
GeneralIntCapability GetSaturationCap ()
GeneralIntCapability GetSharpnessCap ()
GeneralIntCapability GetGammaCap ()
GeneralIntCapability GetWhiteBalanceCap ()
GeneralIntCapability GetBacklightCompensationCap ()
GeneralIntCapability GetGainCap ()
GeneralIntCapability GetPanCap ()
GeneralIntCapability GetTiltCap ()
GeneralIntCapability GetRollCap ()
GeneralIntCapability GetZoomCap ()
GeneralIntCapability GetExposureCap ()
GeneralIntCapability GetIrisCap ()
GeneralIntCapability GetFocusCap ()
GeneralIntCapability GetLowLightCompensationCap ()
AntiFlickerCapability GetAntiFlickerCap ()
- Public Member Functions inherited from xn::Generator
 Generator (XnNodeHandle hNode=NULL)
 Generator (const NodeWrapper &other)
XnStatus StartGenerating ()
XnBool IsGenerating () const
XnStatus StopGenerating ()
XnStatus RegisterToGenerationRunningChange (StateChangedHandler handler, void *pCookie, XnCallbackHandle &hCallback)
void UnregisterFromGenerationRunningChange (XnCallbackHandle hCallback)
XnStatus RegisterToNewDataAvailable (StateChangedHandler handler, void *pCookie, XnCallbackHandle &hCallback)
void UnregisterFromNewDataAvailable (XnCallbackHandle hCallback)
XnBool IsNewDataAvailable (XnUInt64 *pnTimestamp=NULL) const
XnStatus WaitAndUpdateData ()
XnBool IsDataNew () const
const void * GetData ()
XnUInt32 GetDataSize () const
XnUInt64 GetTimestamp () const
XnUInt32 GetFrameID () const
const MirrorCapability GetMirrorCap () const
MirrorCapability GetMirrorCap ()
const
AlternativeViewPointCapability 
GetAlternativeViewPointCap () const
AlternativeViewPointCapability GetAlternativeViewPointCap ()
const FrameSyncCapability GetFrameSyncCap () const
FrameSyncCapability GetFrameSyncCap ()
- Public Member Functions inherited from xn::ProductionNode
 ProductionNode (XnNodeHandle hNode=NULL)
 ProductionNode (const NodeWrapper &other)
NodeInfo GetInfo () const
XnStatus AddNeededNode (ProductionNode &needed)
XnStatus RemoveNeededNode (ProductionNode &needed)
XnBool IsCapabilitySupported (const XnChar *strCapabilityName) const
XnStatus SetIntProperty (const XnChar *strName, XnUInt64 nValue)
XnStatus SetRealProperty (const XnChar *strName, XnDouble dValue)
XnStatus SetStringProperty (const XnChar *strName, const XnChar *strValue)
XnStatus SetGeneralProperty (const XnChar *strName, XnUInt32 nBufferSize, const void *pBuffer)
XnStatus GetIntProperty (const XnChar *strName, XnUInt64 &nValue) const
XnStatus GetRealProperty (const XnChar *strName, XnDouble &dValue) const
XnStatus GetStringProperty (const XnChar *strName, XnChar *csValue, XnUInt32 nBufSize) const
XnStatus GetGeneralProperty (const XnChar *strName, XnUInt32 nBufferSize, void *pBuffer) const
XnStatus LockForChanges (XnLockHandle *phLock)
void UnlockForChanges (XnLockHandle hLock)
XnStatus LockedNodeStartChanges (XnLockHandle hLock)
void LockedNodeEndChanges (XnLockHandle hLock)
const ErrorStateCapability GetErrorStateCap () const
ErrorStateCapability GetErrorStateCap ()
GeneralIntCapability GetGeneralIntCap (const XnChar *strCapability)
void GetContext (Context &context) const
- Public Member Functions inherited from xn::NodeWrapper
 NodeWrapper (XnNodeHandle hNode)
 NodeWrapper (const NodeWrapper &other)
NodeWrapperoperator= (const NodeWrapper &other)
 ~NodeWrapper ()
 operator XnNodeHandle () const
XnNodeHandle GetHandle () const
XnBool operator== (const NodeWrapper &other)
XnBool operator!= (const NodeWrapper &other)
XnBool IsValid () const
const XnChar * GetName () const
XnStatus AddRef ()
void Release ()
XnStatus Ref ()
void Unref ()
void SetHandle (XnNodeHandle hNode)
void TakeOwnership (XnNodeHandle hNode)

Detailed Description

Represents an image generator

Constructor & Destructor Documentation

xn::ImageGenerator::ImageGenerator ( XnNodeHandle  hNode = NULL)
inline

Ctor

Parameters
hNode[in] Node handle
xn::ImageGenerator::ImageGenerator ( const NodeWrapper other)
inline

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

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

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

const XnUInt8* xn::ImageGenerator::GetImageMap ( ) const
inline

Gets the current image-map as a byte buffer. For full details, see xnGetImageMap().

void xn::ImageGenerator::GetMetaData ( ImageMetaData metaData) const
inline

Gets the current image-map meta data. For full details and usage, see xnGetImageMetaData

XnPixelFormat xn::ImageGenerator::GetPixelFormat ( ) const
inline

Gets current pixel format. For full details and usage, see xnGetPixelFormat

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

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

XnBool xn::ImageGenerator::IsPixelFormatSupported ( XnPixelFormat  Format) const
inline

Checks if a specific pixel format is supported. For full details and usage, see xnIsPixelFormatSupported

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

XnStatus xn::ImageGenerator::SetPixelFormat ( XnPixelFormat  Format)
inline

Sets the pixel format of the image map. For full details and usage, see xnSetPixelFormat

void xn::ImageGenerator::UnregisterFromPixelFormatChange ( XnCallbackHandle  hCallback)
inline

Unregisters a callback function which was registered using xnRegisterToPixelFormatChange. For full details and usage, see xnUnregisterFromPixelFormatChange


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