Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

FShaderCodeArchive

Windows

MacOS

Linux

Inheritance Hierarchy

FRHIResource

FRHIShaderLibrary

FShaderCodeArchive

References

Module	RenderCore
Header	/Engine/Source/Runtime/RenderCore/Public/ShaderCodeArchive.h
Include	#include "ShaderCodeArchive.h"

Syntax

class FShaderCodeArchive : public FRHIShaderLibrary

Variables

	Name	Description
IFileCacheHandl...	FileCacheHandle	Library file handle for async reads.
int64	LibraryCodeOffset	Offset at where shader code starts in a code library.
FString	LibraryDir	Library directory.
FSerializedShad...	SerializedShaders	The shader code present in the library.
TArray< FGraphE...	ShaderMapPreloadEvents
FRWLock	ShaderPreloadLock
TArray< FShader...	ShaderPreloads

Constructors

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

Destructors

	Name	Description
	~FShaderCodeArchive()

Functions

		Name	Description
	void	CheckShaderCreation ( void* ShaderPtr, int32 Index )
	FShaderCodeA...	Create ( EShaderPlatform InPlatform, FArchive& Ar, const FString& InDestFilePath, const FString& InLibraryDir, const FString& InLibraryName )
	uint32	GetSizeBytes()
	void	OnShaderPreloadFinished ( int32 ShaderIndex, const IMemoryReadStreamRef& Preloa... )
	bool	WaitForPreload ( FShaderPreloadEntry& ShaderPreload... )

Overridden from FRHIShaderLibrary

		Name	Description
	TRefCountPtr...	CreateShader ( int32 Index )
	int32	FindShaderIndex ( const FSHAHash& Hash )
	int32	FindShaderMapIndex ( const FSHAHash& Hash )
	int32	GetNumShaderMaps()
	int32	GetNumShaders()
	int32	GetNumShadersForShaderMap ( int32 ShaderMapIndex )
	int32	GetShaderIndex ( int32 ShaderMapIndex, int32 i )
	bool	IsNativeLibrary()
	bool	PreloadShader ( int32 ShaderIndex, FGraphEventArray& OutCompletionEve... )
	bool	PreloadShaderMap ( int32 ShaderMapIndex, FGraphEventArray& OutCompletionEve... )
	void	ReleasePreloadedShader ( int32 ShaderIndex )
	void	Teardown()

Classes

	Name	Description
	FShaderPreloadEntry

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

Take our survey

Dismiss