Core/EngineProfiling.h

   1 //
   2 // Copyright (c) Microsoft. All rights reserved.
   3 // This code is licensed under the MIT License (MIT).
   4 // THIS CODE IS PROVIDED *AS IS* WITHOUT WARRANTY OF
   5 // ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY
   6 // IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR
   7 // PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.
   8 //
   9 // Developed by Minigraph
  10 //
  11 // Author:  James Stanard
  12 //
  13
  14 #pragma once
  15
  16 #include <string>
  17 #include "TextRenderer.h"
  18
  19 class CommandContext;
  20
  21 namespace EngineProfiling
  22 {
  23     void Update();
  24
  25     void BeginBlock(const std::wstring& name, CommandContext* Context = nullptr);
  26     void EndBlock(CommandContext* Context = nullptr);
  27
  28     void DisplayFrameRate(TextContext& Text);
  29     void DisplayPerfGraph(GraphicsContext& Text);
  30     void Display(TextContext& Text, float x, float y, float w, float h);
  31     bool IsPaused();
  32 }
  33
  34 #ifdef RELEASE
  35 class ScopedTimer
  36 {
  37 public:
  38     ScopedTimer(const std::wstring&) {}
  39     ScopedTimer(const std::wstring&, CommandContext&) {}
  40 };
  41 #else
  42 class ScopedTimer
  43 {
  44 public:
  45     ScopedTimer( const std::wstring& name ) : m_Context(nullptr)
  46     {
  47         EngineProfiling::BeginBlock(name);
  48     }
  49     ScopedTimer( const std::wstring& name, CommandContext& Context ) : m_Context(&Context)
  50     {
  51         EngineProfiling::BeginBlock(name, m_Context);
  52     }
  53     ~ScopedTimer()
  54     {
  55         EngineProfiling::EndBlock(m_Context);
  56     }
  57
  58 private:
  59     CommandContext* m_Context;
  60 };
  61 #endif