Open 3D Engine AzCore 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 | List of all members
AZ::Debug::ProfilerRequests Class Referenceabstract

#include <ProfilerBus.h>

Public Member Functions

 AZ_RTTI (ProfilerRequests, "{90AEC117-14C1-4BAE-9704-F916E49EF13F}")
 
virtual bool IsActive () const =0
 Getter/setter for the profiler active state.
 
virtual void SetActive (bool active)=0
 
virtual bool CaptureFrame (const AZStd::string &outputFilePath)=0
 Capture a single frame of profiling data.
 
virtual bool StartCapture (AZStd::string outputFilePath)=0
 Starting/ending a multi-frame capture of profiling data.
 
virtual bool EndCapture ()=0
 
virtual bool IsCaptureInProgress () const =0
 

Detailed Description

ProfilerRequests provides an interface for making profiling system requests

Member Function Documentation

◆ IsCaptureInProgress()

virtual bool AZ::Debug::ProfilerRequests::IsCaptureInProgress ( ) const
pure virtual

Check to see if a programmatic capture is currently in progress, implies that the profiler is active if returns True.

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