1. Epic GamesDeveloper
  3. ITextureFormat

ITextureFormat

Interface for texture compression modules.

Unreal Engine C++ API Reference > Developer > TextureFormat > Interfaces

Inheritance Hierarchy

References

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

Syntax

class ITextureFormat

Remarks

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.

Destructors

  Type Name Description
Public function Virtual   Virtual destructor.

Functions

  Type Name Description
Public function Virtual Const bool Checks whether this texture format can compress in parallel.
Public function Virtual Const bool  
Public function Const bool

CompressImage ( const FImage& Image,
const FTextureBuildSettings& BuildSettings,
const FIntVector3& InMip0Dimensions,
int32 InMip0NumSlicesNoDepth,
int32 InMipIndex,
int32 InMipCount,
FStringView DebugTexturePathName,
bool bImageHasAlphaChannel,
FCompressedImage2D& OutCompressedImage
)

 Compresses a single image.
Public function Virtual Const 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
)

 Compress an image (or images for a miptail) into a single mip blob.
Public function Virtual Const bool

CompressImageTiled ( const FImage* Images,
uint32 NumImages,
const FTextureBuildSettings& BuildSettings,
FStringView DebugTexturePathName,
bool bImageHasAlphaChannel,
TSharedPtr< FTilerSettings >& TilerSettings,
FCompressedImage2D& OutCompressedImage
)

 Compress an image (or images for a miptail) into a single mip blob with device-specific tiling.
Public function Virtual Const FCbObject Obtains the current global format config object for this texture format.
Public function Virtual Const FString If this is an Alternate Texture Format, return the prefix to apply
Public function Virtual Const const FChildTextureFormat *  
Public function Virtual Const FString

GetDerivedDataKeyString ( const FTextureBuildSettings& InBuildSettings,
int32 InMipCount,
const FIntVector3& InMip0Dimensions
)

 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
Public function Virtual Const EPixelFormat

GetEncodedPixelFormat ( const FTextureBuildSettings& InBuildSettings,
bool bInImageHasAlphaChannel
)

 Returns what the compressed pixel format will be for a given format and the given settings.
Public function Const FName

GetEncoderName ( FName Format
)

 Return the name of the encoder used for the given format.Used for debugging and UI.
Public function Virtual Const FEncodedTextureExtendedData

GetExtendedDataForTexture ( const FEncodedTextureDescription& InTextureDescription,
int8 InLODBias
)

 Generate and return any out-of-band data that needs to be saved for a given encoded texture description.
Public function Virtual Const FName Identify the latest sdk version for this texture encoder (note the SdkVersion is different than the TextureFormat Version)
Public function Const void

GetSupportedFormats ( TArray< FName >& OutFormats
)

 Gets the list of supported formats.
Public function Const uint16

GetVersion ( FName Format,
const FTextureBuildSettings* BuildSettings
)

 Gets the current version of the specified texture format.
Public function Virtual Const bool

PrepareTiling ( const FImage* Images,
const uint32 NumImages,
const FTextureBuildSettings& BuildSettings,
bool bImageHasAlphaChannel,
TSharedPtr< FTilerSettings >& OutTilerSettings,
TArray< FCompressedImage2D >& OutCompressedImage
)

 Prepares to compresses a single image with tiling.
Public function Virtual Const void

ReleaseTiling ( const FTextureBuildSettings& BuildSettings,
TSharedPtr< FTilerSettings >& TilerSettings
)

 Cleans up the FTilerSettings object once it is finished.
Public function Virtual Const bool

SetTiling ( const FTextureBuildSettings& BuildSettings,
TSharedPtr< FTilerSettings >& TilerSettings,
const TArray64< uint8 >& ReorderedBlocks,
uint32 NumBlocks
)

 Sets the tiling settings after device-specific tiling has been performed.
Public function Virtual Const bool Exposes whether the format supports the fast/final encode speed switching in project settings.
Public function Virtual Const bool Whether device-specific tiling is supported by the compressor.

Classes

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

Deprecated Functions

  Type Name Description
Public function Virtual Const FTextureFormatCompressorCaps Hasn't been used in a while.
Public function Virtual Const FTextureFormatCompressorCaps

GetFormatCapabilitiesEx ( const FTextureBuildSettings& BuildSettings,
uint32 NumMips,
const FImage& ExampleImage,
bool bImageHasAlphaChannel
)

 Use GetExtendedDataForTexture instead to get the same information without the actual image bits.
Public function Virtual Const EPixelFormat

GetPixelFormatForImage ( const FTextureBuildSettings& BuildSettings,
const FImage& Image,
bool bImageHasAlphaChannel
)

 Use GetEncodedPixelFormat(BuildSettings, bImageHasAlphaChannel) instead
Public function Virtual Const bool Legacy API - do not use

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page