OpenNI 1.5.4
XnUtils.h
Go to the documentation of this file.
1/****************************************************************************
2* *
3* OpenNI 1.x Alpha *
4* Copyright (C) 2011 PrimeSense Ltd. *
5* *
6* This file is part of OpenNI. *
7* *
8* OpenNI is free software: you can redistribute it and/or modify *
9* it under the terms of the GNU Lesser General Public License as published *
10* by the Free Software Foundation, either version 3 of the License, or *
11* (at your option) any later version. *
12* *
13* OpenNI is distributed in the hope that it will be useful, *
14* but WITHOUT ANY WARRANTY; without even the implied warranty of *
15* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
16* GNU Lesser General Public License for more details. *
17* *
18* You should have received a copy of the GNU Lesser General Public License *
19* along with OpenNI. If not, see <http://www.gnu.org/licenses/>. *
20* *
21****************************************************************************/
22#ifndef __XN_UTILS_H__
23#define __XN_UTILS_H__
24
32//---------------------------------------------------------------------------
33// Includes
34//---------------------------------------------------------------------------
35#include <XnTypes.h>
36#include <XnModuleInterface.h>
37
38//---------------------------------------------------------------------------
39// Functions
40//---------------------------------------------------------------------------
41
53
55
67
75
82
90
92
103XN_C_API const XnChar* XN_C_DECL xnPixelFormatToString(XnPixelFormat format);
104
111XN_C_API XnStatus XN_C_DECL xnPixelFormatFromString(const XnChar* strName, XnPixelFormat* pFormat);
112
119
121
132XN_C_API XnUInt32 XN_C_DECL xnResolutionGetXRes(XnResolution resolution);
133
139XN_C_API XnUInt32 XN_C_DECL xnResolutionGetYRes(XnResolution resolution);
140
147XN_C_API XnResolution XN_C_DECL xnResolutionGetFromXYRes(XnUInt32 xRes, XnUInt32 yRes);
148
154XN_C_API XnResolution XN_C_DECL xnResolutionGetFromName(const XnChar* strName);
155
161XN_C_API const XnChar* XN_C_DECL xnResolutionGetName(XnResolution resolution);
162
164
178XN_C_API XnInt32 XN_C_DECL xnVersionCompare(const XnVersion* pVersion1, const XnVersion* pVersion2);
179
180XN_C_API XnStatus XN_C_DECL xnVersionToString(const XnVersion* pVersion, XnChar* csResult, XnUInt32 nSize);
181
183
189XN_C_API XnStatus XN_C_DECL xnProductionNodeDescriptionToString(const XnProductionNodeDescription* pDescription, XnChar* csResult, XnUInt32 nSize);
190
192
198XN_C_API XnPoint3D XN_C_DECL xnCreatePoint3D(XnFloat x, XnFloat y, XnFloat z);
200
202
208XN_C_API XnStatus XN_C_DECL xnRegisterModule(const XnChar* strModule, const XnChar* strConfigDir);
209XN_C_API XnStatus XN_C_DECL xnUnregisterModule(const XnChar* strModule);
211
213
222
224
241XN_C_API void XN_C_DECL xnFreeOutputMetaData(const XnOutputMetaData* pMetaData);
249
261XN_C_API void XN_C_DECL xnFreeMapMetaData(const XnMapMetaData* pMetaData);
268XN_C_API XnStatus XN_C_DECL xnCopyMapMetaData(XnMapMetaData* pDestination, const XnMapMetaData* pSource);
269
281XN_C_API void XN_C_DECL xnFreeDepthMetaData(const XnDepthMetaData* pMetaData);
289XN_C_API XnStatus XN_C_DECL xnCopyDepthMetaData(XnDepthMetaData* pDestination, const XnDepthMetaData* pSource);
290
302XN_C_API void XN_C_DECL xnFreeImageMetaData(const XnImageMetaData* pMetaData);
310XN_C_API XnStatus XN_C_DECL xnCopyImageMetaData(XnImageMetaData* pDestination, const XnImageMetaData* pSource);
311
323XN_C_API void XN_C_DECL xnFreeIRMetaData(const XnIRMetaData* pMetaData);
331XN_C_API XnStatus XN_C_DECL xnCopyIRMetaData(XnIRMetaData* pDestination, const XnIRMetaData* pSource);
332
344XN_C_API void XN_C_DECL xnFreeAudioMetaData(const XnAudioMetaData* pMetaData);
352XN_C_API XnStatus XN_C_DECL xnCopyAudioMetaData(XnAudioMetaData* pDestination, const XnAudioMetaData* pSource);
353
365XN_C_API void XN_C_DECL xnFreeSceneMetaData(const XnSceneMetaData* pMetaData);
373XN_C_API XnStatus XN_C_DECL xnCopySceneMetaData(XnSceneMetaData* pDestination, const XnSceneMetaData* pSource);
374
376
394XN_C_API XnStatus XN_C_DECL xnAutoEnumerateOverSingleInput(XnContext* pContext, XnNodeInfoList* pList, XnProductionNodeDescription* pDescription, const XnChar* strCreationInfo, XnProductionNodeType InputType, XnEnumerationErrors* pErrors, XnNodeQuery* pQuery);
395
403XN_C_API XnStatus XN_C_DECL xnRegisterExtensionNode(const XnChar* strTypeName, XnProductionNodeType baseType, XnProductionNodeType* pTypeID);
404
411
412#if !XN_PLATFORM_SUPPORTS_DYNAMIC_LIBS
420XN_C_API XnStatus XN_C_DECL xnRegisterModuleWithOpenNI(XnOpenNIModuleInterface* pInterface, const XnChar* strConfigDir, const XnChar* strName);
421#endif
422
424
427#endif // __XN_UTILS_H__
#define XN_C_API
Definition: XnPlatform.h:129
XnUInt32 XnStatus
Definition: XnStatus.h:34
void * XnModuleNodeHandle
Definition: XnTypes.h:219
XnPixelFormat
Definition: XnTypes.h:512
XnResolution
Definition: XnTypes.h:408
struct XnNodeInfoList XnNodeInfoList
Definition: XnTypes.h:187
XnInt32 XnProductionNodeType
Definition: XnTypes.h:92
struct XnNodeQuery XnNodeQuery
Definition: XnTypes.h:197
struct XnInternalNodeData * XnNodeHandle
Definition: XnTypes.h:82
struct XnContext XnContext
Definition: XnTypes.h:77
struct XnEnumerationErrors XnEnumerationErrors
Definition: XnTypes.h:214
XN_C_API XnStatus XN_C_DECL xnProductionNodeTypeFromString(const XnChar *strType, XnProductionNodeType *pType)
XN_C_API XnStatus XN_C_DECL xnCopyMapMetaData(XnMapMetaData *pDestination, const XnMapMetaData *pSource)
Shallow-Copies a Map Meta Data object.
XN_C_API XnImageMetaData *XN_C_DECL xnAllocateImageMetaData()
XN_C_API void XN_C_DECL xnFreeOutputMetaData(const XnOutputMetaData *pMetaData)
XN_C_API XnAudioMetaData *XN_C_DECL xnAllocateAudioMetaData()
XN_C_API XnStatus XN_C_DECL xnCopyOutputMetaData(XnOutputMetaData *pDestination, const XnOutputMetaData *pSource)
Shallow-Copies an Output Meta Data object.
XN_C_API XnSceneMetaData *XN_C_DECL xnAllocateSceneMetaData()
XN_C_API void XN_C_DECL xnFreeImageMetaData(const XnImageMetaData *pMetaData)
XN_C_API void XN_C_DECL xnFreeDepthMetaData(const XnDepthMetaData *pMetaData)
XN_C_API void XN_C_DECL xnFreeMapMetaData(const XnMapMetaData *pMetaData)
XN_C_API XnStatus XN_C_DECL xnUnregisterGlobalLicense(XnLicense *pLicense)
XN_C_API XnStatus XN_C_DECL xnVersionToString(const XnVersion *pVersion, XnChar *csResult, XnUInt32 nSize)
XN_C_API void XN_C_DECL xnFreeAudioMetaData(const XnAudioMetaData *pMetaData)
XN_C_API XnStatus XN_C_DECL xnPixelFormatFromString(const XnChar *strName, XnPixelFormat *pFormat)
XN_C_API XnStatus XN_C_DECL xnRegisterModuleWithOpenNI(XnOpenNIModuleInterface *pInterface, const XnChar *strConfigDir, const XnChar *strName)
XN_C_API XnOutputMetaData *XN_C_DECL xnAllocateOutputMetaData()
XN_C_API XnStatus XN_C_DECL xnPrintRegisteredLicenses()
XN_C_API void XN_C_DECL xnFreeIRMetaData(const XnIRMetaData *pMetaData)
XN_C_API XnIRMetaData *XN_C_DECL xnAllocateIRMetaData()
XN_C_API XnResolution XN_C_DECL xnResolutionGetFromName(const XnChar *strName)
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 xnCopyAudioMetaData(XnAudioMetaData *pDestination, const XnAudioMetaData *pSource)
Shallow-Copies an Audio Meta Data object. Note that the data buffer is not copied,...
XN_C_API XnStatus XN_C_DECL xnRegisterExtensionNode(const XnChar *strTypeName, XnProductionNodeType baseType, XnProductionNodeType *pTypeID)
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 ...
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...
XN_C_API XnUInt32 XN_C_DECL xnGetBytesPerPixelForPixelFormat(XnPixelFormat format)
XN_C_API XnStatus XN_C_DECL xnPrintRegisteredModules()
XN_C_API XnUInt32 XN_C_DECL xnResolutionGetXRes(XnResolution resolution)
XN_C_API XnStatus XN_C_DECL xnProductionNodeDescriptionToString(const XnProductionNodeDescription *pDescription, XnChar *csResult, XnUInt32 nSize)
XN_C_API XnModuleNodeHandle XN_C_DECL xnGetModuleNodeHandle(XnNodeHandle hNode)
XN_C_API XnBool XN_C_DECL xnIsTypeGenerator(XnProductionNodeType type)
Checks if a certain production node type is a generator or not.
XN_C_API const XnChar *XN_C_DECL xnPixelFormatToString(XnPixelFormat format)
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.
XN_C_API const XnChar *XN_C_DECL xnProductionNodeTypeToString(XnProductionNodeType Type)
XN_C_API XnStatus XN_C_DECL xnGetVersion(XnVersion *pVersion)
XN_C_API XnPoint3D XN_C_DECL xnCreatePoint3D(XnFloat x, XnFloat y, XnFloat z)
XN_C_API XnInt32 XN_C_DECL xnVersionCompare(const XnVersion *pVersion1, const XnVersion *pVersion2)
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,...
XN_C_API void XN_C_DECL xnFreeSceneMetaData(const XnSceneMetaData *pMetaData)
XN_C_API XnStatus XN_C_DECL xnRegisterModule(const XnChar *strModule, const XnChar *strConfigDir)
XN_C_API XnUInt32 XN_C_DECL xnResolutionGetYRes(XnResolution resolution)
XN_C_API XnStatus XN_C_DECL xnRegisterGlobalLicense(XnLicense *pLicense)
XN_C_API XnPlane3D XN_C_DECL xnCreatePlane3D(XnPoint3D ptPoint, XnVector3D vNormal)
XN_C_API XnStatus XN_C_DECL xnUnregisterModule(const XnChar *strModule)
XN_C_API const XnChar *XN_C_DECL xnResolutionGetName(XnResolution resolution)
XN_C_API XnResolution XN_C_DECL xnResolutionGetFromXYRes(XnUInt32 xRes, XnUInt32 yRes)
XN_C_API XnDepthMetaData *XN_C_DECL xnAllocateDepthMetaData()
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...
XN_C_API XnMapMetaData *XN_C_DECL xnAllocateMapMetaData()
Definition: XnTypes.h:1164
Definition: XnTypes.h:1132
Definition: XnTypes.h:1155
Definition: XnTypes.h:1145
Definition: XnTypes.h:203
Definition: XnTypes.h:1110
Definition: XnModuleInterface.h:71
Definition: XnTypes.h:1093
Definition: XnTypes.h:561
Definition: XnTypes.h:163
Definition: XnTypes.h:1176
Definition: XnTypes.h:466
Definition: XnTypes.h:152