FShaderCodeArchive

Implements [FRHIShaderLibrary](API\Runtime\RHI\FRHIShaderLibrary) and reads shader code from a single file cache handle.

API > API/Runtime > API/Runtime/RenderCore

Implements FRHIShaderLibrary and reads shader code from a single file cache handle.

   
Name FShaderCodeArchive
Type class
Header File /Engine/Source/Runtime/RenderCore/Public/ShaderCodeArchive.h
Include Path #include "ShaderCodeArchive.h"

Syntax

class FShaderCodeArchive : public FRHIShaderLibrary

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FShaderCodeArchive ( EShaderPlatform InPlatform,
const FString& InLibraryDir,
const FString& InLibraryName
)

   ShaderCodeArchive.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FShaderCodeArchive()

   ShaderCodeArchive.h  

Structs

Name Remarks
FShaderPreloadEntry  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void OnShaderPreloadFinished ( int32 ShaderIndex,
const IMemoryReadStreamRef& PreloadData
)

   ShaderCodeArchive.h  

Public Virtual

Overridden from FRHIShaderLibrary

Name Remarks Include Path Unreal Specifiers

virtual TRefCountPtr< FRHIShader > CreateShader ( int32 Index,
bool bRequired
)

   ShaderCodeArchive.h  

virtual int32 FindShaderIndex ( const FShaderHash& Hash
)

   ShaderCodeArchive.h  

virtual int32 FindShaderMapIndex ( const FShaderHash& Hash
)

   ShaderCodeArchive.h  

virtual void GetAllShaderIndices ( int32 ShaderMapIndex,
TArray< int32 >& OutShaderIndices
) const

   ShaderCodeArchive.h  

virtual int32 GetNumShaderMaps()

   ShaderCodeArchive.h  

virtual int32 GetNumShaders()

   ShaderCodeArchive.h  

virtual int32 GetNumShadersForShaderMap ( int32 ShaderMapIndex
) const

   ShaderCodeArchive.h  

virtual FShaderHash GetShaderHash ( int32 ShaderMapIndex,
int32 ShaderIndex
)

   ShaderCodeArchive.h  

virtual int32 GetShaderIndex ( int32 ShaderMapIndex,
int32 i
) const

   ShaderCodeArchive.h  

virtual FShaderHash GetShaderMapHash ( int32 ShaderMapIndex
) const

   ShaderCodeArchive.h  

virtual uint32 GetSizeBytes()

   ShaderCodeArchive.h  

virtual bool IsNativeLibrary()

   ShaderCodeArchive.h  

virtual bool PreloadShader ( int32 ShaderIndex,
FGraphEventArray& OutCompletionEvents
)

   ShaderCodeArchive.h  

virtual bool PreloadShaderMap ( int32 ShaderMapIndex,
FGraphEventArray& OutCompletionEvents
)

   ShaderCodeArchive.h  

virtual void ReleasePreloadedShader ( int32 ShaderIndex
)

   ShaderCodeArchive.h  

virtual void Teardown()

   ShaderCodeArchive.h  

Protected

Name Remarks Include Path Unreal Specifiers

void CheckShaderCreation ( void* ShaderPtr,
int32 Index
)

   ShaderCodeArchive.h  

bool WaitForPreload ( FShaderPreloadEntry& ShaderPreloadEntry
)

   ShaderCodeArchive.h  

Static

Name Remarks Include Path Unreal Specifiers

static FShaderCodeArchive * Create ( EShaderPlatform InPlatform,
FArchive& Ar,
const FString& InDestFilePath,
const FString& InLibraryDir,
const FString& InLibraryName
)

   ShaderCodeArchive.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page