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::CompressImage

Compresses a single image.

Windows

MacOS

Linux

References

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

Syntax

bool CompressImage
(
    const struct FImage & Image,
    const struct FTextureBuildSettings & BuildSettings,
    bool bImageHasAlphaChannel,
    struct FCompressedImage2D & OutCompressedImage
) const

Remarks

Compresses a single image.

Returns

true on success, false otherwise.

Parameters

Parameter	Description
Image	The input image.
BuildSettings	Build settings.
bImageHasAlphaChannel	true if the image has a non-white alpha channel.
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