FTextureMipDataProvider::GetMips

Acquire the mips this provider will handle.

Windows
MacOS
Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Public/Streaming/TextureMipDataProvider.h

Include

#include "Streaming/TextureMipDataProvider.h"

Syntax

int32 GetMips
(
    const FTextureUpdateContext & Context,
    int32 StartingMipIndex,
    const FTextureMipInfoArray & MipInfos,
    const FTextureUpdateSyncOptions & SyncOptions
)

Remarks

Acquire the mips this provider will handle. Non handled mips must be handled by the next mip data provider or the update will be cancelled altogether. GetMips() must typically advance to PollMips() if it wants to be able to notify FTextureStreamIn that something went wrong and that the update must be cancelled.

Return the next value StartingMipIndex (for the next provider). Must be FTextureUpdateContext::CurrentFirstMipIndex to indicate that all mips have been handled.

Parameters

Parameter

Description

Context

An update context constant throughout the FTextureStreamIn update. Gives things like which texture asset is updated and what mips are streamed in.

StartingMipIndex

The current starting mip index, somewhere between FTextureUpdateContext::PendingFirstMipIndex and FTextureUpdateContext::CurrentFirstMipIndex inclusively.

MipInfos

The array of FTextureMipInfo that hold the information relative to each mip for which data must be provided.

SyncOptions

Different sync options to control when the next tick of FTextureStreamIn can be scheduled.

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