gfxDeviceStatistics.h

Classes:

class
Detailed Description

 1
 2//-----------------------------------------------------------------------------
 3// Copyright (c) 2012 GarageGames, LLC
 4//
 5// Permission is hereby granted, free of charge, to any person obtaining a copy
 6// of this software and associated documentation files (the "Software"), to
 7// deal in the Software without restriction, including without limitation the
 8// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 9// sell copies of the Software, and to permit persons to whom the Software is
10// furnished to do so, subject to the following conditions:
11//
12// The above copyright notice and this permission notice shall be included in
13// all copies or substantial portions of the Software.
14//
15// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21// IN THE SOFTWARE.
22//-----------------------------------------------------------------------------
23#ifndef _GFXDEVICESTATISTICS_H_
24#define _GFXDEVICESTATISTICS_H_
25
26#ifndef _TORQUE_STRING_H_
27#include "core/util/str.h"
28#endif
29
30// A class that hold a simple set of device stats.
31class GFXDeviceStatistics
32{
33public:
34   // Actual stats
35   S32 mPolyCount;
36   S32 mDrawCalls;
37   S32 mRenderTargetChanges;
38
39   GFXDeviceStatistics();
40
41   void setPrefix(const String& prefix);
42
43   /// Clear stats
44   void clear();
45
46   /// Copy from source (should just be a memcpy, but that may change later) used in 
47   /// conjunction with end to get a subset of statistics.  For example, statistics
48   /// for a particular render bin.
49   void start(GFXDeviceStatistics * source);
50
51   /// Used with start to get a subset of stats on a device.  Basically will do
52   /// this->mPolyCount = source->mPolyCount - this->mPolyCount.  (Fancy!)
53   void end(GFXDeviceStatistics * source);
54
55   /// Exports the stats to the console
56   void exportToConsole();
57private:
58   String vnPolyCount;
59   String vnDrawCalls;
60   String vnRenderTargetChanges;
61};
62
63#endif
64