Navigation
API > API/Runtime > API/Runtime/Engine
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.
| Name | FTextureMipDataProvider |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Public/Streaming/TextureMipDataProvider.h |
| Include Path | #include "Streaming/TextureMipDataProvider.h" |
Syntax
class FTextureMipDataProvider
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FTextureMipDataProvider
(
const UTexture* Texture, |
Constructor, defining the first tick step and thread. | Streaming/TextureMipDataProvider.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FTextureMipDataProvider() |
Streaming/TextureMipDataProvider.h |
Enums
Public
| Name | Remarks |
|---|---|
| ETickState | |
| ETickThread |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| NextTickState | ETickState | The next tick function that should be called. | Streaming/TextureMipDataProvider.h | |
| NextTickThread | ETickThread | The next tick thread from where to call the tick function. | Streaming/TextureMipDataProvider.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AbortPollMips () |
Abort anything that could be stalling the update in PollMips(). | Streaming/TextureMipDataProvider.h | |
virtual void AbortPostprocessGPUMipData () |
Abort anything that could be stalling the update in PostprocessGPUMipData(). | Streaming/TextureMipDataProvider.h | |
void Cancel
(
const FTextureUpdateSyncOptions& SyncOptions |
Cancel the progression and release any temporary resources. | Streaming/TextureMipDataProvider.h | |
void CleanUp
(
const FTextureUpdateSyncOptions& SyncOptions |
Release any temporary data and objects that where used for the update. | Streaming/TextureMipDataProvider.h | |
ETickThread GetCancelThread() |
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. | Streaming/TextureMipDataProvider.h | |
int32 GetMips
(
const FTextureUpdateContext& Context, |
Acquire the mips this provider will handle. | Streaming/TextureMipDataProvider.h | |
ETickState GetNextTickState() |
Get the next tick state and thread for the mip allocator. Used by FTextureStreamIn to schedule correctly the update between FTextureMipAllocator and FTextureMipDataProvider. | Streaming/TextureMipDataProvider.h | |
ETickThread GetNextTickThread() |
Streaming/TextureMipDataProvider.h | ||
void Init
(
const FTextureUpdateContext& Context, |
Initialize data prelimary to the GetMips() step. | Streaming/TextureMipDataProvider.h | |
bool PollMips
(
const FTextureUpdateSyncOptions& SyncOptions |
Check if each mip handled by this mip data provider have been updated correctly. | Streaming/TextureMipDataProvider.h | |
virtual bool PostprocessGPUMipData
(
const FTextureUpdateContext& Context, |
Once the texture has been uploaded to the GPU, the mip provider has the opportunity to perform any modifications necessary before the texture is finalized and applied to the texture resource. | Streaming/TextureMipDataProvider.h | |
virtual bool PostprocessGPUMipData
(
const FTextureUpdateContext& Context, |
Once the texture has been uploaded to the GPU, the mip provider has the opportunity to perform any modifications necessary before the texture is finalized and applied to the texture resource. | Streaming/TextureMipDataProvider.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AdvanceTo
(
ETickState InState, |
Helper to set the next tick state and thread. Validates that the progression is coherent. | Streaming/TextureMipDataProvider.h |