UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
RHIStrings.h File Reference
#include "HAL/Platform.h"
#include "RHIDefinitions.h"

Go to the source code of this file.

Namespaces

namespace  ERHIFeatureLevel
 

Functions

RHI_API const TCHARRHIVendorIdToString ()
 
RHI_API const TCHARRHIVendorIdToString (EGpuVendorId VendorId)
 
RHI_API bool GetFeatureLevelFromName (const FString &Name, ERHIFeatureLevel::Type &OutFeatureLevel)
 
RHI_API bool GetFeatureLevelFromName (FName Name, ERHIFeatureLevel::Type &OutFeatureLevel)
 
RHI_API void GetFeatureLevelName (ERHIFeatureLevel::Type InFeatureLevel, FString &OutName)
 
RHI_API void GetFeatureLevelName (ERHIFeatureLevel::Type InFeatureLevel, FName &OutName)
 
RHI_API bool GetBindlessConfigurationFromString (FStringView InString, ERHIBindlessConfiguration &OutBindlessConfiguration)
 
RHI_API const TCHARGetBindlessConfigurationString (ERHIBindlessConfiguration InBindlessConfiguration)
 
RHI_API FString LexToString (ERHIFeatureLevel::Type Level)
 
RHI_API FName LegacyShaderPlatformToShaderFormat (EShaderPlatform Platform)
 
RHI_API EShaderPlatform ShaderFormatToLegacyShaderPlatform (FName ShaderFormat)
 
RHI_API FName ShaderPlatformToPlatformName (EShaderPlatform Platform)
 
RHI_API FString LexToString (EShaderPlatform Platform, bool bError=true)
 
RHI_API const TCHARLexToString (ERHIDescriptorHeapType InHeapType)
 
RHI_API bool GetShadingPathFromName (FName Name, ERHIShadingPath::Type &OutShadingPath)
 
RHI_API void GetShadingPathName (ERHIShadingPath::Type InShadingPath, FString &OutName)
 
RHI_API void GetShadingPathName (ERHIShadingPath::Type InShadingPath, FName &OutName)
 
RHI_API FString GetBufferUsageFlagsName (EBufferUsageFlags BufferUsage)
 
RHI_API FString GetTextureCreateFlagsName (ETextureCreateFlags TextureCreateFlags)
 
RHI_API const TCHARStringFromRHIResourceType (ERHIResourceType ResourceType)
 
RHI_API ERHIResourceType RHIResourceTypeFromString (const FString &InString)
 
RHI_API FString GetRHIAccessName (ERHIAccess Access)
 
RHI_API FString GetResourceTransitionFlagsName (EResourceTransitionFlags Flags)
 
RHI_API FString GetRHIPipelineName (ERHIPipeline Pipeline)
 
RHI_API const TCHARGetTextureDimensionString (ETextureDimension Dimension)
 
RHI_API const TCHARGetTextureCreateFlagString (ETextureCreateFlags TextureCreateFlag)
 
RHI_API const TCHARGetBufferUsageFlagString (EBufferUsageFlags BufferUsage)
 
RHI_API const TCHARGetUniformBufferBaseTypeString (EUniformBufferBaseType BaseType)
 
RHI_API const TCHARGetShaderCodeResourceBindingTypeName (EShaderCodeResourceBindingType BindingType)
 
const TCHARGetShaderFrequencyString (EShaderFrequency Frequency, bool bIncludePrefix=true)
 
const TCHARGetRenderQueryTypeName (ERenderQueryType QueryType)
 

Function Documentation

◆ GetBindlessConfigurationFromString()

RHI_API bool GetBindlessConfigurationFromString ( FStringView  InString,
ERHIBindlessConfiguration OutBindlessConfiguration 
)

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

◆ GetBindlessConfigurationString()

RHI_API const TCHAR * GetBindlessConfigurationString ( ERHIBindlessConfiguration  InBindlessConfiguration)

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

◆ GetBufferUsageFlagsName()

RHI_API FString GetBufferUsageFlagsName ( EBufferUsageFlags  BufferUsage)

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

◆ GetBufferUsageFlagString()

RHI_API const TCHAR * GetBufferUsageFlagString ( EBufferUsageFlags  BufferUsage)

◆ GetFeatureLevelFromName() [1/2]

RHI_API 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]

RHI_API 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]

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

Creates an FName for the given feature level.

◆ GetFeatureLevelName() [2/2]

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

Creates a string for the given feature level.

◆ GetRenderQueryTypeName()

const TCHAR * GetRenderQueryTypeName ( ERenderQueryType  QueryType)
inline

◆ GetResourceTransitionFlagsName()

RHI_API FString GetResourceTransitionFlagsName ( EResourceTransitionFlags  Flags)

◆ GetRHIAccessName()

RHI_API FString GetRHIAccessName ( ERHIAccess  Access)

◆ GetRHIPipelineName()

RHI_API FString GetRHIPipelineName ( ERHIPipeline  Pipeline)

◆ GetShaderCodeResourceBindingTypeName()

RHI_API const TCHAR * GetShaderCodeResourceBindingTypeName ( EShaderCodeResourceBindingType  BindingType)

◆ GetShaderFrequencyString()

const TCHAR * GetShaderFrequencyString ( EShaderFrequency  Frequency,
bool  bIncludePrefix = true 
)
inline

◆ GetShadingPathFromName()

RHI_API 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]

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

Creates an FName for the given shading path.

◆ GetShadingPathName() [2/2]

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

Creates a string for the given shading path.

◆ GetTextureCreateFlagsName()

RHI_API FString GetTextureCreateFlagsName ( ETextureCreateFlags  TextureCreateFlags)

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

◆ GetTextureCreateFlagString()

RHI_API const TCHAR * GetTextureCreateFlagString ( ETextureCreateFlags  TextureCreateFlag)

◆ GetTextureDimensionString()

RHI_API const TCHAR * GetTextureDimensionString ( ETextureDimension  Dimension)

◆ GetUniformBufferBaseTypeString()

RHI_API const TCHAR * GetUniformBufferBaseTypeString ( EUniformBufferBaseType  BaseType)

◆ LegacyShaderPlatformToShaderFormat()

RHI_API FName LegacyShaderPlatformToShaderFormat ( EShaderPlatform  Platform)

◆ LexToString() [1/3]

RHI_API const TCHAR * LexToString ( ERHIDescriptorHeapType  InHeapType)

Stringifies ERHIDescriptorHeapType

◆ LexToString() [2/3]

RHI_API FString LexToString ( ERHIFeatureLevel::Type  Level)

Stringifies ERHIFeatureLevel

◆ LexToString() [3/3]

RHI_API FString LexToString ( EShaderPlatform  Platform,
bool  bError = true 
)

Stringifies EShaderPlatform

◆ RHIResourceTypeFromString()

RHI_API ERHIResourceType RHIResourceTypeFromString ( const FString &  InString)

◆ RHIVendorIdToString() [1/2]

RHI_API const TCHAR * RHIVendorIdToString ( )

◆ RHIVendorIdToString() [2/2]

RHI_API const TCHAR * RHIVendorIdToString ( EGpuVendorId  VendorId)

◆ ShaderFormatToLegacyShaderPlatform()

RHI_API EShaderPlatform ShaderFormatToLegacyShaderPlatform ( FName  ShaderFormat)

◆ ShaderPlatformToPlatformName()

RHI_API FName ShaderPlatformToPlatformName ( EShaderPlatform  Platform)

◆ StringFromRHIResourceType()

RHI_API const TCHAR * StringFromRHIResourceType ( ERHIResourceType  ResourceType)

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