Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

ITextureFormat::CompressImageEx

Compress an image (or images for a miptail) into a single mip blob.

Windows

MacOS

Linux

References

Module	TargetPlatform
Header	/Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITextureFormat.h
Include	#include "Interfaces/ITextureFormat.h"

Syntax

virtual bool CompressImageEx
(
    const struct FImage * Images,
    const uint32 NumImages,
    const struct FTextureBuildSettings & BuildSettings,
    bool bImageHasAlphaChannel,
    uint32 ExtData,
    FCompressedImage2D & OutCompressedImage
) const

Remarks

Compress an image (or images for a miptail) into a single mip blob.

Returns

true on success, false otherwise.

Parameters

Parameter	Description
Images	The input image(s)
Images	The number of images (for a miptail, this number should match what was returned in GetFormatCapabilities, mostly used for verification)
BuildSettings	Build settings.
bImageHasAlphaChannel	true if the image has a non-white alpha channel.
ExtData	Extra data that the format may want to have passed back in to each compress call (makes the format class be stateless)
OutCompressedMip	The compressed image.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss