UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
ICompressionFormat Struct Referenceabstract

#include <ICompressionFormat.h>

+ Inheritance diagram for ICompressionFormat:

Public Member Functions

virtual FName GetCompressionFormatName ()=0
 
virtual bool Compress (void *CompressedBuffer, int32 &CompressedSize, const void *UncompressedBuffer, int32 UncompressedSize, int32 CompressionData, ECompressionFlags Flags)
 
virtual bool Compress (void *CompressedBuffer, int64 &CompressedSize, const void *UncompressedBuffer, int64 UncompressedSize, uintptr_t CompressionData, ECompressionFlags Flags)
 
virtual bool Uncompress (void *UncompressedBuffer, int32 &UncompressedSize, const void *CompressedBuffer, int32 CompressedSize, int32 CompressionData)
 
virtual bool Uncompress (void *UncompressedBuffer, int64 UncompressedSize, const void *CompressedBuffer, int64 CompressedSize, uintptr_t CompressionData)
 
virtual int32 GetCompressedBufferSize (int32 UncompressedSize, int32 CompressionData)
 
virtual bool GetCompressedBufferSize (int64 &OutBufferSize, int64 UncompressedSize, uintptr_t CompressionData)
 
virtual uint32 GetVersion ()=0
 
virtual FString GetDDCKeySuffix ()=0
 
virtual bool DoesOwnWorthDecompressingCheck ()=0
 
- Public Member Functions inherited from IModuleInterface
virtual ~IModuleInterface ()
 
virtual void StartupModule ()
 
virtual void PreUnloadCallback ()
 
virtual void PostLoadCallback ()
 
virtual void ShutdownModule ()
 
virtual bool SupportsDynamicReloading ()
 
virtual bool SupportsAutomaticShutdown ()
 
virtual bool IsGameModule () const
 

Member Function Documentation

◆ Compress() [1/2]

virtual bool ICompressionFormat::Compress ( void CompressedBuffer,
int32 CompressedSize,
const void UncompressedBuffer,
int32  UncompressedSize,
int32  CompressionData,
ECompressionFlags  Flags 
)
inlinevirtual

◆ Compress() [2/2]

virtual bool ICompressionFormat::Compress ( void CompressedBuffer,
int64 CompressedSize,
const void UncompressedBuffer,
int64  UncompressedSize,
uintptr_t  CompressionData,
ECompressionFlags  Flags 
)
inlinevirtual

Reimplemented in FOodleDataCompressionFormat.

◆ DoesOwnWorthDecompressingCheck()

virtual bool ICompressionFormat::DoesOwnWorthDecompressingCheck ( )
pure virtual

Implemented in FOodleDataCompressionFormat.

◆ GetCompressedBufferSize() [1/2]

virtual int32 ICompressionFormat::GetCompressedBufferSize ( int32  UncompressedSize,
int32  CompressionData 
)
inlinevirtual

◆ GetCompressedBufferSize() [2/2]

virtual bool ICompressionFormat::GetCompressedBufferSize ( int64 OutBufferSize,
int64  UncompressedSize,
uintptr_t  CompressionData 
)
inlinevirtual

Reimplemented in FOodleDataCompressionFormat.

◆ GetCompressionFormatName()

virtual FName ICompressionFormat::GetCompressionFormatName ( )
pure virtual

Implemented in FOodleDataCompressionFormat.

◆ GetDDCKeySuffix()

virtual FString ICompressionFormat::GetDDCKeySuffix ( )
pure virtual

Implemented in FOodleDataCompressionFormat.

◆ GetVersion()

virtual uint32 ICompressionFormat::GetVersion ( )
pure virtual

Implemented in FOodleDataCompressionFormat.

◆ Uncompress() [1/2]

virtual bool ICompressionFormat::Uncompress ( void UncompressedBuffer,
int32 UncompressedSize,
const void CompressedBuffer,
int32  CompressedSize,
int32  CompressionData 
)
inlinevirtual

◆ Uncompress() [2/2]

virtual bool ICompressionFormat::Uncompress ( void UncompressedBuffer,
int64  UncompressedSize,
const void CompressedBuffer,
int64  CompressedSize,
uintptr_t  CompressionData 
)
inlinevirtual

Reimplemented in FOodleDataCompressionFormat.


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