1. Epic GamesDeveloper
  3. FEncodedTextureDescription

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
Public variable int32 ArraySlices  
Public variable bool bCubeMap  
Public variable bool bTextureArray  
Public variable bool bVolumeTexture  
Public variable uint8 NumMips  
Public variable EPixelFormat PixelFormat  
Public variable int32 TopMipSizeX  
Public variable int32 TopMipSizeY  
Public variable int32 TopMipVolumeSizeZ  

Functions

  Type Name Description
Public function Const FEncodedTextureDescription

GetDescriptionForMipLevel ( const FEncodedTextureExtendedData* InExtendedData,
int32 InMipIndex
)

 Returns the description for the single mip level (i.e. no further mips)
Public function Const void

GetEncodedMipIterators ( const FEncodedTextureExtendedData* InExtendedData,
int32& OutMipTailIndex,
int32& OutMipsInTail
)

 Convenience function for iterating over the encoded mips when you need to know how many mips are represented.
Public function Const int32

GetMipDepth ( int32 InMipIndex
)

 Always 1 unless volume texture.
Public function Static int32

GetMipDepth ( int32 InTextureDepth,
int32 InMipIndex,
bool bInVolumeTexture
)

  
Public function Const FIntVector3

GetMipDimensions ( int32 InMipIndex
)

 Returns the size of the mip at the given index. Z is 1 unless it's a volume texture.
Public function Const int32

GetMipHeight ( int32 InMipIndex
)

  
Public function Static int32

GetMipHeight ( int32 InTextureHeight,
int32 InMipIndex
)

  
Public function Const uint64

GetMipSizeInBytes ( int32 InMipIndex
)

 Returns the byte size of the unpacked/tiled mip. For mip chains that are packed or tiled, use FEncodedTextureExtendedData::MipSizesInBytes.
Public function Const int32

GetMipWidth ( int32 InMipIndex
)

  
Public function Static int32

GetMipWidth ( int32 InTextureWidth,
int32 InMipIndex
)

  
Public function Const int32 Returns the number of mips that actually carry bulk data for this texture.
Public function Const int32 Returns the slice count for usage cases/platforms that expect slice count to only include cubemap/array slices.
Public function Const int32

GetNumSlices_WithDepth ( int32 InMipIndex
)

 Returns the slice count for usage cases/platform that expect slice count to include volume texture depth.
Public function Const int32

GetNumStreamingMips ( const FEncodedTextureExtendedData* InExtendedData,
const FTextureEngineParameters& InEngineParameters
)

  
Public function Const FEncodedTextureDescription

RemoveTopMips ( const FEncodedTextureExtendedData* InExtendedData,
int32 InRemoveCount
)

  

Operators

  Type Name Description
Public function Const bool

operator== ( const FEncodedTextureDescription& OtherTextureDescription
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page