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 > FChildTextureFormat

Light Theme

Dark Theme

FChildTextureFormat

Version of [ITextureFormat](API\Developer\TargetPlatform\Interfaces\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

Windows

MacOS

Linux

Inheritance Hierarchy

ITextureFormat

FChildTextureFormat

References

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

Syntax

class FChildTextureFormat : public ITextureFormat

Remarks

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

Variables

		Name	Description
	TArray< FName >	BaseFormats	List of base formats that. Combined with FormatPrefix, this contains all formats this can handle.
	FString	FormatPrefix	Prefix put before all formats from parent formats.

Constructors

	Name	Description
	FChildTextureFormat ( const TCHAR* PlatformFormatPre... )

Functions

	Name	Description
void	AddBaseTextureFormatModules ( const TCHAR* ModuleNameWildcar... )
bool	CompressBaseImage ( const FImage& InImage, const FTextureBuildSettings& Build..., bool bImageHasAlphaChannel, FCompressedImage2D& OutCompressedI... )
bool	CompressBaseImageTiled ( const FImage* Images, uint32 NumImages, const FTextureBuildSettings& Build..., bool bImageHasAlphaChannel, TSharedPtr< FTilerSettings >& Tile..., FCompressedImage2D& OutCompressedI... )
FName	GetBaseFormatName ( FName PlatformName )
const ITextu...	GetBaseFormatObject ( FName PlatformName )	Given a platform specific format name, get the parent texture format object
FString	GetChildDerivedDataKeyString ( const UTexture& Texture, const FTextureBuildSettings* B... )	Make the child type think about if they need a key string or not, by making it pure virtual
uint8	GetChildFormatVersion ( FName Format, const FTextureBuildSettings* B... )	The final version is a combination of parent and child formats, 8 bits for each

Overridden from ITextureFormat

	Name	Description
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
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.

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

Take our survey

Dismiss