FPipelineFileCache

Windows
MacOS
Linux

References

Module

RHI

Header

/Engine/Source/Runtime/RHI/Public/PipelineFileCache.h

Include

#include "PipelineFileCache.h"

Syntax

class FPipelineFileCache

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

uint64

 

GetGameUsageMask()

Public function Static

void

 

GetOrderedPSOHashes

(
    TArray< FPipelineCachePSOHeader >&...,
    PSOOrder Order,
    int64 MinBindCount,
    TSet< uint32 > const& AlreadyCompi...
)

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

void

 

PreCompileComplete()

Public function Static

void

 

RegisterPSOCompileFailure

(
    uint32 RunTimeHash,
    FGraphicsPipelineStateInitializer c...
)

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

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

uint64

 

SetGameUsageMaskWithComparison

(
    uint64 GameUsageMask,
    FPSOMaskComparisonFn InComparisonFn...
)

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

 

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

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss