UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::ShaderUtils::FShaderStableKeyDebugInfoReader Class Reference

#include <ShaderStableKeyDebugInfoReader.h>

Public Member Functions

bool IsInitialized () const
 
bool Initialize (const FString &ShaderStableKeyFile)
 
FString GetShaderStableNameOptions (const FSHAHash &ShaderHash, int32 MaxOptionsToInclude=16)
 
FString GetPSOStableNameOptions (const FGraphicsPipelineStateInitializer &Initializer, int32 MaxOptionsToInclude=16)
 
void DumpPSOToLogIfConfigured (const FGraphicsPipelineStateInitializer &Initializer)
 

Detailed Description

Class that uses build metadata (*.shk files storing mapping of stable shader keys to their hashes) to provide high level info on shaders and PSOs.

Member Function Documentation

◆ DumpPSOToLogIfConfigured()

void UE::ShaderUtils::FShaderStableKeyDebugInfoReader::DumpPSOToLogIfConfigured ( const FGraphicsPipelineStateInitializer Initializer)

Prints a pipeline info to log if configured to do so.

◆ GetPSOStableNameOptions()

FString UE::ShaderUtils::FShaderStableKeyDebugInfoReader::GetPSOStableNameOptions ( const FGraphicsPipelineStateInitializer Initializer,
int32  MaxOptionsToInclude = 16 
)

Returns a string describing a PSO (shaders only). Because of shader deduplication there can be several multiple (thousands) possible options.

◆ GetShaderStableNameOptions()

FString UE::ShaderUtils::FShaderStableKeyDebugInfoReader::GetShaderStableNameOptions ( const FSHAHash ShaderHash,
int32  MaxOptionsToInclude = 16 
)

Returns a string describing a shader. Because of shader deduplication there can be several multiple (thousands) possible options

◆ Initialize()

bool UE::ShaderUtils::FShaderStableKeyDebugInfoReader::Initialize ( const FString &  ShaderStableKeyFile)

Initializes the class with a pointer to directory holding SHK files

◆ IsInitialized()

bool UE::ShaderUtils::FShaderStableKeyDebugInfoReader::IsInitialized ( ) const
inline

Whether the info reader is usable


The documentation for this class was generated from the following files: