1. Epic GamesDeveloper
  3. FDebug

FDebug

[FDebug](API\Runtime\Core\Misc\FDebug) These functions offer debugging and diagnostic functionality and its presence depends on compiler switches.

API > API/Runtime > API/Runtime/Core > API/Runtime/Core/Misc

References

   
Module Core
Header /Engine/Source/Runtime/Core/Public/Misc/AssertionMacros.h
Include #include "Misc/AssertionMacros.h"

Syntax

struct FDebug

Remarks

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

Functions

  Type Name Description
Public function Static void

AssertFailed ( const ANSICHAR* Expr,
const ANSICHAR* File,
int32 Line,
const TCHAR* Format,
...
)

 Logs final assert message and exits the program.
Public function Static void

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

  
Public function Static **staticvoidUE_DEBUG_SECTION

CheckVerifyFailed ( const ANSICHAR* Expr,
const ANSICHAR* File,
int32 Line,
void* ProgramCounter,
const FmtType& Format,
Types... Args
)

 /*** Called when a 'check/verify' assertion fails.
Public function Static bool

CheckVerifyFailedImpl ( const ANSICHAR* Expr,
const ANSICHAR* File,
int32 Line,
void* ProgramCounter,
const TCHAR* Format,
...
)

  
Public function Static void

DumpStackTraceToLog ( const ELogVerbosity::Type LogVerbosity
)

 Dumps the stack trace into the log, meant to be used for debugging purposes.
Public function Static void

DumpStackTraceToLog ( const TCHAR* Heading,
const ELogVerbosity::Type LogVerbosity
)

 Dumps the stack trace into the log with a custom heading, meant to be used for debugging purposes.
Public function Static *staticvoid

EnsureFailed ( const ANSICHAR* Expr,
const ANSICHAR* File,
int32 Line,
void* ProgramCounter,
const TCHAR* Msg
)

 Called when an 'ensure' assertion fails; gathers stack data and generates and error report.
Public function Static SIZE_T Returns the number of times an ensure has failed in this instance.
Public function Static bool Returns true if an assert has occurred
Public function Static bool Returns true if an ensure is currently in progress (e.g. the RenderThread is ensuring)
Public function Static void

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

 Logs an a message to the provided log channel.
Public function Static bool

OptionallyLogFormattedEnsureMessageReturningFalse ( bool bLog,
const ANSICHAR* Expr,
const ANSICHAR* File,
int32 Line,
void* ProgramCounter,
const FmtType& FormattedMsg,
Types... Args
)

 Logs an error if bLog is true, and returns false.
Public function Static bool

OptionallyLogFormattedEnsureMessageReturningFalse ( bool bLog,
const ANSICHAR* Expr,
const ANSICHAR* File,
int32 Line,
void* ProgramCounter,
const TCHAR* FormattedMsg,
va_list Args
)

  
Public function Static void

ProcessFatalError ( void* ProgramCounter
)

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page