Open 3D Engine Atom Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Static Public Member Functions | List of all members
AZ::RHI::RHIMemoryStatisticsInterface Class Referenceabstract

Inherited by AZ::RHI::RHISystem.

Public Member Functions

 AZ_RTTI (RHIMemoryStatisticsInterface, "{C3789EE2-7922-434D-AC19-8A2D80194C0E}")
 
 AZ_DISABLE_COPY_MOVE (RHIMemoryStatisticsInterface)
 
virtual const RHI::TransientAttachmentStatistics * GetTransientAttachmentStatistics () const =0
 
virtual const RHI::MemoryStatistics * GetMemoryStatistics () const =0
 
virtual void WriteResourcePoolInfoToJson (const AZStd::vector< RHI::MemoryStatistics::Pool > &pools, rapidjson::Document &doc) const =0
 
virtual AZ::Outcome< void, AZStd::string > LoadResourcePoolInfoFromJson (AZStd::vector< RHI::MemoryStatistics::Pool > &pools, AZStd::vector< RHI::MemoryStatistics::Heap > &heaps, rapidjson::Document &doc, const AZStd::string &fileName) const =0
 
virtual void TriggerResourcePoolAllocInfoDump () const =0
 

Static Public Member Functions

static RHIMemoryStatisticsInterface * Get ()
 

Member Function Documentation

◆ LoadResourcePoolInfoFromJson()

virtual AZ::Outcome< void, AZStd::string > AZ::RHI::RHIMemoryStatisticsInterface::LoadResourcePoolInfoFromJson ( AZStd::vector< RHI::MemoryStatistics::Pool > &  pools,
AZStd::vector< RHI::MemoryStatistics::Heap > &  heaps,
rapidjson::Document &  doc,
const AZStd::string &  fileName 
) const
pure virtual

Utility function to load previously captured pool statistics from json. The function clears the passed pools and heaps vectors.

Implemented in AZ::RHI::RHISystem.

◆ TriggerResourcePoolAllocInfoDump()

virtual void AZ::RHI::RHIMemoryStatisticsInterface::TriggerResourcePoolAllocInfoDump ( ) const
pure virtual

Utility function to write the current state of all resource pools to a json file Useful for programmatically triggered dumps.

Implemented in AZ::RHI::RHISystem.

◆ WriteResourcePoolInfoToJson()

virtual void AZ::RHI::RHIMemoryStatisticsInterface::WriteResourcePoolInfoToJson ( const AZStd::vector< RHI::MemoryStatistics::Pool > &  pools,
rapidjson::Document &  doc 
) const
pure virtual

Utility function to write the state of the provided pool statistics to json. The function assumes the pool data will not be modified while it is being converted.

Implemented in AZ::RHI::RHISystem.

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