ECompressionFlags

Flags controlling [de]compression Make sure to update VerifyCompressionFlagsValid after changing these values.

Choose your operating system:

Windows

macOS

Linux

References

Module

Core

Header

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

Include

#include "Misc/CompressionFlags.h"

Syntax

enum ECompressionFlags
{
    COMPRESS_None                         = 0x00,
    COMPRESS_ZLIB                         = 0x01,
    COMPRESS_GZIP                         = 0x02,
    COMPRESS_Custom                       = 0x04,
    COMPRESS_DeprecatedFormatFlagsMask    = 0xF,
    COMPRESS_NoFlags                      = 0x00,
    COMPRESS_BiasMemory                   = 0x10,
    COMPRESS_BiasSize                     = COMPRESS_BiasMemory,
    COMPRESS_BiasSpeed                    = 0x20,
    COMPRESS_SourceIsPadded               = 0x80,
    COMPRESS_OptionsFlagsMask             = 0xF0,
    COMPRESS_ForPackaging                 = 0x100,
    COMPRESS_ForPurposeMask               = 0xF00,
}

Values

Name

Description

COMPRESS_None

No compression

COMPRESS_ZLIB

Compress with ZLIB - DEPRECATED, USE FNAME

COMPRESS_GZIP

Compress with GZIP - DEPRECATED, USE FNAME

COMPRESS_Custom

Compress with user defined callbacks - DEPRECATED, USE FNAME

COMPRESS_DeprecatedFormatFlagsMask

Joint of the previous ones to determine if old flags are being used

COMPRESS_NoFlags

No flags specified /

COMPRESS_BiasMemory

Prefer compression that compresses smaller (ONLY VALID FOR COMPRESSION)

COMPRESS_BiasSize

COMPRESS_BiasSpeed

Prefer compression that compresses faster (ONLY VALID FOR COMPRESSION)

COMPRESS_SourceIsPadded

Is the source buffer padded out (ONLY VALID FOR UNCOMPRESS)

COMPRESS_OptionsFlagsMask

Set of flags that are options are still allowed

COMPRESS_ForPackaging

Indicate this compress call is for Packaging (pak/iostore)

COMPRESS_ForPurposeMask

Remarks

Flags controlling [de]compression Make sure to update VerifyCompressionFlagsValid after changing these values.