1. Epic GamesDeveloper
  3. FCompression

FCompression

API > API/Runtime > API/Runtime/Core > API/Runtime/Core/Misc

References

   
Module Core
Header /Engine/Source/Runtime/Core/Public/Misc/Compression.h
Include #include "Misc/Compression.h"

Syntax

struct FCompression

Functions

  Type Name Description
Public function Static bool

CompressMemory ( FName FormatName,
void* CompressedBuffer,
int32& CompressedSize,
const void* UncompressedBuffer,
int32 UncompressedSize,
ECompressionFlags Flags,
int32 CompressionData
)

 Thread-safe abstract compression routine.
Public function Static int32

CompressMemoryBound ( FName FormatName,
int32 UncompressedSize,
ECompressionFlags Flags,
int32 CompressionData
)

 Thread-safe abstract compression routine to query memory requirements for a compression operation.
Public function Static bool

CompressMemoryIfWorthDecompressing ( FName FormatName,
int32 MinBytesSaved,
int32 MinPercentSaved,
void* CompressedBuffer,
int32& CompressedSize,
const void* UncompressedBuffer,
int32 UncompressedSize,
ECompressionFlags Flags,
int32 CompressionData
)

 Same as CompressMemory but evaluates if the compression gain is worth the runtime decode time returns false if the size saving is not worth it (also if CompressedSize >= UncompressedSize) if false is returned, send the data uncompressed instead
Public function Static FName

GetCompressionFormatFromDeprecatedFlags ( ECompressionFlags DeprecatedFlags
)

  
Public function Static FString

GetCompressorDDCSuffix ( FName FormatName
)

 Returns a string which can be used to identify if a format has become out of date
Public function Static uint32

GetCompressorVersion ( FName FormatName
)

 Returns a version number for a specified format
Public function Static int32

GetMaximumCompressedSize ( FName FormatName,
int32 UncompressedSize,
ECompressionFlags Flags,
int32 CompressionData
)

 Thread-safe abstract compression routine to query maximum compressed size that could be made.
Public function Static bool

IsFormatValid ( FName FormatName
)

 Checks to see if a format will be usable, so that a fallback can be used
Public function Static bool

UncompressMemory ( FName FormatName,
void* UncompressedBuffer,
int32 UncompressedSize,
const void* CompressedBuffer,
int32 CompressedSize,
ECompressionFlags Flags,
int32 CompressionData
)

 Thread-safe abstract decompression routine.
Public function Static bool

UncompressMemoryStream ( FName FormatName,
void* UncompressedBuffer,
int32 UncompressedSize,
IMemoryReadStream* Stream,
int64 StreamOffset,
int32 CompressedSize,
ECompressionFlags Flags,
int32 CompressionData
)

  
Public function Static bool

VerifyCompressionFlagsValid ( int32 InCompressionFlags
)

 Verifies if the passed in value represents valid compression flags

Constants

Name Description
CompressionFormats Mapping of Compression FNames to their compressor objects
CompressionFormatsCriticalSection  
CompressorDstBytes Number of bytes after compression.Nubmer of bytes after compression.
CompressorSrcBytes Number of bytes before compression.
CompressorTimeCycles Time spent compressing data in cycles.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page