XnUtils.h
Go to the documentation of this file.
/****************************************************************************
* *
* OpenNI 1.x Alpha *
* Copyright (C) 2011 PrimeSense Ltd. *
* *
* This file is part of OpenNI. *
* *
* OpenNI is free software: you can redistribute it and/or modify *
* it under the terms of the GNU Lesser General Public License as published *
* by the Free Software Foundation, either version 3 of the License, or *
* (at your option) any later version. *
* *
* OpenNI is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU Lesser General Public License for more details. *
* *
* You should have received a copy of the GNU Lesser General Public License *
* along with OpenNI. If not, see <http://www.gnu.org/licenses/>. *
* *
****************************************************************************/
#ifndef __XN_UTILS_H__
#define __XN_UTILS_H__
//---------------------------------------------------------------------------
// Includes
//---------------------------------------------------------------------------
#include <XnTypes.h>
#include <XnModuleInterface.h>
//---------------------------------------------------------------------------
// Functions
//---------------------------------------------------------------------------
XN_C_API XnStatus XN_C_DECL xnGetVersion(XnVersion* pVersion);
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);
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);
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);
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);
XN_C_API XnStatus XN_C_DECL xnProductionNodeDescriptionToString(const XnProductionNodeDescription* pDescription, XnChar* csResult, XnUInt32 nSize);
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);
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();
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();
XN_C_API XnOutputMetaData* XN_C_DECL xnAllocateOutputMetaData();
XN_C_API void XN_C_DECL xnFreeOutputMetaData(const XnOutputMetaData* pMetaData);
XN_C_API XnStatus XN_C_DECL xnCopyOutputMetaData(XnOutputMetaData* pDestination, const XnOutputMetaData* pSource);
XN_C_API XnMapMetaData* XN_C_DECL xnAllocateMapMetaData();
XN_C_API void XN_C_DECL xnFreeMapMetaData(const XnMapMetaData* pMetaData);
XN_C_API XnStatus XN_C_DECL xnCopyMapMetaData(XnMapMetaData* pDestination, const XnMapMetaData* pSource);
XN_C_API XnDepthMetaData* XN_C_DECL xnAllocateDepthMetaData();
XN_C_API void XN_C_DECL xnFreeDepthMetaData(const XnDepthMetaData* pMetaData);
XN_C_API XnStatus XN_C_DECL xnCopyDepthMetaData(XnDepthMetaData* pDestination, const XnDepthMetaData* pSource);
XN_C_API XnImageMetaData* XN_C_DECL xnAllocateImageMetaData();
XN_C_API void XN_C_DECL xnFreeImageMetaData(const XnImageMetaData* pMetaData);
XN_C_API XnStatus XN_C_DECL xnCopyImageMetaData(XnImageMetaData* pDestination, const XnImageMetaData* pSource);
XN_C_API XnIRMetaData* XN_C_DECL xnAllocateIRMetaData();
XN_C_API void XN_C_DECL xnFreeIRMetaData(const XnIRMetaData* pMetaData);
XN_C_API XnStatus XN_C_DECL xnCopyIRMetaData(XnIRMetaData* pDestination, const XnIRMetaData* pSource);
XN_C_API XnAudioMetaData* XN_C_DECL xnAllocateAudioMetaData();
XN_C_API void XN_C_DECL xnFreeAudioMetaData(const XnAudioMetaData* pMetaData);
XN_C_API XnStatus XN_C_DECL xnCopyAudioMetaData(XnAudioMetaData* pDestination, const XnAudioMetaData* pSource);
XN_C_API XnSceneMetaData* XN_C_DECL xnAllocateSceneMetaData();
XN_C_API void XN_C_DECL xnFreeSceneMetaData(const XnSceneMetaData* pMetaData);
XN_C_API XnStatus XN_C_DECL xnCopySceneMetaData(XnSceneMetaData* pDestination, const XnSceneMetaData* pSource);
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);
#if !XN_PLATFORM_SUPPORTS_DYNAMIC_LIBS
XN_C_API XnStatus XN_C_DECL xnRegisterModuleWithOpenNI(XnOpenNIModuleInterface* pInterface, const XnChar* strConfigDir, const XnChar* strName);
#endif
#endif // __XN_UTILS_H__
XnModuleInterface.h
XN_C_API
#define XN_C_API
Definition XnPlatform.h:132
XnStatus
XnUInt32 XnStatus
Definition XnStatus.h:34
XnTypes.h
XnModuleNodeHandle
void * XnModuleNodeHandle
Definition XnTypes.h:219
XnPixelFormat
XnPixelFormat
Definition XnTypes.h:512
XnResolution
XnResolution
Definition XnTypes.h:408
XnPoint3D
XnVector3D XnPoint3D
Definition XnTypes.h:472
XnNodeInfoList
struct XnNodeInfoList XnNodeInfoList
Definition XnTypes.h:187
XnProductionNodeType
XnInt32 XnProductionNodeType
Definition XnTypes.h:92
XnNodeQuery
struct XnNodeQuery XnNodeQuery
Definition XnTypes.h:197
XnNodeHandle
struct XnInternalNodeData * XnNodeHandle
Definition XnTypes.h:82
XnContext
struct XnContext XnContext
Definition XnTypes.h:77
XnEnumerationErrors
struct XnEnumerationErrors XnEnumerationErrors
Definition XnTypes.h:214
xnProductionNodeTypeFromString
XN_C_API XnStatus XN_C_DECL xnProductionNodeTypeFromString(const XnChar *strType, XnProductionNodeType *pType)
xnCopyMapMetaData
XN_C_API XnStatus XN_C_DECL xnCopyMapMetaData(XnMapMetaData *pDestination, const XnMapMetaData *pSource)
Shallow-Copies a Map Meta Data object.
xnAllocateImageMetaData
XN_C_API XnImageMetaData *XN_C_DECL xnAllocateImageMetaData()
xnFreeOutputMetaData
XN_C_API void XN_C_DECL xnFreeOutputMetaData(const XnOutputMetaData *pMetaData)
xnAllocateAudioMetaData
XN_C_API XnAudioMetaData *XN_C_DECL xnAllocateAudioMetaData()
xnCopyOutputMetaData
XN_C_API XnStatus XN_C_DECL xnCopyOutputMetaData(XnOutputMetaData *pDestination, const XnOutputMetaData *pSource)
Shallow-Copies an Output Meta Data object.
xnAllocateSceneMetaData
XN_C_API XnSceneMetaData *XN_C_DECL xnAllocateSceneMetaData()
xnFreeImageMetaData
XN_C_API void XN_C_DECL xnFreeImageMetaData(const XnImageMetaData *pMetaData)
xnFreeDepthMetaData
XN_C_API void XN_C_DECL xnFreeDepthMetaData(const XnDepthMetaData *pMetaData)
xnFreeMapMetaData
XN_C_API void XN_C_DECL xnFreeMapMetaData(const XnMapMetaData *pMetaData)
xnUnregisterGlobalLicense
XN_C_API XnStatus XN_C_DECL xnUnregisterGlobalLicense(XnLicense *pLicense)
xnVersionToString
XN_C_API XnStatus XN_C_DECL xnVersionToString(const XnVersion *pVersion, XnChar *csResult, XnUInt32 nSize)
xnFreeAudioMetaData
XN_C_API void XN_C_DECL xnFreeAudioMetaData(const XnAudioMetaData *pMetaData)
xnPixelFormatFromString
XN_C_API XnStatus XN_C_DECL xnPixelFormatFromString(const XnChar *strName, XnPixelFormat *pFormat)
xnRegisterModuleWithOpenNI
XN_C_API XnStatus XN_C_DECL xnRegisterModuleWithOpenNI(XnOpenNIModuleInterface *pInterface, const XnChar *strConfigDir, const XnChar *strName)
xnAllocateOutputMetaData
XN_C_API XnOutputMetaData *XN_C_DECL xnAllocateOutputMetaData()
xnPrintRegisteredLicenses
XN_C_API XnStatus XN_C_DECL xnPrintRegisteredLicenses()
xnFreeIRMetaData
XN_C_API void XN_C_DECL xnFreeIRMetaData(const XnIRMetaData *pMetaData)
xnAllocateIRMetaData
XN_C_API XnIRMetaData *XN_C_DECL xnAllocateIRMetaData()
xnResolutionGetFromName
XN_C_API XnResolution XN_C_DECL xnResolutionGetFromName(const XnChar *strName)
xnAutoEnumerateOverSingleInput
XN_C_API XnStatus XN_C_DECL xnAutoEnumerateOverSingleInput(XnContext *pContext, XnNodeInfoList *pList, XnProductionNodeDescription *pDescription, const XnChar *strCreationInfo, XnProductionNodeType InputType, XnEnumerationErrors *pErrors, XnNodeQuery *pQuery)
xnCopyAudioMetaData
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,...
xnRegisterExtensionNode
XN_C_API XnStatus XN_C_DECL xnRegisterExtensionNode(const XnChar *strTypeName, XnProductionNodeType baseType, XnProductionNodeType *pTypeID)
xnCopyIRMetaData
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 ...
xnCopySceneMetaData
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 objec...
xnGetBytesPerPixelForPixelFormat
XN_C_API XnUInt32 XN_C_DECL xnGetBytesPerPixelForPixelFormat(XnPixelFormat format)
xnPrintRegisteredModules
XN_C_API XnStatus XN_C_DECL xnPrintRegisteredModules()
xnResolutionGetXRes
XN_C_API XnUInt32 XN_C_DECL xnResolutionGetXRes(XnResolution resolution)
xnProductionNodeDescriptionToString
XN_C_API XnStatus XN_C_DECL xnProductionNodeDescriptionToString(const XnProductionNodeDescription *pDescription, XnChar *csResult, XnUInt32 nSize)
xnGetModuleNodeHandle
XN_C_API XnModuleNodeHandle XN_C_DECL xnGetModuleNodeHandle(XnNodeHandle hNode)
xnIsTypeGenerator
XN_C_API XnBool XN_C_DECL xnIsTypeGenerator(XnProductionNodeType type)
Checks if a certain production node type is a generator or not.
xnPixelFormatToString
XN_C_API const XnChar *XN_C_DECL xnPixelFormatToString(XnPixelFormat format)
xnIsTypeDerivedFrom
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.
xnProductionNodeTypeToString
XN_C_API const XnChar *XN_C_DECL xnProductionNodeTypeToString(XnProductionNodeType Type)
xnGetVersion
XN_C_API XnStatus XN_C_DECL xnGetVersion(XnVersion *pVersion)
xnCreatePoint3D
XN_C_API XnPoint3D XN_C_DECL xnCreatePoint3D(XnFloat x, XnFloat y, XnFloat z)
xnVersionCompare
XN_C_API XnInt32 XN_C_DECL xnVersionCompare(const XnVersion *pVersion1, const XnVersion *pVersion2)
xnCopyImageMetaData
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,...
xnFreeSceneMetaData
XN_C_API void XN_C_DECL xnFreeSceneMetaData(const XnSceneMetaData *pMetaData)
xnRegisterModule
XN_C_API XnStatus XN_C_DECL xnRegisterModule(const XnChar *strModule, const XnChar *strConfigDir)
xnResolutionGetYRes
XN_C_API XnUInt32 XN_C_DECL xnResolutionGetYRes(XnResolution resolution)
xnRegisterGlobalLicense
XN_C_API XnStatus XN_C_DECL xnRegisterGlobalLicense(XnLicense *pLicense)
xnCreatePlane3D
XN_C_API XnPlane3D XN_C_DECL xnCreatePlane3D(XnPoint3D ptPoint, XnVector3D vNormal)
xnUnregisterModule
XN_C_API XnStatus XN_C_DECL xnUnregisterModule(const XnChar *strModule)
xnResolutionGetName
XN_C_API const XnChar *XN_C_DECL xnResolutionGetName(XnResolution resolution)
xnResolutionGetFromXYRes
XN_C_API XnResolution XN_C_DECL xnResolutionGetFromXYRes(XnUInt32 xRes, XnUInt32 yRes)
xnAllocateDepthMetaData
XN_C_API XnDepthMetaData *XN_C_DECL xnAllocateDepthMetaData()
xnCopyDepthMetaData
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 objec...
xnAllocateMapMetaData
XN_C_API XnMapMetaData *XN_C_DECL xnAllocateMapMetaData()
XnAudioMetaData
Definition XnTypes.h:1164
XnDepthMetaData
Definition XnTypes.h:1132
XnIRMetaData
Definition XnTypes.h:1155
XnImageMetaData
Definition XnTypes.h:1145
XnLicense
Definition XnTypes.h:203
XnMapMetaData
Definition XnTypes.h:1110
XnOpenNIModuleInterface
Definition XnModuleInterface.h:71
XnOutputMetaData
Definition XnTypes.h:1093
XnPlane3D
Definition XnTypes.h:561
XnProductionNodeDescription
Definition XnTypes.h:163
XnSceneMetaData
Definition XnTypes.h:1176
XnVector3D
Definition XnTypes.h:466
XnVersion
Definition XnTypes.h:152