UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FShaderLibraryInstance Class Reference

Public Member Functions

 ~FShaderLibraryInstance ()
 
EShaderPlatform GetPlatform () const
 
const int32 GetNumResources () const
 
const int32 GetNumShaders () const
 
uint32 GetSizeBytes ()
 
uint32 GetShaderMapsSizeBytes ()
 
const int32 GetNumShadersForShaderMap (int32 ShaderMapIndex) const
 
void PreloadShader (int32 ShaderIndex, FArchive *Ar)
 
void PreloadShader (int32 ShaderIndex, FGraphEventArray &OutCompletionEvents)
 
void ReleasePreloadedShader (int32 ShaderIndex)
 
TRefCountPtr< FShaderMapResource_SharedCodeGetResource (int32 ShaderMapIndex)
 
TRefCountPtr< FShaderMapResource_SharedCodeAddResource (int32 ShaderMapIndex, FArchive *Ar)
 
bool TryRemoveResource (FShaderMapResource_SharedCode *Resource)
 
TRefCountPtr< FRHIShaderGetOrCreateShader (int32 ShaderIndex, bool bRequired=true)
 
void ReleaseShader (int32 ShaderIndex)
 
void ReleasePreloadedShaderIfNecessary (int32 ShaderIndex)
 
void PreloadPackageShaderMap (int32 ShaderMapIndex, FCoreDelegates::FAttachShaderReadRequestFunc AttachShaderReadRequestFunc)
 
void ReleasePreloadedPackageShaderMap (int32 ShaderMapIndex)
 
bool HasContentFrom (const FString &ShaderCodeDir, FString const &InLibraryName)
 

Static Public Member Functions

static FShaderLibraryInstanceCreate (EShaderPlatform InShaderPlatform, const FString &ShaderCodeDir, FString const &InLibraryName)
 

Public Attributes

FRHIShaderLibraryRef Library
 

Constructor & Destructor Documentation

◆ ~FShaderLibraryInstance()

FShaderLibraryInstance::~FShaderLibraryInstance ( )
inline

Member Function Documentation

◆ AddResource()

TRefCountPtr< FShaderMapResource_SharedCode > FShaderLibraryInstance::AddResource ( int32  ShaderMapIndex,
FArchive Ar 
)
inline

◆ Create()

static FShaderLibraryInstance * FShaderLibraryInstance::Create ( EShaderPlatform  InShaderPlatform,
const FString &  ShaderCodeDir,
FString const &  InLibraryName 
)
inlinestatic

◆ GetNumResources()

const int32 FShaderLibraryInstance::GetNumResources ( ) const
inline

◆ GetNumShaders()

const int32 FShaderLibraryInstance::GetNumShaders ( ) const
inline

◆ GetNumShadersForShaderMap()

const int32 FShaderLibraryInstance::GetNumShadersForShaderMap ( int32  ShaderMapIndex) const
inline

◆ GetOrCreateShader()

TRefCountPtr< FRHIShader > FShaderLibraryInstance::GetOrCreateShader ( int32  ShaderIndex,
bool  bRequired = true 
)
inline

◆ GetPlatform()

EShaderPlatform FShaderLibraryInstance::GetPlatform ( ) const
inline

◆ GetResource()

TRefCountPtr< FShaderMapResource_SharedCode > FShaderLibraryInstance::GetResource ( int32  ShaderMapIndex)
inline

◆ GetShaderMapsSizeBytes()

uint32 FShaderLibraryInstance::GetShaderMapsSizeBytes ( )
inline

◆ GetSizeBytes()

uint32 FShaderLibraryInstance::GetSizeBytes ( )
inline

◆ HasContentFrom()

bool FShaderLibraryInstance::HasContentFrom ( const FString &  ShaderCodeDir,
FString const &  InLibraryName 
)
inline

◆ PreloadPackageShaderMap()

void FShaderLibraryInstance::PreloadPackageShaderMap ( int32  ShaderMapIndex,
FCoreDelegates::FAttachShaderReadRequestFunc  AttachShaderReadRequestFunc 
)
inline

◆ PreloadShader() [1/2]

void FShaderLibraryInstance::PreloadShader ( int32  ShaderIndex,
FArchive Ar 
)
inline

◆ PreloadShader() [2/2]

void FShaderLibraryInstance::PreloadShader ( int32  ShaderIndex,
FGraphEventArray OutCompletionEvents 
)
inline

◆ ReleasePreloadedPackageShaderMap()

void FShaderLibraryInstance::ReleasePreloadedPackageShaderMap ( int32  ShaderMapIndex)
inline

◆ ReleasePreloadedShader()

void FShaderLibraryInstance::ReleasePreloadedShader ( int32  ShaderIndex)
inline

◆ ReleasePreloadedShaderIfNecessary()

void FShaderLibraryInstance::ReleasePreloadedShaderIfNecessary ( int32  ShaderIndex)
inline

◆ ReleaseShader()

void FShaderLibraryInstance::ReleaseShader ( int32  ShaderIndex)
inline

◆ TryRemoveResource()

bool FShaderLibraryInstance::TryRemoveResource ( FShaderMapResource_SharedCode Resource)
inline

Member Data Documentation

◆ Library

FRHIShaderLibraryRef FShaderLibraryInstance::Library

The documentation for this class was generated from the following file: