1. Epic GamesDeveloper
  3. FPipelineFileCacheManager

FPipelineFileCacheManager

API > API/Runtime > API/Runtime/RHI

References

   
Module RHI
Header /Engine/Source/Runtime/RHI/Public/PipelineFileCache.h
Include #include "PipelineFileCache.h"

Syntax

class FPipelineFileCacheManager

Functions

  Type Name Description
Public function Static void

CacheComputePSO ( uint32 RunTimeHash,
FRHIComputeShader const* Initializer
)

  
Public function Static void

CacheGraphicsPSO ( uint32 RunTimeHash,
FGraphicsPipelineStateInitializer const& Initializer,
bool bWasPSOPrecached
)

  
Public function Static void

CacheRayTracingPSO ( const FRayTracingPipelineStateInitializer& Initializer,
ERayTracingPipelineCacheFlags Flags
)

  
Public function Static void  
Public function Static void  
Public function Static uint64  
Public function Static void

GetOrderedPSOHashes ( const FString& PSOCacheKey,
TArray< FPipelineCachePSOHeader >& PSOHashes,
PSOOrder Order,
int64 MinBindCount,
TSet< uint32 > const& AlreadyCompiledHashes
)

  
Public function Static int32

GetTotalPSOCount ( const FString& PSOCacheKey
)

  
Public function Static bool

HasPipelineFileCache ( const FString& PSOCacheKey
)

 True if the named PSOFC is currently open.
Public function Static void

Initialize ( uint32 GameVersion
)

  
Public function Static bool  
Public function Static bool  
Public function Static bool  
Public function Static bool Report additional data about new PSOs to the log.
Public function Static bool  
Public function Static bool

MergePipelineFileCaches ( FString const& PathA,
FString const& PathB,
FPipelineFileCacheManager::PSOOrder Order,
FString const& OutputPath
)

  
Public function Static uint32  
Public function Static FPipelineStateLoggedEvent & Gets the event delegate to register for pipeline state logging events.
Public function Static bool

OpenPipelineFileCache ( const FString& Key,
const FString& CacheName,
EShaderPlatform Platform,
FGuid& OutGameFileGuid
)

 Open the pipeline file cache for the specfied name and platform.
Public function Static bool

OpenUserPipelineFileCache ( const FString& Key,
const FString& CacheName,
EShaderPlatform Platform,
FGuid& OutGameFileGuid
)

 Open the user pipeline file cache for the specified name and platform.
Public function Static void  
Public function Static void

RegisterPSOCompileFailure ( uint32 RunTimeHash,
FGraphicsPipelineStateInitializer const& Initializer
)

 This PSO has failed compile and is invalid - this cache should not return this invalid PSO from subsequent calls for PreCompile requests.
Public function Static FPipelineStateStats *

RegisterPSOStats ( uint32 RunTimeHash
)

  
Public function Static bool  
Public function Static bool  
Public function Static bool

SavePipelineFileCacheFrom ( uint32 GameVersion,
EShaderPlatform Platform,
FString const& Path,
const TSet< FPipelineCacheFileFormatPSO >& PSOs
)

  
Public function Static uint64

SetGameUsageMaskWithComparison ( uint64 GameUsageMask,
FPSOMaskComparisonFn InComparisonFnPtr
)

 Define the Current Game Usage Mask and a comparison function to compare this mask against the recorded mask in each PSO
Public function Static void

SetNewPSOConsoleAndCSVLogging ( bool bEnabled
)

 Enable or disable the logging of new PSOs (PSOs that were needed but not found in the file cache) to console and CSV.
Public function Static void  

Enums

  Type Name Description
Public enum PSOOrder    
Public enum SaveMode    

Typedefs

Name Description
FPipelineStateLoggedEvent Event signature for being notified that a new PSO has been logged

Constants

Name Description
FileCacheEnabled  
FileCacheLock  
FileCacheMap Containers for the multiple bundled PSOFCs Name to PipelineCacheFile
GameGuidToCacheKey PipelineCacheFile GUID to Name.
GameUsageMask  
GameUsageMaskSet  
LogNewPSOsToConsoleAndCSV  
MaskComparisonFn  
NewPSOHashes  
NewPSOs  
NewPSOUsage  
NumNewPSOs  
PSOLoggedEvent  
RequestedOrder  
RunTimeToPSOUsage PSO recording.
Stats  
UserCacheKey User cache's key within FileCacheMap.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page