![]() |
OpenNI 1.5.4
|
General | |
XN_C_API XnStatus XN_C_DECL | xnGetVersion (XnVersion *pVersion) |
ProductionNodeType Utils | |
XN_C_API const XnChar *XN_C_DECL | xnProductionNodeTypeToString (XnProductionNodeType Type) |
XN_C_API XnStatus XN_C_DECL | xnProductionNodeTypeFromString (const XnChar *strType, XnProductionNodeType *pType) |
XN_C_API XnBool XN_C_DECL | xnIsTypeGenerator (XnProductionNodeType type) |
XN_C_API XnBool XN_C_DECL | xnIsTypeDerivedFrom (XnProductionNodeType type, XnProductionNodeType base) |
PixelFormat Utils | |
XN_C_API const XnChar *XN_C_DECL | xnPixelFormatToString (XnPixelFormat format) |
XN_C_API XnStatus XN_C_DECL | xnPixelFormatFromString (const XnChar *strName, XnPixelFormat *pFormat) |
XN_C_API XnUInt32 XN_C_DECL | xnGetBytesPerPixelForPixelFormat (XnPixelFormat format) |
Resolution Utilities | |
XN_C_API XnUInt32 XN_C_DECL | xnResolutionGetXRes (XnResolution resolution) |
XN_C_API XnUInt32 XN_C_DECL | xnResolutionGetYRes (XnResolution resolution) |
XN_C_API XnResolution XN_C_DECL | xnResolutionGetFromXYRes (XnUInt32 xRes, XnUInt32 yRes) |
XN_C_API XnResolution XN_C_DECL | xnResolutionGetFromName (const XnChar *strName) |
XN_C_API const XnChar *XN_C_DECL | xnResolutionGetName (XnResolution resolution) |
XnVersion Utilities | |
XN_C_API XnInt32 XN_C_DECL | xnVersionCompare (const XnVersion *pVersion1, const XnVersion *pVersion2) |
XN_C_API XnStatus XN_C_DECL | xnVersionToString (const XnVersion *pVersion, XnChar *csResult, XnUInt32 nSize) |
XnProductionNodeDescription Utilities | |
XN_C_API XnStatus XN_C_DECL | xnProductionNodeDescriptionToString (const XnProductionNodeDescription *pDescription, XnChar *csResult, XnUInt32 nSize) |
C Style Constructors | |
XN_C_API XnPoint3D XN_C_DECL | xnCreatePoint3D (XnFloat x, XnFloat y, XnFloat z) |
XN_C_API XnPlane3D XN_C_DECL | xnCreatePlane3D (XnPoint3D ptPoint, XnVector3D vNormal) |
Modules Registry Management | |
XN_C_API XnStatus XN_C_DECL | xnRegisterModule (const XnChar *strModule, const XnChar *strConfigDir) |
XN_C_API XnStatus XN_C_DECL | xnUnregisterModule (const XnChar *strModule) |
XN_C_API XnStatus XN_C_DECL | xnPrintRegisteredModules () |
Global Licenses Registry Management | |
XN_C_API XnStatus XN_C_DECL | xnRegisterGlobalLicense (XnLicense *pLicense) |
XN_C_API XnStatus XN_C_DECL | xnUnregisterGlobalLicense (XnLicense *pLicense) |
XN_C_API XnStatus XN_C_DECL | xnPrintRegisteredLicenses () |
Functions for Modules Implementors | |
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.
XN_C_API XnAudioMetaData* XN_C_DECL xnAllocateAudioMetaData | ( | ) |
Allocates and returns an XnAudioMetaData object. When no longer needed, this object should be freed by calling xnFreeAudioMetaData().
XN_C_API XnDepthMetaData* XN_C_DECL xnAllocateDepthMetaData | ( | ) |
Allocates and returns an XnDepthMetaData object. When no longer needed, this object should be freed by calling xnFreeDepthMetaData().
XN_C_API XnImageMetaData* XN_C_DECL xnAllocateImageMetaData | ( | ) |
Allocates and returns an XnImageMetaData object. When no longer needed, this object should be freed by calling xnFreeImageMetaData().
XN_C_API XnIRMetaData* XN_C_DECL xnAllocateIRMetaData | ( | ) |
Allocates and returns an XnIRMetaData object. When no longer needed, this object should be freed by calling xnFreeIRMetaData().
XN_C_API XnMapMetaData* XN_C_DECL xnAllocateMapMetaData | ( | ) |
Allocates and returns an XnMapMetaData object. When no longer needed, this object should be freed by calling xnFreeMapMetaData().
XN_C_API XnOutputMetaData* XN_C_DECL xnAllocateOutputMetaData | ( | ) |
Allocates and returns an XnOutputMetaData object. When no longer needed, this object should be freed by calling xnFreeOutputMetaData().
XN_C_API XnSceneMetaData* XN_C_DECL xnAllocateSceneMetaData | ( | ) |
Allocates and returns an XnSceneMetaData object. When no longer needed, this object should be freed by calling xnFreeSceneMetaData().
XN_C_API XnStatus XN_C_DECL xnAutoEnumerateOverSingleInput | ( | XnContext * | pContext, |
XnNodeInfoList * | pList, | ||
XnProductionNodeDescription * | pDescription, | ||
const XnChar * | strCreationInfo, | ||
XnProductionNodeType | InputType, | ||
XnEnumerationErrors * | pErrors, | ||
XnNodeQuery * | pQuery | ||
) |
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.
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. |
XN_C_API XnStatus XN_C_DECL xnCopyAudioMetaData | ( | XnAudioMetaData * | pDestination, |
const XnAudioMetaData * | pSource | ||
) |
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.
pDestination | [in] Destination object. |
pSource | [in] Source object. |
XN_C_API XnStatus XN_C_DECL xnCopyDepthMetaData | ( | XnDepthMetaData * | pDestination, |
const XnDepthMetaData * | pSource | ||
) |
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.
pDestination | [in] Destination object. |
pSource | [in] Source object. |
XN_C_API XnStatus XN_C_DECL xnCopyImageMetaData | ( | XnImageMetaData * | pDestination, |
const XnImageMetaData * | pSource | ||
) |
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.
pDestination | [in] Destination object. |
pSource | [in] Source object. |
XN_C_API XnStatus XN_C_DECL xnCopyIRMetaData | ( | XnIRMetaData * | pDestination, |
const XnIRMetaData * | pSource | ||
) |
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.
pDestination | [in] Destination object. |
pSource | [in] Source object. |
XN_C_API XnStatus XN_C_DECL xnCopyMapMetaData | ( | XnMapMetaData * | pDestination, |
const XnMapMetaData * | pSource | ||
) |
Shallow-Copies a Map Meta Data object.
pDestination | [in] Destination object. |
pSource | [in] Source object. |
XN_C_API XnStatus XN_C_DECL xnCopyOutputMetaData | ( | XnOutputMetaData * | pDestination, |
const XnOutputMetaData * | pSource | ||
) |
Shallow-Copies an Output Meta Data object.
pDestination | [in] Destination object. |
pSource | [in] Source object. |
XN_C_API XnStatus XN_C_DECL xnCopySceneMetaData | ( | XnSceneMetaData * | pDestination, |
const XnSceneMetaData * | pSource | ||
) |
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.
pDestination | [in] Destination object. |
pSource | [in] Source object. |
XN_C_API XnPlane3D XN_C_DECL xnCreatePlane3D | ( | XnPoint3D | ptPoint, |
XnVector3D | vNormal | ||
) |
XN_C_API void XN_C_DECL xnFreeAudioMetaData | ( | const XnAudioMetaData * | pMetaData | ) |
Frees a previously allocated XnAudioMetaData object.
pMetaData | [in] object to be freed. |
XN_C_API void XN_C_DECL xnFreeDepthMetaData | ( | const XnDepthMetaData * | pMetaData | ) |
Frees a previously allocated XnDepthMetaData object.
pMetaData | [in] object to be freed. |
XN_C_API void XN_C_DECL xnFreeImageMetaData | ( | const XnImageMetaData * | pMetaData | ) |
Frees a previously allocated XnImageMetaData object.
pMetaData | [in] object to be freed. |
XN_C_API void XN_C_DECL xnFreeIRMetaData | ( | const XnIRMetaData * | pMetaData | ) |
Frees a previously allocated XnIRMetaData object.
pMetaData | [in] object to be freed. |
XN_C_API void XN_C_DECL xnFreeMapMetaData | ( | const XnMapMetaData * | pMetaData | ) |
Frees a previously allocated XnMapMetaData object.
pMetaData | [in] object to be freed. |
XN_C_API void XN_C_DECL xnFreeOutputMetaData | ( | const XnOutputMetaData * | pMetaData | ) |
Frees a previously allocated XnOutputMetaData object.
pMetaData | [in] object to be freed. |
XN_C_API void XN_C_DECL xnFreeSceneMetaData | ( | const XnSceneMetaData * | pMetaData | ) |
Frees a previously allocated XnSceneMetaData object.
pMetaData | [in] object to be freed. |
XN_C_API XnUInt32 XN_C_DECL xnGetBytesPerPixelForPixelFormat | ( | XnPixelFormat | format | ) |
Gets the bytes per pixel of a pixel format.
format | [in] The pixel format. |
XN_C_API XnModuleNodeHandle XN_C_DECL xnGetModuleNodeHandle | ( | XnNodeHandle | hNode | ) |
Gets the module node handle of a node. This is useful for extension implementors.
hNode | [in] The node to get its module node handle. |
Gets current OpenNI version
pVersion | [out] Current DLL version |
XN_C_API XnBool XN_C_DECL xnIsTypeDerivedFrom | ( | XnProductionNodeType | type, |
XnProductionNodeType | base | ||
) |
Checks if a certain production node type is a derived of another type.
type | [in] The type to check |
base | [in] The base type to check against |
XN_C_API XnBool XN_C_DECL xnIsTypeGenerator | ( | XnProductionNodeType | type | ) |
Checks if a certain production node type is a generator or not.
type | [in] The type to check |
XN_C_API XnStatus XN_C_DECL xnPixelFormatFromString | ( | const XnChar * | strName, |
XnPixelFormat * | pFormat | ||
) |
Gets pixel format by its name.
strName | [in] Name of the pixel format. |
pFormat | [out] Pixel format. |
XN_C_API const XnChar* XN_C_DECL xnPixelFormatToString | ( | XnPixelFormat | format | ) |
Get the name of the pixel format.
format | [in] Pixel Format |
XN_C_API XnStatus XN_C_DECL xnProductionNodeDescriptionToString | ( | const XnProductionNodeDescription * | pDescription, |
XnChar * | csResult, | ||
XnUInt32 | nSize | ||
) |
XN_C_API XnStatus XN_C_DECL xnProductionNodeTypeFromString | ( | const XnChar * | strType, |
XnProductionNodeType * | pType | ||
) |
Gets a type from its string representation.
strType | [in] The string representation of the type. |
pType | [out] The type of the production node. |
XN_C_API const XnChar* XN_C_DECL xnProductionNodeTypeToString | ( | XnProductionNodeType | Type | ) |
Gets a string representation of the production node type.
Type | [in] The type of the production node. |
XN_C_API XnStatus XN_C_DECL xnRegisterExtensionNode | ( | const XnChar * | strTypeName, |
XnProductionNodeType | baseType, | ||
XnProductionNodeType * | pTypeID | ||
) |
Registers an extension node with OpenNI. An extension node is a node of type not defined by OpenNI.
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. |
XN_C_API XnStatus XN_C_DECL xnRegisterModule | ( | const XnChar * | strModule, |
const XnChar * | strConfigDir | ||
) |
XN_C_API XnStatus XN_C_DECL xnRegisterModuleWithOpenNI | ( | XnOpenNIModuleInterface * | pInterface, |
const XnChar * | strConfigDir, | ||
const XnChar * | strName | ||
) |
Registers a module to OpenNI in environments where dynamic library loading is not supported.
pInterface | [in] The module interface. |
strConfigDir | [in] The module configuration directory. |
strName | [in] Name of this module. |
XN_C_API XnResolution XN_C_DECL xnResolutionGetFromName | ( | const XnChar * | strName | ) |
Gets resolution by its name. If resolution is unknown, XN_RESOLUTION_CUSTOM is returned.
strName | [in] Name of the resolution. |
XN_C_API XnResolution XN_C_DECL xnResolutionGetFromXYRes | ( | XnUInt32 | xRes, |
XnUInt32 | yRes | ||
) |
Gets the resolution from the number of pixels in every row and column.
xRes | [in] Number of pixels in a row. |
yRes | [in] Number of pixels in a column. |
XN_C_API const XnChar* XN_C_DECL xnResolutionGetName | ( | XnResolution | resolution | ) |
Get the name of the resolution.
resolution | [in] Resolution. |
XN_C_API XnUInt32 XN_C_DECL xnResolutionGetXRes | ( | XnResolution | resolution | ) |
Gets the number of pixels in a row for given resolution.
resolution | [in] The resolution to translate. |
XN_C_API XnUInt32 XN_C_DECL xnResolutionGetYRes | ( | XnResolution | resolution | ) |
Gets the number of pixels in a column for given resolution.
resolution | [in] The resolution to translate. |
XN_C_API XnInt32 XN_C_DECL xnVersionCompare | ( | const XnVersion * | pVersion1, |
const XnVersion * | pVersion2 | ||
) |
Compares two versions.
pVersion1 | [in] First version. |
pVersion2 | [in] Second version. |