NUTDebug

General debug functions

Windows
MacOS
Linux

References

Module

NetcodeUnitTest

Header

/Engine/Plugins/NetcodeUnitTest/NetcodeUnitTest/Source/NetcodeUnitTest/Public/NUTUtilDebug.h

Include

#include "NUTUtilDebug.h"

Syntax

struct NUTDebug

Remarks

General debug functions

Functions

Name Description

Public function Static

FString

 

BitDump

(
    const TArray< uint8 >& InBytes,
    bool bDumpOffset,
    bool bLSBFirst
)

Takes an array of bytes, and generates a bit-based/binary dump string out of them, optionally including byte offsets also (intended for debugging in the log window)

Public function Static

FString

 

BitDump

(
    const FString& InString,
    bool bDumpOffset,
    bool bLSBFirst
)

Version of the above bit-dump function, which takes a string as input

Public function Static

FString

 

BitDump

(
    const uint8* InBytes,
    const uint32 InBytesLen,
    bool bDumpOffset,
    bool bLSBFirst
)

Version of the above bit-dump function, which takes a byte pointer and length as input

Public function Static

FString

 

HexDump

(
    const TArray< uint8 >& InBytes,
    bool bDumpASCII,
    bool bDumpOffset
)

Takes an array of bytes, and generates a hex dump string out of them, optionally including an ASCII dump and dumping byte offsets also (intended for debugging in the log window)

Public function Static

FString

 

HexDump

(
    const FString& InString,
    bool bDumpASCII,
    bool bDumpOffset
)

Version of the above hex-dump function, which takes a string as input

Public function Static

FString

 

HexDump

(
    const uint8* InBytes,
    const uint32 InBytesLen,
    bool bDumpASCII,
    bool bDumpOffset
)

Version of the above hex-dump function, which takes a byte pointer and length as input

Public function Static

void

 

LogBitDump

(
    const TArray< uint8 >& InBytes,
    bool bDumpOffset,
    bool bLSBFirst,
    FOutputDevice* OutLog
)

Version of the above bit-dump function, which dumps in a format more friendly/readable in log text files

Public function Static

void

 

LogBitDump

(
    const FString& InString,
    bool bDumpOffset,
    bool bLSBFirst,
    FOutputDevice* OutLog
)

Version of the above, which takes a string as input

Public function Static

void

 

LogBitDump

(
    const uint8* InBytes,
    const uint32 InBytesLen,
    bool bDumpOffset,
    bool bLSBFirst,
    FOutputDevice* OutLog
)

Version of the above bit-dump logging function, which takes a byte pointer and length as input

Public function Static

void

 

LogHexDump

(
    const TArray< uint8 >& InBytes,
    bool bDumpASCII,
    bool bDumpOffset,
    FOutputDevice* OutLog
)

Version of the above hex-dump function, which dumps in a format more friendly/readable in log text files

Public function Static

void

 

LogHexDump

(
    const FString& InString,
    bool bDumpASCII,
    bool bDumpOffset,
    FOutputDevice* OutLog
)

Version of the above, which takes a string as input

Public function Static

void

 

LogHexDump

(
    const uint8* InBytes,
    const uint32 InBytesLen,
    bool bDumpASCII,
    bool bDumpOffset,
    FOutputDevice* OutLog
)

Version of the above hex-dump logging function, which takes a byte pointer and length as input

Public function Static

void

 

StringToBytes

(
    const FString& InString,
    TArray< uint8 >& OutBytes
)

Quick conversion of a string to a hex-dumpable byte array

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss