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

> Unreal Engine API Reference > Developer > TargetPlatform > Interfaces > ITextureFormat

Light Theme

Dark Theme

ITextureFormat

Interface for texture compression modules.

Windows

MacOS

Linux

Inheritance Hierarchy

ITextureFormat

FChildTextureFormat

References

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

Syntax

class ITextureFormat

Remarks

Interface for texture compression modules.

Destructors

	Name	Description
	~ITextureFormat()	Virtual destructor.

Functions

	Name	Description
bool	AllowParallelBuild()	Checks whether this texture format can compress in parallel.
bool	CompressImage ( const FImage& Image, const FTextureBuildSettings& Build..., bool bImageHasAlphaChannel, FCompressedImage2D& OutCompressedI... )	Compresses a single image.
bool	CompressImageEx ( const FImage* Images, const uint32 NumImages, const FTextureBuildSettings& Build..., bool bImageHasAlphaChannel, uint32 ExtData, FCompressedImage2D& OutCompressedI... )	Compress an image (or images for a miptail) into a single mip blob.
bool	CompressImageTiled ( const FImage* Images, uint32 NumImages, const FTextureBuildSettings& Build..., bool bImageHasAlphaChannel, TSharedPtr< FTilerSettings >& Tile..., FCompressedImage2D& OutCompressedI... )	Compress an image (or images for a miptail) into a single mip blob with device-specific tiling.
FString	GetDerivedDataKeyString ( const UTexture& Texture, const FTextureBuildSettings* B... )	Gets an optional derived data key string, so that the compressor can rely upon the number of mips, size of texture, etc, when compressing the image
FTextureForm...	GetFormatCapabilities()	Gets the capabilities of the texture compressor.
FTextureForm...	GetFormatCapabilitiesEx ( const FTextureBuildSettings& Build..., uint32 NumMips, const FImage& ExampleImage, bool bImageHasAlphaChannel )	Gets the capabilities of the texture compressor.
EPixelFormat	GetPixelFormatForImage ( const FTextureBuildSettings& Build..., const FImage& Image, bool bImageHasAlphaChannel )	Calculate the final/runtime pixel format for this image on this platform
void	GetSupportedFormats ( TArray< FName >& OutFormats )	Gets the list of supported formats.
uint16	GetVersion ( FName Format, const FTextureBuildSettings* B... )	Gets the current version of the specified texture format.
bool	PrepareTiling ( const FImage* Images, const uint32 NumImages, const FTextureBuildSettings& Build..., bool bImageHasAlphaChannel, TSharedPtr< FTilerSettings >& OutT..., TArray< FCompressedImage2D >& OutC... )	Prepares to compresses a single image with tiling.
void	ReleaseTiling ( const FTextureBuildSettings& Build..., TSharedPtr< FTilerSettings >& Tile... )	Cleans up the FTilerSettings object once it is finished.
bool	SetTiling ( const FTextureBuildSettings& Build..., TSharedPtr< FTilerSettings >& Tile..., const TArray64< uint8 >& Reordered..., uint32 NumBlocks )	Sets the tiling settings after device-specific tiling has been performed.
bool	SupportsTiling ( const FTextureBuildSettings& Build... )	Whether device-specific tiling is supported by the compressor.
bool	UsesTaskGraph()	Whether the compressor uses the FTaskGraph API.

Classes

	Name	Description
	FTilerSettings	An object produced by PrepareTiling and used by SetTiling and CompressImageTiled.

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

Take our survey

Dismiss