|
XN_C_API XnStatus XN_C_DECL | xnAutoEnumerateOverSingleInput (XnContext *pContext, XnNodeInfoList *pList, XnProductionNodeDescription *pDescription, const XnChar *strCreationInfo, XnProductionNodeType InputType, XnEnumerationErrors *pErrors, XnNodeQuery *pQuery) |
|
XN_C_API XnStatus XN_C_DECL | xnRegisterExtensionNode (const XnChar *strTypeName, XnProductionNodeType baseType, XnProductionNodeType *pTypeID) |
|
XN_C_API XnModuleNodeHandle XN_C_DECL | xnGetModuleNodeHandle (XnNodeHandle hNode) |
|
XN_C_API XnStatus XN_C_DECL | xnRegisterModuleWithOpenNI (XnOpenNIModuleInterface *pInterface, const XnChar *strConfigDir, const XnChar *strName) |
|
This page details some utility functions.
◆ xnAllocateAudioMetaData()
◆ xnAllocateDepthMetaData()
◆ xnAllocateImageMetaData()
◆ xnAllocateIRMetaData()
Allocates and returns an XnIRMetaData object. When no longer needed, this object should be freed by calling xnFreeIRMetaData().
- Returns
- NULL if allocation failed.
◆ xnAllocateMapMetaData()
Allocates and returns an XnMapMetaData object. When no longer needed, this object should be freed by calling xnFreeMapMetaData().
- Returns
- NULL if allocation failed.
◆ xnAllocateOutputMetaData()
◆ xnAllocateSceneMetaData()
◆ xnAutoEnumerateOverSingleInput()
A helper function for production nodes implementers. Enumerates needed child nodes (assuming there is only one needed input), and populates a list with production trees over that input.
- Parameters
-
pContext | [in] OpenNI Context. |
pList | [in] The list to be populated. |
pDescription | [in] The description of the enumerated node. |
strCreationInfo | [in] [Optional] Additional creation info. |
InputType | [in] The type of the input required by this production node. |
pErrors | [in] The errors object passed to Enumerate method. |
pQuery | [in] [Optional] A filter to be used for finding the appropriate input. |
◆ xnCopyAudioMetaData()
Shallow-Copies an Audio Meta Data object. Note that the data buffer is not copied, and that both object will point to the same buffer.
- Parameters
-
pDestination | [in] Destination object. |
pSource | [in] Source object. |
◆ xnCopyDepthMetaData()
Shallow-Copies a Depth Meta Data object. Note that the data buffer is not copied, and that both object will point to the same buffer.
- Parameters
-
pDestination | [in] Destination object. |
pSource | [in] Source object. |
◆ xnCopyImageMetaData()
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
-
pDestination | [in] Destination object. |
pSource | [in] Source object. |
◆ xnCopyIRMetaData()
Shallow-Copies an IR Meta Data object. Note that the data buffer is not copied, and that both object will point to the same buffer.
- Parameters
-
pDestination | [in] Destination object. |
pSource | [in] Source object. |
◆ xnCopyMapMetaData()
Shallow-Copies a Map Meta Data object.
- Parameters
-
pDestination | [in] Destination object. |
pSource | [in] Source object. |
◆ xnCopyOutputMetaData()
Shallow-Copies an Output Meta Data object.
- Parameters
-
pDestination | [in] Destination object. |
pSource | [in] Source object. |
◆ xnCopySceneMetaData()
Shallow-Copies a Scene Meta Data object. Note that the data buffer is not copied, and that both object will point to the same buffer.
- Parameters
-
pDestination | [in] Destination object. |
pSource | [in] Source object. |
◆ xnCreatePlane3D()
◆ xnCreatePoint3D()
◆ xnFreeAudioMetaData()
Frees a previously allocated XnAudioMetaData object.
- Parameters
-
pMetaData | [in] object to be freed. |
◆ xnFreeDepthMetaData()
Frees a previously allocated XnDepthMetaData object.
- Parameters
-
pMetaData | [in] object to be freed. |
◆ xnFreeImageMetaData()
Frees a previously allocated XnImageMetaData object.
- Parameters
-
pMetaData | [in] object to be freed. |
◆ xnFreeIRMetaData()
Frees a previously allocated XnIRMetaData object.
- Parameters
-
pMetaData | [in] object to be freed. |
◆ xnFreeMapMetaData()
Frees a previously allocated XnMapMetaData object.
- Parameters
-
pMetaData | [in] object to be freed. |
◆ xnFreeOutputMetaData()
Frees a previously allocated XnOutputMetaData object.
- Parameters
-
pMetaData | [in] object to be freed. |
◆ xnFreeSceneMetaData()
Frees a previously allocated XnSceneMetaData object.
- Parameters
-
pMetaData | [in] object to be freed. |
◆ xnGetBytesPerPixelForPixelFormat()
Gets the bytes per pixel of a pixel format.
- Parameters
-
format | [in] The pixel format. |
◆ xnGetModuleNodeHandle()
Gets the module node handle of a node. This is useful for extension implementors.
- Parameters
-
hNode | [in] The node to get its module node handle. |
◆ xnGetVersion()
Gets current OpenNI version
- Parameters
-
pVersion | [out] Current DLL version |
◆ xnIsTypeDerivedFrom()
Checks if a certain production node type is a derived of another type.
- Parameters
-
type | [in] The type to check |
base | [in] The base type to check against |
◆ xnIsTypeGenerator()
Checks if a certain production node type is a generator or not.
- Parameters
-
type | [in] The type to check |
◆ xnPixelFormatFromString()
Gets pixel format by its name.
- Parameters
-
strName | [in] Name of the pixel format. |
pFormat | [out] Pixel format. |
◆ xnPixelFormatToString()
Get the name of the pixel format.
- Parameters
-
◆ xnPrintRegisteredLicenses()
◆ xnPrintRegisteredModules()
◆ xnProductionNodeDescriptionToString()
◆ xnProductionNodeTypeFromString()
Gets a type from its string representation.
- Parameters
-
strType | [in] The string representation of the type. |
pType | [out] The type of the production node. |
◆ xnProductionNodeTypeToString()
Gets a string representation of the production node type.
- Parameters
-
Type | [in] The type of the production node. |
◆ xnRegisterExtensionNode()
Registers an extension node with OpenNI. An extension node is a node of type not defined by OpenNI.
- Parameters
-
strTypeName | [in] Name of this new node type. |
baseType | [in] Type of the direct base for this extension. |
pTypeID | [out] The new ID registered with OpenNI. |
◆ xnRegisterGlobalLicense()
◆ xnRegisterModule()
XN_C_API XnStatus XN_C_DECL xnRegisterModule |
( |
const XnChar * | strModule, |
|
|
const XnChar * | strConfigDir ) |
◆ xnRegisterModuleWithOpenNI()
Registers a module to OpenNI in environments where dynamic library loading is not supported.
- Parameters
-
pInterface | [in] The module interface. |
strConfigDir | [in] The module configuration directory. |
strName | [in] Name of this module. |
◆ xnResolutionGetFromName()
Gets resolution by its name. If resolution is unknown, XN_RESOLUTION_CUSTOM is returned.
- Parameters
-
strName | [in] Name of the resolution. |
◆ xnResolutionGetFromXYRes()
Gets the resolution from the number of pixels in every row and column.
- Parameters
-
xRes | [in] Number of pixels in a row. |
yRes | [in] Number of pixels in a column. |
◆ xnResolutionGetName()
Get the name of the resolution.
- Parameters
-
resolution | [in] Resolution. |
◆ xnResolutionGetXRes()
Gets the number of pixels in a row for given resolution.
- Parameters
-
resolution | [in] The resolution to translate. |
◆ xnResolutionGetYRes()
Gets the number of pixels in a column for given resolution.
- Parameters
-
resolution | [in] The resolution to translate. |
◆ xnUnregisterGlobalLicense()
◆ xnUnregisterModule()
◆ xnVersionCompare()
Compares two versions.
- Parameters
-
pVersion1 | [in] First version. |
pVersion2 | [in] Second version. |
- Returns
- <0 if first is smaller than second, 0 if same, >0 if first is greater than second.
◆ xnVersionToString()