AZ::RHI::RHISystem Class Reference

Inherits AZ::RHI::RHISystemInterface, and AZ::RHI::RHIMemoryStatisticsInterface.

Public Types
using	FrameGraphCallback = AZStd::function< void(RHI::FrameGraphBuilder &)>
	An external callback to build the frame graph.

Public Member Functions
ResultCode	InitDevices (InitDevicesFlags initializationVariant=InitDevicesFlags::SingleDevice)
void	Init (RHI::Ptr< RHI::ShaderResourceGroupLayout > bindlessSrgLayout=nullptr)
void	Shutdown ()
void	FrameUpdate (FrameGraphCallback frameGraphCallback)
	Invokes the frame scheduler. The provided callback is invoked prior to compilation of the graph.
bool	RegisterXRSystem (XRRenderingInterface *xrRenderingInterface)
	Register/Unregister xr system.
void	UnregisterXRSystem ()
void	SetNumActiveRenderPipelines (uint16_t numActiveRenderPipelines)
	Get/Set functions for the number of active pipelines in use in a frame.
uint16_t	GetNumActiveRenderPipelines () const
RHI::Device *	GetDevice (int deviceIndex=MultiDevice::DefaultDeviceIndex) override
int	GetDeviceCount () override
RHI::DrawListTagRegistry *	GetDrawListTagRegistry () override
RHI::PipelineStateCache *	GetPipelineStateCache () override
void	ModifyFrameSchedulerStatisticsFlags (RHI::FrameSchedulerStatisticsFlags statisticsFlags, bool enableFlags) override
double	GetCpuFrameTime () const override
const RHI::TransientAttachmentPoolDescriptor *	GetTransientAttachmentPoolDescriptor () const override
ConstPtr< PlatformLimitsDescriptor >	GetPlatformLimitsDescriptor (int deviceIndex=MultiDevice::DefaultDeviceIndex) const override
void	QueueRayTracingShaderTableForBuild (RayTracingShaderTable *rayTracingShaderTable) override
XRRenderingInterface *	GetXRSystem () const override
const RHI::TransientAttachmentStatistics *	GetTransientAttachmentStatistics () const override
const RHI::MemoryStatistics *	GetMemoryStatistics () const override
void	WriteResourcePoolInfoToJson (const AZStd::vector< RHI::MemoryStatistics::Pool > &pools, rapidjson::Document &doc) const override
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 override
void	TriggerResourcePoolAllocInfoDump () const override
Public Member Functions inherited from AZ::RHI::RHISystemInterface
	AZ_RTTI (RHISystemInterface, "{B70BB184-D7D5-4C15-9C82-C9459F552F13}")
	AZ_DISABLE_COPY_MOVE (RHISystemInterface)
virtual RHI::Device *	GetDevice (int deviceIndex=MultiDevice::DefaultDeviceIndex)=0
virtual int	GetDeviceCount ()=0
virtual RHI::DrawListTagRegistry *	GetDrawListTagRegistry ()=0
virtual RHI::PipelineStateCache *	GetPipelineStateCache ()=0
virtual void	ModifyFrameSchedulerStatisticsFlags (RHI::FrameSchedulerStatisticsFlags statisticsFlags, bool enableFlags)=0
virtual double	GetCpuFrameTime () const =0
virtual uint16_t	GetNumActiveRenderPipelines () const =0
virtual const RHI::TransientAttachmentPoolDescriptor *	GetTransientAttachmentPoolDescriptor () const =0
virtual ConstPtr< PlatformLimitsDescriptor >	GetPlatformLimitsDescriptor (int deviceIndex=MultiDevice::DefaultDeviceIndex) const =0
virtual void	QueueRayTracingShaderTableForBuild (RayTracingShaderTable *rayTracingShaderTable)=0
virtual XRRenderingInterface *	GetXRSystem () const =0
Public Member Functions inherited from AZ::RHI::RHIMemoryStatisticsInterface
	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

Additional Inherited Members
Static Public Member Functions inherited from AZ::RHI::RHISystemInterface
static RHISystemInterface *	Get ()
Static Public Member Functions inherited from AZ::RHI::RHIMemoryStatisticsInterface
static RHIMemoryStatisticsInterface *	Get ()

Member Function Documentation

GetCpuFrameTime()

double AZ::RHI::RHISystem::GetCpuFrameTime ( ) const

overridevirtual

Implements AZ::RHI::RHISystemInterface.

GetDevice()

RHI::Device * AZ::RHI::RHISystem::GetDevice ( int  deviceIndex = MultiDevice::DefaultDeviceIndex )

overridevirtual

Implements AZ::RHI::RHISystemInterface.

GetDeviceCount()

int AZ::RHI::RHISystem::GetDeviceCount ( )

overridevirtual

Implements AZ::RHI::RHISystemInterface.

GetDrawListTagRegistry()

RHI::DrawListTagRegistry * AZ::RHI::RHISystem::GetDrawListTagRegistry ( )

overridevirtual

Implements AZ::RHI::RHISystemInterface.

GetMemoryStatistics()

const RHI::MemoryStatistics * AZ::RHI::RHISystem::GetMemoryStatistics ( ) const

overridevirtual

Implements AZ::RHI::RHIMemoryStatisticsInterface.

GetNumActiveRenderPipelines()

uint16_t AZ::RHI::RHISystem::GetNumActiveRenderPipelines ( ) const

virtual

Implements AZ::RHI::RHISystemInterface.

GetPipelineStateCache()

RHI::PipelineStateCache * AZ::RHI::RHISystem::GetPipelineStateCache ( )

overridevirtual

Implements AZ::RHI::RHISystemInterface.

GetPlatformLimitsDescriptor()

ConstPtr< PlatformLimitsDescriptor > AZ::RHI::RHISystem::GetPlatformLimitsDescriptor ( int  deviceIndex = MultiDevice::DefaultDeviceIndex ) const

overridevirtual

Implements AZ::RHI::RHISystemInterface.

GetTransientAttachmentPoolDescriptor()

const RHI::TransientAttachmentPoolDescriptor * AZ::RHI::RHISystem::GetTransientAttachmentPoolDescriptor ( ) const

overridevirtual

Implements AZ::RHI::RHISystemInterface.

GetTransientAttachmentStatistics()

const RHI::TransientAttachmentStatistics * AZ::RHI::RHISystem::GetTransientAttachmentStatistics ( ) const

overridevirtual

Implements AZ::RHI::RHIMemoryStatisticsInterface.

GetXRSystem()

XRRenderingInterface * AZ::RHI::RHISystem::GetXRSystem ( ) const

overridevirtual

Implements AZ::RHI::RHISystemInterface.

Init()

void AZ::RHI::RHISystem::Init

(

RHI::Ptr< RHI::ShaderResourceGroupLayout >

bindlessSrgLayout = nullptr

)

This function initializes the rest of the RHI/RHI backend. bindlessSrgLayout in this case is layout associated with the bindless srg (Bindless.azsli).

InitDevices()

ResultCode AZ::RHI::RHISystem::InitDevices

(

InitDevicesFlags

initializationVariant = InitDevicesFlags::SingleDevice

)

This function just initializes the native device and RHI::Device as a result. We can use this device to then query for device capabilities.

LoadResourcePoolInfoFromJson()

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

overridevirtual

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

Implements AZ::RHI::RHIMemoryStatisticsInterface.

ModifyFrameSchedulerStatisticsFlags()

void AZ::RHI::RHISystem::ModifyFrameSchedulerStatisticsFlags ( RHI::FrameSchedulerStatisticsFlags  statisticsFlags, bool  enableFlags  )

overridevirtual

Implements AZ::RHI::RHISystemInterface.

QueueRayTracingShaderTableForBuild()

void AZ::RHI::RHISystem::QueueRayTracingShaderTableForBuild ( RayTracingShaderTable *  rayTracingShaderTable )

overridevirtual

Implements AZ::RHI::RHISystemInterface.

TriggerResourcePoolAllocInfoDump()

void AZ::RHI::RHISystem::TriggerResourcePoolAllocInfoDump ( ) const

overridevirtual

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

Implements AZ::RHI::RHIMemoryStatisticsInterface.

WriteResourcePoolInfoToJson()

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

overridevirtual

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.

Implements AZ::RHI::RHIMemoryStatisticsInterface.

---

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

• Gems/Atom/RHI/Code/Include/Atom/RHI/RHISystem.h