1. Epic GamesDeveloper
  3. FChildTextureFormat

FChildTextureFormat

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

API > API/Developer > API/Developer/TextureFormat

Inheritance Hierarchy

References

   
Module TextureFormat
Header /Engine/Source/Developer/TextureFormat/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.

There are 3 ways a texture can get processed: ITextureFormat::IsTiling returns true. This should only be for the old Oodle RAD Game Tools supplied texture encoder and is being deprecated in favor of the new built-in Oodle texture encoder (TextureFormatOodle). In this case, the child format passes the images to the encoder to split apart prior to passing to the platform tools. FChildTextureFormat::GetTiler returns nullptr. This is being phased out because the linear version of the input texture gets encoded for each platform with a post process, wasting cook time. In this case the child format encodes the "base" texture and then tiles it using the platform tools. FChildTextureFormat::GetTiler returns a valid pointer. This is the most recent design. In this case, the child format is used as a holder of metadata and doesn't actually do any work (CompressImage class of functions not called).

Variables

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

Constructors

  Type Name Description
Public function  

FChildTextureFormat ( const TCHAR* PlatformFormatPrefix
)

  

Functions

  Type Name Description
Protected function void

AddBaseTextureFormatModules ( const TCHAR* ModuleNameWildcard
)

  
Public function Const bool

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

  
Public function Const bool

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

  
Protected function Virtual Const FCbObject Obtains the global format config object for this texture format.
Protected function void  
Protected function Const FCbObjectView  
Public function Const FName

GetBaseFormatName ( FName ChildFormatName
)

  
Public function Const const ITextureFormat *

GetBaseFormatObject ( FName FormatName
)

 Given a platform specific format name, get the texture format object that will do the encoding.
Public function Const FTextureBuildSettings  
Protected function Const FString

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

 Make the child type think about if they need a key string or not, by making it pure virtual.
Protected function Virtual Const FCbObjectView Obtains the format config appropriate for the build .
Protected function Const uint8

GetChildFormatVersion ( FName Format,
const FTextureBuildSettings* BuildSettings
)

 The final version is a combination of parent and child formats, 8 bits for each
Public function Virtual Const const ITextureTiler * Return the texture tiler for this platform.

Overridden from ITextureFormat

  Type Name Description
Public function Virtual Const bool  
Public function Virtual Const FCbObject Obtains the current global format config object for this texture format.
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 Virtual 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 void

GetSupportedFormats ( TArray< FName >& OutFormats
)

 Gets the list of supported formats.
Public function Virtual 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.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page