1. Epic GamesDeveloper
  3. FDebugName

FDebugName

Support platforms which require indirect dispatch arguments to not cross memory boundaries.

API > API/Runtime > API/Runtime/RHI

A type used only for printing a string for debugging/profiling. Adds Number as a suffix to the printed string even if the base name includes a number, so may prints a string like: Base_1_1 This type will always store a numeric suffix explicitly inside itself and never in the name table so it will always be at least 12 bytes regardless of the value of UE_FNAME_OUTLINE_NUMBER. It is not comparable or convertible to other name types to encourage its use only for debugging and avoid using more storage than necessary for the primary use cases of FName (names of objects, assets etc which are widely used and therefor deduped in the name table).

   
Name FDebugName
Type class
Header File /Engine/Source/Runtime/RHI/Public/RHIDefinitions.h
Include Path #include "RHIDefinitions.h"

Syntax

class FDebugName

Constructors

Name Remarks Include Path Unreal Specifiers
  RHIDefinitions.h  

FDebugName ( FName InName
)

   RHIDefinitions.h  

FDebugName ( FName InName,
int32 InNumber
)

   RHIDefinitions.h  

Constants

Name Type Remarks Include Path
StringBufferSize uint32 Buffer size required for any null-terminated FDebugName string, i.e. [name] '_' [digits] '\0'. RHIDefinitions.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
const uint32 OutSize   RHIDefinitions.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
Name FName   RHIDefinitions.h  
Number uint32   RHIDefinitions.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AppendString ( FStringBuilderBase& Builder
) const

   RHIDefinitions.h  

bool IsNone()

   RHIDefinitions.h  

FString ToString ()

   RHIDefinitions.h  

uint32 ToString ( TCHAR(&) Out
) const

 Converts the FDebugName to a string buffer, avoiding dynamic allocations. RHIDefinitions.h  

return ToStringInternal ( Out,
OutSize
)

   RHIDefinitions.h  

uint32 ToStringTruncate ( TCHAR(&) Out
) const

 Converts the FDebugName to a string buffer, avoiding dynamic allocations. RHIDefinitions.h  

Operators

Name Remarks Include Path Unreal Specifiers

FDebugName & operator= ( FName Other
)

   RHIDefinitions.h  

Deprecated Functions

Name Remarks Include Path Unreal Specifiers

UE_DEPRECATED (

  1. 6,
    "FDebugName::ToString(TCHAR* Out, uint32 OutSize) is dangerous and can lead to buffer overflow i...,
    even if the OutSize parameter indicates the buffer is " "smaller than this value. Use the templated ...,
    or use the allocating ToString() function that returns an FString."
    )
   RHIDefinitions.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page