ITextureFormat

Interface for texture compression modules.

Windows
MacOS
Linux

References

Module

TargetPlatform

Header

/Engine/Source/Developer/TargetPlatform/Public/Interfaces/ITextureFormat.h

Include

#include "Interfaces/ITextureFormat.h"

Syntax

class ITextureFormat

Remarks

Interface for texture compression modules.

Destructors

Name Description

Public function Virtual

~ITextureFormat()

Virtual destructor.

Functions

Name Description

Public function Virtual Const

bool

 

AllowParallelBuild()

Checks whether this texture format can compress in parallel.

Public function Const

bool

 

CompressImage

(
    const FImage& Image,
    const FTextureBuildSettings& Build...,
    bool bImageHasAlphaChannel,
    FCompressedImage2D& OutCompressedI...
)

Compresses a single image.

Public function Virtual Const

bool

 

CompressImageEx

(
    const FImage* Images,
    const uint32 NumImages,
    const FTextureBuildSettings& Build...,
    bool bImageHasAlphaChannel,
    uint32 ExtData,
    FCompressedImage2D& OutCompressedI...
)

Compress an image (or images for a miptail) into a single mip blob

Public function Virtual Const

FString

 

GetDerivedDataKeyString

(
    const UTexture& Texture
)

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 Const

FTextureForm...

 

GetFormatCapabilities()

Gets the capabilities of the texture compressor.

Public function Virtual Const

FTextureForm...

 

GetFormatCapabilitiesEx

(
    const FTextureBuildSettings& Build...,
    uint32 NumMips,
    const FImage& ExampleImage
)

Gets the capabilities of the texture compressor.

Public function Const

void

 

GetSupportedFormats

(
    TArray< FName >& OutFormats
)

Gets the list of supported formats.

Public function Const

uint16

 

GetVersion

(
    FName Format,
    const FTextureBuildSettings* B...
)

Gets the current version of the specified texture format.

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