FTexturePlatformData

Platform-specific data used by the texture resource at runtime.

Windows
MacOS
Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Engine/Texture.h

Include

#include "Engine/Texture.h"

Syntax

struct FTexturePlatformData

Remarks

Platform-specific data used by the texture resource at runtime.

Variables

Name Description

Public variable

FTextureAsyncCa...

 

AsyncTask

Async cache task if one is outstanding.

Public variable

FString

 

DerivedDataKey

The key associated with this derived data.

Public variable

TIndirectArray<...

 

Mips

Mip data or VT data. one or the other.

Public variable

FOptTexturePlat...

 

OptData

Additional data required by some platforms.

Public variable

uint32

 

PackedData

Packed bits [b31: CubeMap], [b30: HasOptData], [b29-0: NumSlices]. See bit masks below.

Public variable

EPixelFormat

 

PixelFormat

Format in which mip data is stored.

Public variable

int32

 

SizeX

Width of the texture.

Public variable

int32

 

SizeY

Height of the texture.

Public variable

FVirtualTexture...

 

VTData

Constructors

Name Description

Public function

FTexturePlatformData()

Default constructor.

Destructors

Name Description

Public function

~FTexturePlatformData()

Destructor.

Functions

Name Description

Public function Const

bool

 

AreDerivedMipsAvailable()

Public function Const

bool

 

AreDerivedVTChunksAvailable()

Public function

void

 

Cache

(
    UTexture& InTexture,
    const FTextureBuildSettings* I...,
    uint32 InFlags,
    ITextureCompressorModule* Comp...
)

Public function

void

 

FinishCache()

Public function Const

int32

 

GetExtData()

Public function Const

bool

 

GetHasOptData()

Public function Const

EPixelFormat

 

GetLayerPixelFormat

(
    uint32 LayerIndex
)

Public function Const

int32

 

GetNumMipsInTail()

Public function Const

int32

 

GetNumNonStreamingMips()

Public function Const

int32

 

GetNumSlices()

Public function Const

int32

 

GetNumVTMips()

Only because we don't want to expose FVirtualTextureBuiltData.

Public function Const

bool

 

IsCubemap()

Public function Const

bool

 

IsReadyForAsyncPostLoad()

Return whether TryLoadMips() would stall because async loaded mips are not yet available.

Public function

void

 

Serialize

(
    FArchive& Ar,
    UTexture* Owner
)

Serialization.

Public function

void

 

SerializeCooked

(
    FArchive& Ar,
    UTexture* Owner,
    bool bStreamable
)

Serialization for cooked builds.

Public function

void

 

SetIsCubemap

(
    bool bCubemap
)

Public function

void

 

SetNumSlices

(
    int32 NumSlices
)

Public function

void

 

SetOptData

(
    FOptTexturePlatformData Data
)

Public function

bool

 

TryInlineMipData

(
    int32 FirstMipToLoad,
    UTexture* Texture
)

Public function

bool

 

TryLoadMips

(
    int32 FirstMipToLoad,
    void** OutMipData,
    UTexture* Texture
)

Try to load mips from the derived data cache.

Constants

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