FDebug Struct Reference

#include <AssertionMacros.h>

Static Public Member Functions
static CORE_API void VARARGS	AssertFailed (const ANSICHAR *Expr, const ANSICHAR *File, int32 Line, const TCHAR *Format=TEXT(""),...)
static CORE_API void	AssertFailedV (const ANSICHAR *Expr, const ANSICHAR *File, int32 Line, const TCHAR *Format, va_list Args)
static CORE_API void	ProcessFatalError (void *ProgramCounter)
static CORE_API bool	HasAsserted ()
	track thread asserts
static CORE_API bool	IsEnsuring ()
static CORE_API SIZE_T	GetNumEnsureFailures ()
static CORE_API void	DumpStackTraceToLog (const ELogVerbosity::Type LogVerbosity)
static CORE_API void	DumpStackTraceToLog (const TCHAR *Heading, const ELogVerbosity::Type LogVerbosity)
static CORE_API void	LogFormattedMessageWithCallstack (const FName &LogName, const ANSICHAR *File, int32 Line, const TCHAR *Heading, const TCHAR *Message, ELogVerbosity::Type Verbosity)

Detailed Description

FDebug These functions offer debugging and diagnostic functionality and its presence depends on compiler switches.

Member Function Documentation

AssertFailed()

void VARARGS FDebug::AssertFailed ( const ANSICHAR *  Expr, const ANSICHAR *  File, int32  Line, const TCHAR *  Format = TEXT(""),   ...  )

static

Logs final assert message and exits the program.

AssertFailedV()

void FDebug::AssertFailedV ( const ANSICHAR *  Expr, const ANSICHAR *  File, int32  Line, const TCHAR *  Format, va_list  Args  )

static

DumpStackTraceToLog() [1/2]

UE_AUTORTFM_ALWAYS_OPEN void FDebug::DumpStackTraceToLog ( const ELogVerbosity::Type  LogVerbosity )

static

Dumps the stack trace into the log, meant to be used for debugging purposes.

DumpStackTraceToLog() [2/2]

UE_AUTORTFM_ALWAYS_OPEN FORCENOINLINE void FDebug::DumpStackTraceToLog ( const TCHAR *  Heading, const ELogVerbosity::Type  LogVerbosity  )

static

Dumps the stack trace into the log with a custom heading, meant to be used for debugging purposes.

GetNumEnsureFailures()

SIZE_T FDebug::GetNumEnsureFailures ( )

static

HasAsserted()

bool FDebug::HasAsserted ( )

static

track thread asserts

IsEnsuring()

bool FDebug::IsEnsuring ( )

static

LogFormattedMessageWithCallstack()

void FDebug::LogFormattedMessageWithCallstack ( const FName &  LogName, const ANSICHAR *  File, int32  Line, const TCHAR *  Heading, const TCHAR *  Message, ELogVerbosity::Type  Verbosity  )

static

Logs an a message to the provided log channel. If a callstack is included (detected by lines starting with 0x) if will be logged in the standard Unreal format of [Callstack] Address FunctionInfo [File]

Parameters

LogName	Log channel. If NAME_None then LowLevelOutputDebugStringf is used
File	File name ANSI string (FILE)
Line	Line number (LINE)
Heading	Informative heading displayed above the message callstack
Message	Multi-line message with a callstack

ProcessFatalError()

void FDebug::ProcessFatalError ( void *  ProgramCounter )

static

Triggers a fatal error, using the error formatted to GErrorHist via a previous call to FMsg

---

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

• Engine/Source/Runtime/Core/Public/Misc/AssertionMacros.h
• Engine/Source/Runtime/Core/Private/Misc/AssertionMacros.cpp