UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
StringConv Namespace Reference

Functions

bool IsValidCodepoint (const uint32 Codepoint)
 
UE_FORCEINLINE_HINT bool IsHighSurrogate (const uint32 Codepoint)
 
UE_FORCEINLINE_HINT bool IsLowSurrogate (const uint32 Codepoint)
 
UE_FORCEINLINE_HINT uint32 EncodeSurrogate (const uint16 HighSurrogate, const uint16 LowSurrogate)
 
void DecodeSurrogate (const uint32 Codepoint, uint16 &OutHighSurrogate, uint16 &OutLowSurrogate)
 
UE_FORCEINLINE_HINT bool IsEncodedSurrogate (const uint32 Codepoint)
 
template<typename CharType >
int32 InlineCombineSurrogates_Buffer (CharType *StrBuffer, int32 StrLen)
 
template<typename AllocatorType >
void InlineCombineSurrogates_Array (TArray< TCHAR, AllocatorType > &StrBuffer)
 
template<typename ConverterType >
ConverterType::LegacyFromType GetLegacyFromType (typename ConverterType::LegacyFromType *)
 
template<typename ConverterType >
FUnused GetLegacyFromType (...)
 
CORE_API void InlineCombineSurrogates (FString &Str)
 

Function Documentation

◆ DecodeSurrogate()

void StringConv::DecodeSurrogate ( const uint32  Codepoint,
uint16 OutHighSurrogate,
uint16 OutLowSurrogate 
)
inline

◆ EncodeSurrogate()

UE_FORCEINLINE_HINT uint32 StringConv::EncodeSurrogate ( const uint16  HighSurrogate,
const uint16  LowSurrogate 
)

◆ GetLegacyFromType() [1/2]

template<typename ConverterType >
FUnused StringConv::GetLegacyFromType (   ...)

◆ GetLegacyFromType() [2/2]

template<typename ConverterType >
ConverterType::LegacyFromType StringConv::GetLegacyFromType ( typename ConverterType::LegacyFromType *  )

◆ InlineCombineSurrogates()

void StringConv::InlineCombineSurrogates ( FString &  Str)

Inline combine any UTF-16 surrogate pairs in the given string

◆ InlineCombineSurrogates_Array()

template<typename AllocatorType >
void StringConv::InlineCombineSurrogates_Array ( TArray< TCHAR, AllocatorType > &  StrBuffer)
inline

Inline combine any UTF-16 surrogate pairs in the given null-terminated TCHAR array

◆ InlineCombineSurrogates_Buffer()

template<typename CharType >
int32 StringConv::InlineCombineSurrogates_Buffer ( CharType *  StrBuffer,
int32  StrLen 
)
inline

Inline combine any UTF-16 surrogate pairs in the given null-terminated character buffer, returning the updated length

◆ IsEncodedSurrogate()

UE_FORCEINLINE_HINT bool StringConv::IsEncodedSurrogate ( const uint32  Codepoint)

Is the provided Codepoint outside of the range of the basic multilingual plane, but within the valid range of UTF8/16?

◆ IsHighSurrogate()

UE_FORCEINLINE_HINT bool StringConv::IsHighSurrogate ( const uint32  Codepoint)

Is the provided Codepoint within the range of the high-surrogates?

◆ IsLowSurrogate()

UE_FORCEINLINE_HINT bool StringConv::IsLowSurrogate ( const uint32  Codepoint)

Is the provided Codepoint within the range of the low-surrogates?

◆ IsValidCodepoint()

bool StringConv::IsValidCodepoint ( const uint32  Codepoint)
inline

Is the provided Codepoint within the range of valid codepoints?