OpenNI 1.5.7
Public Attributes | List of all members
XnModuleGeneralIntInterface Struct Reference

#include <XnModuleInterface.h>

Public Attributes

XnStatus(* GetRange )(XnModuleNodeHandle hGenerator, const XnChar *strCap, XnInt32 *pnMin, XnInt32 *pnMax, XnInt32 *pnStep, XnInt32 *pnDefault, XnBool *pbIsAutoSupported)
 
XnStatus(* Get )(XnModuleNodeHandle hGenerator, const XnChar *strCap, XnInt32 *pnValue)
 
XnStatus(* Set )(XnModuleNodeHandle hGenerator, const XnChar *strCap, XnInt32 nValue)
 
XnModuleNodeHandle hGenerator
 
XnModuleNodeHandle const XnChar * strCap
 
XnModuleNodeHandle const
XnChar
XnModuleStateChangedHandler 
handler
 
XnModuleNodeHandle const
XnChar
XnModuleStateChangedHandler
void * 
pCookie
 
XnModuleNodeHandle const
XnChar
XnModuleStateChangedHandler
void XnCallbackHandle
phCallback
 
XnModuleNodeHandle const
XnChar XnCallbackHandle 
hCallback
 

Member Data Documentation

XnStatus(* XnModuleGeneralIntInterface::Get)(XnModuleNodeHandle hGenerator, const XnChar *strCap, XnInt32 *pnValue)

Gets the current value of this capability

Parameters
hGenerator[in] A handle to the instance
strCap[in] Name of the capability
pnValue[out] Current value
XnStatus(* XnModuleGeneralIntInterface::GetRange)(XnModuleNodeHandle hGenerator, const XnChar *strCap, XnInt32 *pnMin, XnInt32 *pnMax, XnInt32 *pnStep, XnInt32 *pnDefault, XnBool *pbIsAutoSupported)

Gets the range of this capability values

Parameters
hGenerator[in] A handle to the instance
strCap[in] Name of the capability
pnMin[out] Minimum value
pnMax[out] Maximum value
pnStep[out] Step size
pnDefault[out] Default value
pbIsAutoSupported[out] TRUE if auto adjustment is supported, FALSE otherwise
XnModuleNodeHandle const XnChar XnModuleStateChangedHandler XnModuleGeneralIntInterface::handler
XnModuleNodeHandle const XnChar XnCallbackHandle XnModuleGeneralIntInterface::hCallback
XnModuleNodeHandle XnModuleGeneralIntInterface::hGenerator

Registers a callback function to values changes.

Parameters
hGenerator[in] A handle to the instance.
strCap[in] Name of the capability
handler[in] A pointer to a function that will be called when value changes.
pCookie[in] A user cookie that will be passed to the callback function.
phCallback[out] Optional. Will be filled with a handle to be passed to UnregisterFromValueChange().

Unregisters a callback function which was registered using RegisterToValueChange().

Parameters
hGenerator[in] A handle to the instance.
strCap[in] Name of the capability
hCallback[in] The handle to the callback returned from RegisterToValueChange().
XnModuleNodeHandle const XnChar XnModuleStateChangedHandler void* XnModuleGeneralIntInterface::pCookie
XnModuleNodeHandle const XnChar XnModuleStateChangedHandler void XnCallbackHandle* XnModuleGeneralIntInterface::phCallback
XnStatus(* XnModuleGeneralIntInterface::Set)(XnModuleNodeHandle hGenerator, const XnChar *strCap, XnInt32 nValue)

Sets the current value of this capability

Parameters
hGenerator[in] A handle to the instance
strCap[in] Name of the capability
nValue[in] Value to set
XnModuleNodeHandle const XnChar * XnModuleGeneralIntInterface::strCap

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