RAMSES Documentation  27.0.130
Information for RAMSES users and developers
Functions
ramses::UtfUtils Namespace Reference

Converts UTF and Unicode according to the Unicode standard. More...

Functions

RAMSES_API std::u32string ConvertUtf8ToUtf32 (const std::string &utf8String)
 Converts a UTF8-encoded string to UTF32-encoded string. More...
 
RAMSES_API std::string ConvertCharUtf32ToUtf8 (char32_t convertChar)
 Converts a UTF32-encoded character to UTF8-encoded string. More...
 
RAMSES_API std::string ConvertStrUtf32ToUtf8 (const std::u32string &utf32String)
 Converts a UTF32-encoded string to UTF8-encoded string. More...
 
RAMSES_API ExtractedUnicodePoint ExtractUnicodePointFromUTF8 (std::string::const_iterator strBegin, std::string::const_iterator strEnd)
 Extracts a UTF32 character from a UTF8 string. More...
 
RAMSES_API std::string ConvertUtf32ToUtf8String (const std::u32string &utf32String)
 Converts a UTF32-encoded string to UTF8-encoded string. More...
 
RAMSES_API ExtractedUnicodePoint ExtractUnicodePointFromUTF16 (std::u16string::const_iterator strBegin, std::u16string::const_iterator strEnd)
 Extracts a UTF32 character from a UTF16 string. More...
 

Detailed Description

Converts UTF and Unicode according to the Unicode standard.

Function Documentation

◆ ConvertCharUtf32ToUtf8()

RAMSES_API std::string ramses::UtfUtils::ConvertCharUtf32ToUtf8 ( char32_t  convertChar)

Converts a UTF32-encoded character to UTF8-encoded string.

Parameters
[in]convertCharThe character in UTF32 encoding
Returns
The string in UTF8 encoding

◆ ConvertStrUtf32ToUtf8()

RAMSES_API std::string ramses::UtfUtils::ConvertStrUtf32ToUtf8 ( const std::u32string &  utf32String)

Converts a UTF32-encoded string to UTF8-encoded string.

Parameters
[in]utf32StringThe string in UTF32 encoding
Returns
The string in UTF8 encoding

◆ ConvertUtf32ToUtf8String()

RAMSES_API std::string ramses::UtfUtils::ConvertUtf32ToUtf8String ( const std::u32string &  utf32String)

Converts a UTF32-encoded string to UTF8-encoded string.

Parameters
[in]utf32StringThe string in UTF32 encoding
Returns
The string in UTF8 encoding

◆ ConvertUtf8ToUtf32()

RAMSES_API std::u32string ramses::UtfUtils::ConvertUtf8ToUtf32 ( const std::string &  utf8String)

Converts a UTF8-encoded string to UTF32-encoded string.

Parameters
[in]utf8StringThe string in UTF8 encoding
Returns
The string in UTF32 encoding

◆ ExtractUnicodePointFromUTF16()

RAMSES_API ExtractedUnicodePoint ramses::UtfUtils::ExtractUnicodePointFromUTF16 ( std::u16string::const_iterator  strBegin,
std::u16string::const_iterator  strEnd 
)

Extracts a UTF32 character from a UTF16 string.

Parameters
[in]strBeginiterator to the first character to parse
[in]strEndthe end of the string - used for sanity check and prevent reading beyond the end of the string
Returns
The extracted unicode point

◆ ExtractUnicodePointFromUTF8()

RAMSES_API ExtractedUnicodePoint ramses::UtfUtils::ExtractUnicodePointFromUTF8 ( std::string::const_iterator  strBegin,
std::string::const_iterator  strEnd 
)

Extracts a UTF32 character from a UTF8 string.

Parameters
[in]strBeginiterator to the first character to parse
[in]strEndthe end of the string - used for sanity check and prevent reading beyond the end of the string
Returns
The extracted unicode point