TextureFormat | Unreal Engine 5.7 Documentation | Epic Developer Community

API > API/Developer


Name	TextureFormat
Type	Developer
Location	/Engine/Source/Developer/TextureFormat/
Module Build Rules	TextureFormat.Build.cs

Classes

Name	Remarks
FChildTextureFormat	Version of ITextureFormat that handles a child texture format that is used as a "post-process" after compressing textures, useful for several platforms that need to modify already compressed texture data for optimal data.

Structs

Name	Remarks
FEncodedTextureDescription	Everything necessary to know the memory layout for an encoded untiled unpacked texture (i.e. enough information to describe the texture entirely to a PC hardware API).
FEncodedTextureExtendedData	Extra data for an encoded texture.
FTextureEngineParameters	Holds various engine configuration parameters that can affect the output of a build but should generally be constant across all texture builds.
FTextureFormatCompressorCaps	Structure for texture format compressor capabilities.

Interfaces

Name	Remarks
ITextureFormat	Interface for texture compression modules.
ITextureFormatManagerModule	Module for the texture format manager
ITextureFormatModule	Interface for texture format modules.
ITextureTiler	Interface for platform formats that consume a linear, unpacked texture that an be built on a host platform (e.g. windows) and then tile/pack it as necessary.

Functions

Public

Name	Remarks	Include Path	Unreal Specifiers
ITextureFormatManagerModule * GetTextureFormatManager()	Return the Texture Format Manager interface, if it is available, otherwise return nullptr.	TextureFormatManager.h
ITextureFormatManagerModule & GetTextureFormatManagerRef()	Return the Texture Format Manager interface, fatal error if it is not available.	TextureFormatManager.h

Static

Name	Remarks	Include Path	Unreal Specifiers
static int32 GetNumNonStreamingMipsDirect ( int32 InNumMips, int32 InTopMipSizeX, int32 InTopMipSizeY, EPixelFormat InPixelFormat, int32 InNumMipsInTail, int32 InNumInlineDerivedMips )	Return how many mips need to be inlined for the given texture properties.	Interfaces/ITextureFormat.h
static int32 GetNumStreamingMipsDirect ( int32 InNumMips, bool bInCubeMap, bool bInVolumeTexture, bool bInTextureArray, const FEncodedTextureExtendedData* InExtendedData, const FTextureEngineParameters& InEngineParameters )	Calculate the number of streaming mips for the given set of texture properties.	Interfaces/ITextureFormat.h
static bool GetStreamingDisabledForNonVirtualTextureProperties ( bool bInCubeMap, bool bInVolumeTexture, bool bInTextureArray, const FTextureEngineParameters& InEngineParameters )		Interfaces/ITextureFormat.h

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library