Open 3D Engine AzCore API Reference 25.05.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AZ::Debug::Trace Class Reference

Inherits AZ::Debug::ITrace.

Public Member Functions

void Init () override
 
void Destroy () override
 
bool IsDebuggerPresent () override
 
void Break () override
 Breaks program execution immediately.
 
void Crash () override
 Crash the application.
 
void Assert (const char *fileName, int line, const char *funcName, const char *format,...) override
 
void Error (const char *fileName, int line, const char *funcName, const char *window, const char *format,...) override
 
void Warning (const char *fileName, int line, const char *funcName, const char *window, const char *format,...) override
 
void Printf (const char *window, const char *format,...) override
 
void Output (const char *window, const char *message) override
 
void OutputToRawAndDebugger (const char *window, const char *message) override
 
void RawOutput (const char *window, const char *message) override
 Called by output to handle the actual output, does not interact with ebus or allow interception.
 
void PrintCallstack (const char *window, unsigned int suppressCount=0, void *nativeContext=nullptr) override
 
- Public Member Functions inherited from AZ::Debug::ITrace
 ITrace (const ITrace &)=delete
 
 ITrace (ITrace &&)=default
 
ITraceoperator= (const ITrace &)=delete
 
ITraceoperator= (ITrace &&)=default
 
bool IsTraceLoggingEnabledForLevel (LogLevel level)
 Indicates if trace logging functions are enabled based on compile mode and cvar logging level.
 
void SetLogLevel (LogLevel newLevel)
 
bool GetAlwaysPrintCallstack () const
 
void SetAlwaysPrintCallstack (bool enable)
 
void Error (const char *fileName, int line, const char *funcName, std::nullptr_t window, const char *format,...)=delete
 
void Warning (const char *fileName, int line, const char *funcName, std::nullptr_t window, const char *format,...)=delete
 
void Printf (std::nullptr_t, const char *format,...)=delete
 
void Output (std::nullptr_t, const char *message)=delete
 
void RawOutput (std::nullptr_t, const char *message)=delete
 
void PrintCallstack (std::nullptr_t, unsigned int suppressCount=0, void *nativeContext=nullptr)=delete
 

Static Public Member Functions

static int GetAssertVerbosityLevel ()
 
static void SetAssertVerbosityLevel (int level)
 
static const charGetDefaultSystemWindow ()
 
static constexpr const charGetNoWindow ()
 
static bool AttachDebugger ()
 
static bool WaitForDebugger (float timeoutSeconds=-1.f)
 
static void HandleExceptions (bool isEnabled)
 True or false if we want to handle system exceptions.
 
static void Terminate (int exitCode)
 Terminates the process with the specified exit code.
 
static voidGetNativeExceptionInfo ()
 PEXCEPTION_POINTERS on Windows, always NULL on other platforms.
 
- Static Public Member Functions inherited from AZ::Debug::ITrace
static ITraceInstance ()
 

Member Function Documentation

◆ Assert()

void AZ::Debug::Trace::Assert ( const char fileName,
int  line,
const char funcName,
const char format,
  ... 
)
overridevirtual

Reimplemented from AZ::Debug::ITrace.

◆ Break()

void AZ::Debug::Trace::Break ( )
overridevirtual

Breaks program execution immediately.

Reimplemented from AZ::Debug::ITrace.

◆ Crash()

void AZ::Debug::Trace::Crash ( )
overridevirtual

Crash the application.

Reimplemented from AZ::Debug::ITrace.

◆ Destroy()

void AZ::Debug::Trace::Destroy ( )
overridevirtual

Reimplemented from AZ::Debug::ITrace.

◆ Error()

void AZ::Debug::Trace::Error ( const char fileName,
int  line,
const char funcName,
const char window,
const char format,
  ... 
)
overridevirtual

Reimplemented from AZ::Debug::ITrace.

◆ GetDefaultSystemWindow()

static const char * AZ::Debug::Trace::GetDefaultSystemWindow ( )
static

Returns the default string used for a system window. It can be useful for Trace message handlers to easily validate if the window they received is the fallback window used by this class, or to force a Trace message bus handler to do special processing by using a known, consistent char*

◆ GetNoWindow()

static constexpr const char * AZ::Debug::Trace::GetNoWindow ( )
inlinestaticconstexpr

Returns a Window string that indicates that the window parameter and the separating ":" not be part of the output

◆ Init()

void AZ::Debug::Trace::Init ( )
overridevirtual

Reimplemented from AZ::Debug::ITrace.

◆ IsDebuggerPresent()

bool AZ::Debug::Trace::IsDebuggerPresent ( )
overridevirtual

Reimplemented from AZ::Debug::ITrace.

◆ Output()

void AZ::Debug::Trace::Output ( const char window,
const char message 
)
overridevirtual

Reimplemented from AZ::Debug::ITrace.

◆ OutputToRawAndDebugger()

void AZ::Debug::Trace::OutputToRawAndDebugger ( const char window,
const char message 
)
overridevirtual

Reimplemented from AZ::Debug::ITrace.

◆ PrintCallstack()

void AZ::Debug::Trace::PrintCallstack ( const char window,
unsigned int  suppressCount = 0,
void nativeContext = nullptr 
)
overridevirtual

Reimplemented from AZ::Debug::ITrace.

◆ Printf()

void AZ::Debug::Trace::Printf ( const char window,
const char format,
  ... 
)
overridevirtual

Reimplemented from AZ::Debug::ITrace.

◆ RawOutput()

void AZ::Debug::Trace::RawOutput ( const char window,
const char message 
)
overridevirtual

Called by output to handle the actual output, does not interact with ebus or allow interception.

Reimplemented from AZ::Debug::ITrace.

◆ Warning()

void AZ::Debug::Trace::Warning ( const char fileName,
int  line,
const char funcName,
const char window,
const char format,
  ... 
)
overridevirtual

Reimplemented from AZ::Debug::ITrace.


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