Language:
Discover
By Skill Level
By Category

FPipelineFileCache

Choose your OS:

Syntax

class FPipelineFileCache

Remarks

FPipelineFileCache : The RHI-level backend for FShaderPipelineCache , responsible for tracking PSOs and their usage stats as well as dealing with the pipeline cache files. It is not expected that games or end-users invoke this directly, they should be calling FShaderPipelineCache which exposes this functionality in a usable form.

Functions

Name Description

Public function Static

void

 

CacheComputePSO

(
    uint32 RunTimeHash,
    FRHIComputeShader const* Initi...
)

Public function Static

void

 

CacheGraphicsPSO

(
    uint32 RunTimeHash,
    FGraphicsPipelineStateInitializer c...
)

Public function Static

void

 

ClosePipelineFileCache()

Public function Static

void

 

FetchPSODescriptors

Public function Static

void

 

GetOrderedPSOHashes

(
    TArray < FPipelineCachePSOHeader >&...,
    PSOOrder Order
)

Public function Static

void

 

Initialize

(
    uint32 GameVersion
)

Public function Static

bool

 

IsPipelineFileCacheEnabled()

Public function Static

bool

 

LoadPipelineFileCacheInto

(
    FString const& Path,
    TSet < FPipelineCacheFileFormatPSO >...
)

Public function Static

bool

 

LogPSOtoFileCache()

Public function Static

bool

 

MergePipelineFileCaches

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

Public function Static

uint32

 

NumPSOsLogged()

Public function Static

FPipelineSta ...

 

OnPipelineStateLogged()

Gets the event delegate to register for pipeline state logging events.

Public function Static

bool

 

OpenPipelineFileCache

(
    FString const& Name,
    EShaderPlatform Platform,
    FGuid & OutGameFileGuid
)

Open the pipeline file cache for the specfied name and platform.

Public function Static

FPipelineSta ...

 

RegisterPSOStats

(
    uint32 RunTimeHash
)

Public function Static

bool

 

ReportNewPSOs()

Public function Static

bool

 

SavePipelineFileCache

(
    FString const& Name,
    SaveMode Mode
)

Public function Static

bool

 

SavePipelineFileCacheFrom

(
    uint32 GameVersion,
    EShaderPlatform Platform,
    FString const& Path,
    const TSet < FPipelineCacheFileForma ...
)

Public function Static

void

 

Shutdown()

Enums

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

References

Module

RHI

Header

Runtime/RHI/Public/PipelineFileCache.h