FCompression

Windows
MacOS
Linux

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Misc/Compression.h

Include

#include "Misc/Compression.h"

Syntax

struct FCompression

Functions

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

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

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.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss