OpenNI 1.5.4: General Int Capability

OpenNI

General Int Capability

Functions

XN_C_API XnStatus XN_C_DECL xnGetGeneralIntRange (XnNodeHandle hNode, const XnChar *strCap, XnInt32 *pnMin, XnInt32 *pnMax, XnInt32 *pnStep, XnInt32 *pnDefault, XnBool *pbIsAutoSupported)
XN_C_API XnStatus XN_C_DECL xnGetGeneralIntValue (XnNodeHandle hNode, const XnChar *strCap, XnInt32 *pnValue)
XN_C_API XnStatus XN_C_DECL xnSetGeneralIntValue (XnNodeHandle hNode, const XnChar *strCap, XnInt32 nValue)
XN_C_API XnStatus XN_C_DECL xnRegisterToGeneralIntValueChange (XnNodeHandle hNode, const XnChar *strCap, XnStateChangedHandler handler, void *pCookie, XnCallbackHandle *phCallback)
XN_C_API void XN_C_DECL xnUnregisterFromGeneralIntValueChange (XnNodeHandle hNode, const XnChar *strCap, XnCallbackHandle hCallback)

Detailed Description

The General Int Capability is a set of method that is used by several capabilities. It allows a general range value to be changed. If supported by the node, the value can also be set to XN_AUTO_CONTROL for automatic adjustment.

The capabilities supporting this interface are:


Function Documentation

XN_C_API XnStatus XN_C_DECL xnGetGeneralIntRange ( XnNodeHandle  hNode,
const XnChar *  strCap,
XnInt32 *  pnMin,
XnInt32 *  pnMax,
XnInt32 *  pnStep,
XnInt32 *  pnDefault,
XnBool *  pbIsAutoSupported 
)

Gets the range of this capability values.

Parameters:
hNode[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
XN_C_API XnStatus XN_C_DECL xnGetGeneralIntValue ( XnNodeHandle  hNode,
const XnChar *  strCap,
XnInt32 *  pnValue 
)

Gets the current value of this capability.

Parameters:
hNode[in] A handle to the instance
strCap[in] Name of the capability
pnValue[out] Current value
XN_C_API XnStatus XN_C_DECL xnRegisterToGeneralIntValueChange ( XnNodeHandle  hNode,
const XnChar *  strCap,
XnStateChangedHandler  handler,
void *  pCookie,
XnCallbackHandle phCallback 
)

Registers a callback function to values changes.

Parameters:
hNode[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 xnUnregisterFromGeneralIntValueChange().
XN_C_API XnStatus XN_C_DECL xnSetGeneralIntValue ( XnNodeHandle  hNode,
const XnChar *  strCap,
XnInt32  nValue 
)

Sets the current value of this capability.

Parameters:
hNode[in] A handle to the instance
strCap[in] Name of the capability
nValue[in] Value to set
XN_C_API void XN_C_DECL xnUnregisterFromGeneralIntValueChange ( XnNodeHandle  hNode,
const XnChar *  strCap,
XnCallbackHandle  hCallback 
)

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

Parameters:
hNode[in] A handle to the instance.
strCap[in] Name of the capability
hCallback[in] The handle to the callback returned from xnRegisterToGeneralIntValueChange().
Generated on Wed May 16 2012 10:16:06 for OpenNI 1.5.4 by   doxygen 1.7.5.1