FImgMediaGlobalCache | Unreal Engine 5.7 Documentation

A global cache for all ImgMedia players.

Uses Least Recently Used (LRU).


Name	FImgMediaGlobalCache
Type	class
Header File	/Engine/Plugins/Media/ImgMedia/Source/ImgMedia/Public/ImgMediaGlobalCache.h
Include Path	#include "ImgMediaGlobalCache.h"

Syntax

class FImgMediaGlobalCache : public TSharedFromThis< FImgMediaGlobalCache, ESPMode::ThreadSafe >

Name	Remarks	Include Path	Unreal Specifiers
FImgMediaGlobalCache()	Constructor.	ImgMediaGlobalCache.h

Name	Remarks	Include Path	Unreal Specifiers
~FImgMediaGlobalCache()	Desctructor.	ImgMediaGlobalCache.h

Name	Remarks
FImgMediaGlobalCacheEntry	An entry in the cache.

Name	Type	Remarks	Include Path
CriticalSection	FCriticalSection	Critical section for synchronizing access to Frames.	ImgMediaGlobalCache.h
CurrentSize	SIZE_T	Current size of the cache in bytes.	ImgMediaGlobalCache.h
LeastRecent	FImgMediaGlobalCacheEntry *	Entry that was used first.	ImgMediaGlobalCache.h
MapFileToIndex	TMap< FString, int32 >	Maps a file name to the index of that file in the sequence.	ImgMediaGlobalCache.h
MapFrameToEntry	TMap< TPair< FName, int32 >, FImgMediaGlobalCacheEntry * >	Maps a sequence name and frame index to an entry in the cache.	ImgMediaGlobalCache.h
MapLeastRecentToSequence	TMap< FImgMediaGlobalCacheEntry *, FName >	Maps a cache entry that is the least recent entry to the name of its sequence.	ImgMediaGlobalCache.h
MapSequenceToMostRecentEntry	TMap< FName, FImgMediaGlobalCacheEntry * >	Maps a sequence name to the most recent cache entry of that sequence.	ImgMediaGlobalCache.h
MapSequenceToWatcher	TMap< FString, FDelegateHandle >	Maps a sequence directory to a directory watcher.	ImgMediaGlobalCache.h
MaxSize	SIZE_T	Maximum size of the cache in bytes.	ImgMediaGlobalCache.h
MostRecent	FImgMediaGlobalCacheEntry *	Entry that was used last.	ImgMediaGlobalCache.h
UpdateSettingsDelegateHandle	FDelegateHandle	Handle to registered UpdateSettings delegate.	ImgMediaGlobalCache.h

Name	Remarks	Include Path
void AddFrame ( const FString& FileName, const FName& Sequence, int32 Index, const TSharedPtr< FImgMediaFrame, ESPMode::ThreadSafe >& Frame, bool bAdjustSizeForMipMaps )	Adds a frame to the cache.	ImgMediaGlobalCache.h
bool Contains ( const FName& Sequence, int32 Index )	Check whether the entry with the specified sequence and index is present.	ImgMediaGlobalCache.h
void EmptyCache()	Empties the cache.	ImgMediaGlobalCache.h
TSharedPtr< FImgMediaFrame, ESPMode::ThreadSafe > * FindAndTouch ( const FName& Sequence, int32 Index )	Find the entry with the specified sequence and index and mark it as the most recently used.	ImgMediaGlobalCache.h
SIZE_T GetCurrentSize()	Get the current size (in bytess).	ImgMediaGlobalCache.h
void GetIndices ( const FName& Sequence, TArray< int32 >& OutIndices ) const	Find the indices of all cached entries of a particular sequence.	ImgMediaGlobalCache.h
SIZE_T GetMaxSize()	Get the maximum size (in bytes).	ImgMediaGlobalCache.h
void Initialize()	Initialize the cache.	ImgMediaGlobalCache.h
void Shutdown()	Shut down the cache.	ImgMediaGlobalCache.h