1. Epic GamesDeveloper
  3. FTextureMipDataProvider

FTextureMipDataProvider

[FTextureMipDataProvider](API\Runtime\Engine\Streaming\FTextureMipDataProvider) defines the update steps and interface to implement the mip data strategy used in FTextureStreamIn.

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Streaming

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Public/Streaming/TextureMipDataProvider.h
Include #include "Streaming/TextureMipDataProvider.h"

Syntax

class FTextureMipDataProvider

Remarks

FTextureMipDataProvider defines the update steps and interface to implement the mip data strategy used in FTextureStreamIn. It allows to decouples where the texture mip data source from the texture update. Typical implementations are using DDC, disk files, internet server or dynamically generated.

Variables

  Type Name Description
Protected variable const int32 CurrentFirstLODIdx The resident first LOD resource index. With domain = [0, ResourceState.NumLODs[. NOT THE ASSET LOD INDEX!
Protected variable const int32 PendingFirstLODIdx The requested first LOD resource index. With domain = [0, ResourceState.NumLODs[. NOT THE ASSET LOD INDEX!
Protected variable const FStreamableRenderResourceState ResourceState The streamable state requested.

Constructors

  Type Name Description
Public function  

FTextureMipDataProvider ( const UTexture* Texture,
ETickState InTickState,
ETickThread InTickThread
)

 Constructor, defining the first tick step and thread.

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Virtual void Abort anything that could be stalling the update in PollMips().
Protected function void

AdvanceTo ( ETickState InState,
ETickThread InThread
)

 Helper to set the next tick state and thread. Validates that the progression is coherent.
Public function void

Cancel ( const FTextureUpdateSyncOptions& SyncOptions
)

 Cancel the progression and release any temporary resources.
Public function void

CleanUp ( const FTextureUpdateSyncOptions& SyncOptions
)

 Release any temporary data and objects that where used for the update.
Public function Const ETickThread Returns on which thread Cancel() must be called in the texture update (from FTextureStreamIn) to release ressources safely and correctly. ETickThread::None when ready to delete this.
Public function int32

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

 Acquire the mips this provider will handle.
Public function Const ETickState Get the next tick state and thread for the mip allocator. Used by FTextureStreamIn to schedule correctly the update between FTextureMipAllocator and FTextureMipDataProvider.
Public function Const ETickThread  
Public function void

Init ( const FTextureUpdateContext& Context,
const FTextureUpdateSyncOptions& SyncOptions
)

 Initialize data prelimary to the GetMips() step.
Public function bool

PollMips ( const FTextureUpdateSyncOptions& SyncOptions
)

 Check if each mip handled by this mip data provider have been updated correctly.

Enums

  Type Name Description
Public enum ETickState    
Public enum ETickThread    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page