ITextureFormat | Unreal Engine 5.7 Documentation

API > API/Developer > API/Developer/TextureFormat

Interface for texture compression modules.

Note that if you add any virtual functions to this, they almost certainly need to be plumbed through ChildTextureFormat! This is why the Format is passed around - ChildTextureFormat needs it to resolve to the base format.


Name	ITextureFormat
Type	class
Header File	/Engine/Source/Developer/TextureFormat/Public/Interfaces/ITextureFormat.h
Include Path	#include "Interfaces/ITextureFormat.h"

Syntax

class ITextureFormat

Derived Classes

FChildTextureFormat

Destructors

Name	Remarks	Include Path	Unreal Specifiers
virtual ~ITextureFormat()	Virtual destructor.	Interfaces/ITextureFormat.h

Structs

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

Functions

Public

Name	Remarks	Include Path
virtual bool AllowParallelBuild()	Checks whether this texture format can compress in parallel.	Interfaces/ITextureFormat.h
virtual bool CanAcceptNonF32Source ( FName Format ) const		Interfaces/ITextureFormat.h
virtual bool CanDecodeFormat ( EPixelFormat InPixelFormat ) const	Return true if this format can decode the given pixel format to one of the ERawImageFormats.	Interfaces/ITextureFormat.h
bool CompressImage ( const FImage& Image, const FTextureBuildSettings& BuildSettings, const FIntVector3& InMip0Dimensions, int32 InMip0NumSlicesNoDepth, int32 InMipIndex, int32 InMipCount, FStringView DebugTexturePathName, bool bImageHasAlphaChannel, FCompressedImage2D& OutCompressedImage ) const	Compresses a single image.	Interfaces/ITextureFormat.h
virtual bool CompressImageEx ( const FImage* Images, const uint32 NumImages, const FTextureBuildSettings& BuildSettings, const FIntVector3& InMip0Dimensions, int32 InMip0NumSlicesNoDepth, int32 InMipIndex, int32 InMipCount, FStringView DebugTexturePathName, bool bImageHasAlphaChannel, uint32 ExtData, FCompressedImage2D& OutCompressedImage ) const	Compress an image (or images for a miptail) into a single mip blob.	Interfaces/ITextureFormat.h
virtual bool CompressImageTiled ( const FImage* Images, uint32 NumImages, const FTextureBuildSettings& BuildSettings, FStringView DebugTexturePathName, bool bImageHasAlphaChannel, TSharedPtr< FTilerSettings >& TilerSettings, FCompressedImage2D& OutCompressedImage ) const	Compress an image (or images for a miptail) into a single mip blob with device-specific tiling.	Interfaces/ITextureFormat.h
virtual bool DecodeImage ( int32 InSizeX, int32 InSizeY, int32 InNumSlices, EPixelFormat InPixelFormat, bool bInSRGB, const FName& InTextureFormatName, FSharedBuffer InEncodedData, FImage& OutImage, FStringView InTextureName ) const	Decodes an image encoded as a EPixelFormat into something encoded as a ERawImageFormat.	Interfaces/ITextureFormat.h
virtual FCbObject ExportGlobalFormatConfig ( const FTextureBuildSettings& BuildSettings ) const	Obtains the current global format config object for this texture format.	Interfaces/ITextureFormat.h
virtual FString GetAlternateTextureFormatPrefix()	If this is an Alternate Texture Format, return the prefix to apply	Interfaces/ITextureFormat.h
virtual const FChildTextureFormat * GetChildFormat()		Interfaces/ITextureFormat.h
virtual const FUtf8StringView GetDecodeBuildFunctionName()	If the format can decode to RGBA8/RGBA16F, this is the IBuild function name for it.	Interfaces/ITextureFormat.h
virtual FString GetDerivedDataKeyString ( const FTextureBuildSettings& InBuildSettings, int32 InMipCount, const FIntVector3& InMip0Dimensions ) const	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	Interfaces/ITextureFormat.h
virtual EPixelFormat GetEncodedPixelFormat ( const FTextureBuildSettings& InBuildSettings, bool bInImageHasAlphaChannel ) const	Returns what the compressed pixel format will be for a given format and the given settings.	Interfaces/ITextureFormat.h
FName GetEncoderName ( FName Format ) const	Return the name of the encoder used for the given format.Used for debugging and UI.	Interfaces/ITextureFormat.h
virtual FEncodedTextureExtendedData GetExtendedDataForTexture ( const FEncodedTextureDescription& InTextureDescription, int8 InLODBias ) const	Generate and return any out-of-band data that needs to be saved for a given encoded texture description.	Interfaces/ITextureFormat.h
virtual FTextureFormatCompressorCaps GetFormatCapabilities()	Gets the capabilities of the texture compressor.	Interfaces/ITextureFormat.h
virtual FTextureFormatCompressorCaps GetFormatCapabilitiesEx ( const FTextureBuildSettings& BuildSettings, uint32 NumMips, const FImage& ExampleImage, bool bImageHasAlphaChannel ) const	Gets the capabilities of the texture compressor.	Interfaces/ITextureFormat.h
virtual FName GetLatestSdkVersion()	Identify the latest sdk version for this texture encoder (note the SdkVersion is different than the TextureFormat Version)	Interfaces/ITextureFormat.h
virtual EPixelFormat GetPixelFormatForImage ( const FTextureBuildSettings& BuildSettings, const FImage& Image, bool bImageHasAlphaChannel ) const	Calculate the final/runtime pixel format for this image on this platform	Interfaces/ITextureFormat.h
void GetSupportedFormats ( TArray< FName >& OutFormats ) const	Gets the list of supported formats.	Interfaces/ITextureFormat.h
uint16 GetVersion ( FName Format, const FTextureBuildSettings* BuildSettings ) const	Gets the current version of the specified texture format.	Interfaces/ITextureFormat.h
virtual bool PrepareTiling ( const FImage* Images, const uint32 NumImages, const FTextureBuildSettings& BuildSettings, bool bImageHasAlphaChannel, TSharedPtr< FTilerSettings >& OutTilerSettings, TArray< FCompressedImage2D >& OutCompressedImage ) const	Prepares to compresses a single image with tiling.	Interfaces/ITextureFormat.h
virtual void ReleaseTiling ( const FTextureBuildSettings& BuildSettings, TSharedPtr< FTilerSettings >& TilerSettings ) const	Cleans up the FTilerSettings object once it is finished.	Interfaces/ITextureFormat.h
virtual bool SetTiling ( const FTextureBuildSettings& BuildSettings, TSharedPtr< FTilerSettings >& TilerSettings, const TArray64< uint8 >& ReorderedBlocks, uint32 NumBlocks ) const	Sets the tiling settings after device-specific tiling has been performed.	Interfaces/ITextureFormat.h
virtual bool SupportsEncodeSpeed ( FName Format, const ITargetPlatformSettings* TargetPlatform ) const	Exposes whether the format supports the fast/final encode speed switching in project settings.	Interfaces/ITextureFormat.h
virtual bool SupportsTiling()	Whether device-specific tiling is supported by the compressor.	Interfaces/ITextureFormat.h
virtual bool UsesTaskGraph()		Interfaces/ITextureFormat.h