SpiecsEngine
 
Loading...
Searching...
No Matches
Spices::NsightPerfGPUProfilerHUD Class Reference

Wrapper of Nvidia Nsight Performance HUD. More...

#include <NsightPerfGPUProfilerHUD.h>

Public Member Functions

 NsightPerfGPUProfilerHUD (VulkanState &state)
 Constructor Function.
 
virtual ~NsightPerfGPUProfilerHUD ()=default
 Destructor Function.
 
void Create (VulkanState &state)
 Create this.
 
void InitHUDRenderer ()
 Initialize ImGui, ImPlot and pass the data model into HUD Renderer.
 
void RenderHUD ()
 Inform the sampler about the frame end, and use the HUD renderer to visualize the populated data model.
 
void SetInSession (bool inSession)
 Set if is needed in session.
 
void ConsumeSample ()
 Samples to be periodically fetched and processed by the sampler utility classes. Caveat: If this is not done, the sampler can fall into an irrecoverable state. Choose maxDecodeLatency to cover for a large-enough delay. Frame boundaries are recorded so that per-frame values, of e.g. draw call counts, can be shown as well as per-sample values.
 
void EndFrame (VulkanState &state)
 End Sampler Frame.
 
void Reset ()
 Reset Sampler.
 

Static Public Member Functions

static void CreateInstance (VulkanState &state)
 Create this Single Instance.
 
static NsightPerfGPUProfilerHUDGet ()
 Get this Single Instance.
 
static void QueryDeviceExtensionRequirement (VkInstance instance, VkPhysicalDevice physicalDevice, std::vector< const char * > &deviceExtensionNames)
 
static void QueryInstanceExtensionRequirement (std::vector< const char * > &instanceExtensionNames, uint32_t apiVersion)
 Query Instance Extension Requirements.
 

Private Member Functions

uint32_t SelectSamplingFrequency () const
 Select a SamplingFrequency (Hz) by ImGui::IO.
 

Private Attributes

VulkanStatem_VulkanState
 VulkanState.
 
nv::perf::sampler::PeriodicSamplerTimeHistoryVulkan m_Sampler
 Sampler.
 
nv::perf::hud::HudDataModel m_HudDataModel
 HUD data.
 
nv::perf::hud::HudImPlotRenderer m_HudRenderer
 HUD imgui renderer.
 
bool m_IsReachBufferBound
 True if Decode and Consume failed.
 
bool m_IsInSession
 True if in a Session.
 
bool m_IsHUDInitialized
 True id HUD is initialized.
 

Static Private Attributes

static std::shared_ptr< NsightPerfGPUProfilerHUDm_NsightPerfGPUProfilerHUD
 This Single Instance.
 

Detailed Description

Wrapper of Nvidia Nsight Performance HUD.

Definition at line 21 of file NsightPerfGPUProfilerHUD.h.


The documentation for this class was generated from the following files: