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).

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

References

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

Syntax

struct FEncodedTextureDescription  

Remarks

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). Once a texture gets tiled or gets a packed mip tail, FEncodedTextureEncodedData is additionally required to know the memory layout.

Variables

Type Name Description
int32 ArraySlices  
bool bCubeMap  
bool bTextureArray  
bool bVolumeTexture  
uint8 NumMips  
EPixelFormat PixelFormat  
int32 TopMipSizeX  
int32 TopMipSizeY  
int32 TopMipVolumeSizeZ  

Functions

Type Name Description
FEncodedText... GetDescriptionForMipLevel ( const FEncodedTextureExtendedData&..., int32 InMipIndex ) Returns the description for the single mip level (i.e. no further mips)
void GetEncodedMipIterators ( const FEncodedTextureExtendedData&..., int32& OutMipTailIndex, int32& OutMipsInTail ) Convenience function for iterating over the encoded mips when you need to know how many mips are represented.
int32 GetMipDepth ( int32 InMipIndex ) Always 1 unless volume texture.
int32 GetMipDepth ( int32 InTextureDepth, int32 InMipIndex, bool bInVolumeTexture )  
FIntVector3 GetMipDimensions ( int32 InMipIndex ) Returns the size of the mip at the given index. Z is 1 unless it's a volume texture.
int32 GetMipHeight ( int32 InMipIndex )  
int32 GetMipHeight ( int32 InTextureHeight, int32 InMipIndex )  
uint64 GetMipSizeInBytes ( int32 InMipIndex ) Returns the byte size of the unpacked/tiled mip. For mip chains that are packed or tiled, use FEncodedTextureExtendedData::MipSizesInBytes.
int32 GetMipWidth ( int32 InMipIndex )  
int32 GetMipWidth ( int32 InTextureWidth, int32 InMipIndex )  
int32 GetNumEncodedMips ( const FEncodedTextureExtendedData&... ) Returns the number of mips that actually carry bulk data for this texture.
int32 GetNumSlices_NoDepth () Returns the slice count for usage cases/platforms that expect slice count to only include cubemap/array slices.
int32 GetNumSlices_WithDepth ( int32 InMipIndex ) Returns the slice count for usage cases/platform that expect slice count to include volume texture depth.
int32 GetNumStreamingMips ( const FEncodedTextureExtendedData&..., const FTextureEngineParameters& In... )  
FEncodedText... RemoveTopMips ( const FEncodedTextureExtendedData&..., int32 InRemoveCount )  

Operators

Type Name Description
bool operator== ( const FEncodedTextureDescription& ... )  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library