UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
RHIStrings.cpp File Reference

Classes

struct  FRHIResourceTypeName
 

Macros

#define RHI_RESOURCE_TYPE_DEF(Name)   { RRT_##Name, TEXT(#Name) }
 

Functions

template<typename EnumType >
FString BuildEnumNameBitList (EnumType Value, const TCHAR *(*GetEnumName)(EnumType))
 
const TCHARRHIVendorIdToString ()
 
const TCHARRHIVendorIdToString (EGpuVendorId VendorId)
 
FString LexToString (EShaderPlatform Platform, bool bError)
 
FString LexToString (ERHIFeatureLevel::Type Level)
 
bool GetFeatureLevelFromName (const FString &Name, ERHIFeatureLevel::Type &OutFeatureLevel)
 
bool GetFeatureLevelFromName (FName Name, ERHIFeatureLevel::Type &OutFeatureLevel)
 
void GetFeatureLevelName (ERHIFeatureLevel::Type InFeatureLevel, FString &OutName)
 
void GetFeatureLevelName (ERHIFeatureLevel::Type InFeatureLevel, FName &OutName)
 
FName ShaderPlatformToPlatformName (EShaderPlatform Platform)
 
FName LegacyShaderPlatformToShaderFormat (EShaderPlatform Platform)
 
EShaderPlatform ShaderFormatToLegacyShaderPlatform (FName ShaderFormat)
 
const TCHARLexToString (ERHIDescriptorHeapType InHeapType)
 
bool GetShadingPathFromName (FName Name, ERHIShadingPath::Type &OutShadingPath)
 
void GetShadingPathName (ERHIShadingPath::Type InShadingPath, FString &OutName)
 
void GetShadingPathName (ERHIShadingPath::Type InShadingPath, FName &OutName)
 
FString GetBufferUsageFlagsName (EBufferUsageFlags BufferUsage)
 
FString GetTextureCreateFlagsName (ETextureCreateFlags TextureCreateFlags)
 
ERHIResourceType RHIResourceTypeFromString (const FString &InString)
 
const TCHARStringFromRHIResourceType (ERHIResourceType ResourceType)
 
FString GetRHIAccessName (ERHIAccess Access)
 
FString GetResourceTransitionFlagsName (EResourceTransitionFlags Flags)
 
FString GetRHIPipelineName (ERHIPipeline Pipeline)
 
const TCHARGetTextureDimensionString (ETextureDimension Dimension)
 
const TCHARGetTextureCreateFlagString (ETextureCreateFlags TextureCreateFlag)
 
const TCHARGetBufferUsageFlagString (EBufferUsageFlags BufferUsage)
 
const TCHARGetUniformBufferBaseTypeString (EUniformBufferBaseType BaseType)
 
const TCHARGetShaderCodeResourceBindingTypeName (EShaderCodeResourceBindingType BindingType)
 
bool GetBindlessConfigurationFromString (FStringView InString, ERHIBindlessConfiguration &OutBindlessConfiguration)
 
const TCHARGetBindlessConfigurationString (ERHIBindlessConfiguration InBindlessConfiguration)
 

Macro Definition Documentation

◆ RHI_RESOURCE_TYPE_DEF

#define RHI_RESOURCE_TYPE_DEF (   Name)    { RRT_##Name, TEXT(#Name) }

Function Documentation

◆ BuildEnumNameBitList()

template<typename EnumType >
FString BuildEnumNameBitList ( EnumType  Value,
const TCHAR *(*)(EnumType)  GetEnumName 
)
inline

◆ GetBindlessConfigurationFromString()

bool GetBindlessConfigurationFromString ( FStringView  InString,
ERHIBindlessConfiguration OutBindlessConfiguration 
)

Finds a corresponding ERHIBindlessConfiguration given a string, or returns false if one could not be found.

◆ GetBindlessConfigurationString()

const TCHAR * GetBindlessConfigurationString ( ERHIBindlessConfiguration  InBindlessConfiguration)

Get the string for the given BindlessConfiguration or return an empty string if invalid.

◆ GetBufferUsageFlagsName()

FString GetBufferUsageFlagsName ( EBufferUsageFlags  BufferUsage)

Returns a string of friendly name bits for the buffer usage flags enum.

◆ GetBufferUsageFlagString()

const TCHAR * GetBufferUsageFlagString ( EBufferUsageFlags  BufferUsage)

◆ GetFeatureLevelFromName() [1/2]

bool GetFeatureLevelFromName ( const FString &  Name,
ERHIFeatureLevel::Type OutFeatureLevel 
)

Finds a corresponding ERHIFeatureLevel::Type given a string, or returns false if one could not be found.

◆ GetFeatureLevelFromName() [2/2]

bool GetFeatureLevelFromName ( FName  Name,
ERHIFeatureLevel::Type OutFeatureLevel 
)

Finds a corresponding ERHIFeatureLevel::Type given an FName, or returns false if one could not be found.

◆ GetFeatureLevelName() [1/2]

void GetFeatureLevelName ( ERHIFeatureLevel::Type  InFeatureLevel,
FName OutName 
)

Creates an FName for the given feature level.

◆ GetFeatureLevelName() [2/2]

void GetFeatureLevelName ( ERHIFeatureLevel::Type  InFeatureLevel,
FString &  OutName 
)

Creates a string for the given feature level.

◆ GetResourceTransitionFlagsName()

FString GetResourceTransitionFlagsName ( EResourceTransitionFlags  Flags)

◆ GetRHIAccessName()

FString GetRHIAccessName ( ERHIAccess  Access)

◆ GetRHIPipelineName()

FString GetRHIPipelineName ( ERHIPipeline  Pipeline)

◆ GetShaderCodeResourceBindingTypeName()

const TCHAR * GetShaderCodeResourceBindingTypeName ( EShaderCodeResourceBindingType  BindingType)

◆ GetShadingPathFromName()

bool GetShadingPathFromName ( FName  Name,
ERHIShadingPath::Type OutShadingPath 
)

Finds a corresponding ERHIShadingPath::Type given an FName, or returns false if one could not be found.

◆ GetShadingPathName() [1/2]

void GetShadingPathName ( ERHIShadingPath::Type  InShadingPath,
FName OutName 
)

Creates an FName for the given shading path.

◆ GetShadingPathName() [2/2]

void GetShadingPathName ( ERHIShadingPath::Type  InShadingPath,
FString &  OutName 
)

Creates a string for the given shading path.

◆ GetTextureCreateFlagsName()

FString GetTextureCreateFlagsName ( ETextureCreateFlags  TextureCreateFlags)

Returns a string of friendly name bits for the texture create flags enum.

◆ GetTextureCreateFlagString()

const TCHAR * GetTextureCreateFlagString ( ETextureCreateFlags  TextureCreateFlag)

◆ GetTextureDimensionString()

const TCHAR * GetTextureDimensionString ( ETextureDimension  Dimension)

◆ GetUniformBufferBaseTypeString()

const TCHAR * GetUniformBufferBaseTypeString ( EUniformBufferBaseType  BaseType)

◆ LegacyShaderPlatformToShaderFormat()

FName LegacyShaderPlatformToShaderFormat ( EShaderPlatform  Platform)

◆ LexToString() [1/3]

const TCHAR * LexToString ( ERHIDescriptorHeapType  InHeapType)

Stringifies ERHIDescriptorHeapType

◆ LexToString() [2/3]

FString LexToString ( ERHIFeatureLevel::Type  Level)

Stringifies ERHIFeatureLevel

◆ LexToString() [3/3]

FString LexToString ( EShaderPlatform  Platform,
bool  bError = true 
)

Stringifies EShaderPlatform

◆ RHIResourceTypeFromString()

ERHIResourceType RHIResourceTypeFromString ( const FString &  InString)

◆ RHIVendorIdToString() [1/2]

const TCHAR * RHIVendorIdToString ( )

◆ RHIVendorIdToString() [2/2]

const TCHAR * RHIVendorIdToString ( EGpuVendorId  VendorId)

◆ ShaderFormatToLegacyShaderPlatform()

EShaderPlatform ShaderFormatToLegacyShaderPlatform ( FName  ShaderFormat)

◆ ShaderPlatformToPlatformName()

FName ShaderPlatformToPlatformName ( EShaderPlatform  Platform)

◆ StringFromRHIResourceType()

const TCHAR * StringFromRHIResourceType ( ERHIResourceType  ResourceType)

Returns a string of friendly name bits for the texture create flags enum.