vtkOpenGLRenderTimerLog.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef vtkOpenGLRenderTimerLog_h
#define vtkOpenGLRenderTimerLog_h
 
#include "vtkRenderTimerLog.h"
#include "vtkRenderingOpenGL2Module.h" // For export macros
 
#include <deque> // for deque!
#include <queue> // for queue!
 
VTK_ABI_NAMESPACE_BEGIN
class vtkOpenGLRenderTimer;
class vtkOverrideAttribute;

class VTKRENDERINGOPENGL2_EXPORT vtkOpenGLRenderTimerLog : public vtkRenderTimerLog
{
public:
  struct OGLEvent
  {
    OGLEvent()
      : Timer(nullptr)
    {
    }
 
    std::string Name;
    vtkOpenGLRenderTimer* Timer;
    std::vector<OGLEvent> Events;
  };
 
  struct OGLFrame
  {
    OGLFrame()
      : ChildCount(0)
    {
    }
 
    unsigned int ChildCount;
    std::vector<OGLEvent> Events;
  };
 
  static vtkOpenGLRenderTimerLog* New();
  VTK_NEWINSTANCE
  static vtkOverrideAttribute* CreateOverrideAttributes();
  vtkTypeMacro(vtkOpenGLRenderTimerLog, vtkRenderTimerLog);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  bool IsSupported() VTK_FUTURE_CONST override;

  bool GetLoggingEnabled() VTK_FUTURE_CONST override { return this->DoLogging(); }
 
  void MarkFrame() override;
 
  void MarkStartEvent(const std::string& name) override;
  void MarkEndEvent() override;
 
  bool FrameReady() override;
 
  Frame PopFirstReadyFrame() override;

  void ReleaseGraphicsResources() override;

  vtkSetMacro(MinTimerPoolSize, size_t);
  vtkGetMacro(MinTimerPoolSize, size_t);
 
protected:
  OGLFrame CurrentFrame;
  // We use a deque since they are iterable. convention is push back, pop front
  std::deque<OGLFrame> PendingFrames;
  std::queue<Frame> ReadyFrames;
 
  std::queue<vtkOpenGLRenderTimer*> TimerPool;
 
  size_t MinTimerPoolSize;
 
  vtkOpenGLRenderTimerLog();
  ~vtkOpenGLRenderTimerLog() override;
 
  bool DoLogging() VTK_FUTURE_CONST;
 
  Frame Convert(const OGLFrame& oglFrame);
  Event Convert(const OGLEvent& oglEvent);
 
  OGLEvent& NewEvent();
  OGLEvent* DeepestOpenEvent();
  OGLEvent& WalkOpenEvents(OGLEvent& event);
 
  vtkOpenGLRenderTimer* NewTimer();
  void ReleaseTimer(vtkOpenGLRenderTimer* timer);
 
  void ReleaseOGLFrame(OGLFrame& frame);
  void ReleaseOGLEvent(OGLEvent& event);
 
  void TrimTimerPool();
 
  void CheckPendingFrames();
  bool IsFrameReady(OGLFrame& frame);
  bool IsEventReady(OGLEvent& event);
 
  void ForceCloseFrame(OGLFrame& frame);
  void ForceCloseEvent(OGLEvent& event);
 
private:
  vtkOpenGLRenderTimerLog(const vtkOpenGLRenderTimerLog&) = delete;
  void operator=(const vtkOpenGLRenderTimerLog&) = delete;
};
 
#define vtkOpenGLRenderTimerLog_OVERRIDE_ATTRIBUTES                                                \
  vtkOpenGLRenderTimerLog::CreateOverrideAttributes()
VTK_ABI_NAMESPACE_END
#endif // vtkOpenGLRenderTimerLog_h