1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
|
/*****************************************************************************
* *
* PrimeSense PSCommon Library *
* Copyright (C) 2012 PrimeSense Ltd. *
* *
* This file is part of PSCommon. *
* *
* Licensed under the Apache License, Version 2.0 (the "License"); *
* you may not use this file except in compliance with the License. *
* You may obtain a copy of the License at *
* *
* http://www.apache.org/licenses/LICENSE-2.0 *
* *
* Unless required by applicable law or agreed to in writing, software *
* distributed under the License is distributed on an "AS IS" BASIS, *
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
* See the License for the specific language governing permissions and *
* limitations under the License. *
* *
*****************************************************************************/
#ifndef __XN_FPS_CALCULATOR_H__
#define __XN_FPS_CALCULATOR_H__
//---------------------------------------------------------------------------
// Includes
//---------------------------------------------------------------------------
#include <XnPlatform.h>
#include <XnStatus.h>
//---------------------------------------------------------------------------
// Types
//---------------------------------------------------------------------------
struct XnFPSDataImpl;
typedef struct XnFPSDataImpl* XnFPSData;
//---------------------------------------------------------------------------
// Exported Functions
//---------------------------------------------------------------------------
/**
* This function initializes the FPS calculator.
*
* @param pFPS [in] A pointer to an XnFPSData struct.
* @param nSamplesCount [in] The number of last frames to be kept.
*/
XN_C_API XnStatus XN_C_DECL xnFPSInit(XnFPSData* pFPS, XnUInt32 nSamplesCount);
/**
* This function marks that another frame was processed.
*
* @param pFPS [in] A pointer to an XnFPSData struct.
* @param nNow [in] Optional. Current time. When not provided, function will take it itself.
*/
XN_C_API XnStatus XN_C_DECL xnFPSMarkFrame(XnFPSData* pFPS, XnUInt64 nNow = 0);
/**
* This function calculates the average FPS over the last frames.
*
* @param pFPS [in] A pointer to an XnFPSData struct.
* @param nAverageOver [in] The number of milliseconds to average over.
* @param nNow [in] Optional. Current time. When not provided, function will take it itself.
*/
XN_C_API XnDouble XN_C_DECL xnFPSCalc(XnFPSData* pFPS, XnUInt32 nAverageOver = 3000, XnUInt64 nNow = 0);
/**
* This function frees the FPS calculator.
*
* @param pFPS [in] A pointer to an XnFPSData struct.
*/
XN_C_API XnStatus XN_C_DECL xnFPSFree(XnFPSData* pFPS);
#endif //__XN_FPS_CALCULATOR_H__
|
