UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Classes | Public Member Functions | Protected Member Functions | Friends | List of all members
FTexture2DStreamIn_IO Class Reference

#include <Texture2DStreamIn_IO.h>

+ Inheritance diagram for FTexture2DStreamIn_IO:

Public Member Functions

 FTexture2DStreamIn_IO (UTexture2D *InTexture, bool InPrioritizedIORequest)
 
 ~FTexture2DStreamIn_IO ()
 
- Public Member Functions inherited from FTexture2DStreamIn
 FTexture2DStreamIn (UTexture2D *InTexture)
 
 ~FTexture2DStreamIn ()
 
- Public Member Functions inherited from FTexture2DUpdate
 FTexture2DUpdate (UTexture2D *InTexture)
 
- Public Member Functions inherited from TRenderAssetUpdate< FTexture2DUpdateContext >
 TRenderAssetUpdate (const UStreamableRenderAsset *InAsset)
 
void PushTask (const FContext &Context, EThreadType InTaskThread, const FCallback &InTaskCallback, EThreadType InCancelationThread, const FCallback &InCancelationCallback)
 
EThreadType GetRelevantThread () const final override
 
- Public Member Functions inherited from FRenderAssetUpdate
UE_API FRenderAssetUpdate (const UStreamableRenderAsset *InAsset)
 
UE_API void Tick (EThreadType InCurrentThread)
 
bool IsCompleted () const
 
virtual void OnAbandoned ()
 
bool IsCancelled () const
 
bool IsSuccessfullyFinished () const
 
UE_API ETaskState DoLock ()
 
UE_API void DoUnlock (ETaskState PreviousTaskState)
 
bool IsLocked () const
 
FReturnedRefCountValue AddRef () const final override
 
UE_API uint32 Release () const final override
 
uint32 GetRefCount () const final override
 
- Public Member Functions inherited from IRefCountedObject
virtual ~IRefCountedObject ()
 

Protected Member Functions

void SetIORequests (const FContext &Context)
 
void ClearIORequests (const FContext &Context)
 
void ReportIOError (const FContext &Context)
 
void SetAsyncFileCallback ()
 
void CancelIORequests ()
 
void Abort () override
 
bool CanAbandon () const override
 
- Protected Member Functions inherited from FTexture2DStreamIn
void DoAllocateNewMips (const FContext &Context)
 
void DoFreeNewMips (const FContext &Context)
 
void DoLockNewMips (const FContext &Context)
 
void DoUnlockNewMips (const FContext &Context)
 
void DoCopySharedMips (const FContext &Context)
 
void DoAsyncCreateWithNewMips (const FContext &Context)
 
- Protected Member Functions inherited from FTexture2DUpdate
virtual ~FTexture2DUpdate ()
 
void DoAsyncReallocate (const FContext &Context)
 
void DoConvertToVirtualWithNewMips (const FContext &Context)
 
bool DoConvertToNonVirtual (const FContext &Context)
 
void DoFinishUpdate (const FContext &Context)
 
- Protected Member Functions inherited from TRenderAssetUpdate< FTexture2DUpdateContext >
ETaskState TickInternal (EThreadType InCurrentThread, bool bCheckForSuspension) final override
 
void ClearCallbacks ()
 
- Protected Member Functions inherited from FRenderAssetUpdate
virtual UE_API ~FRenderAssetUpdate ()
 
void MarkAsCancelled ()
 
void MarkAsSuccessfullyFinished ()
 
UE_API void ScheduleGTTask ()
 
UE_API void ScheduleRenderTask ()
 
UE_API void ScheduleAsyncTask ()
 

Friends

class FCancelIORequestsTask
 

Additional Inherited Members

- Public Types inherited from TRenderAssetUpdate< FTexture2DUpdateContext >
typedef FTexture2DUpdateContext FContext
 
typedef TFunction< void(const FContext &Context)> FCallback
 
- Public Types inherited from FRenderAssetUpdate
enum  EThreadType {
  TT_None , TT_Render , TT_Async , TT_GameThread ,
  TT_GameRunningAsync
}
 
enum  ETaskState {
  TS_Done , TS_Suspended , TS_InProgress , TS_Locked ,
  TS_Init
}
 
- Protected Types inherited from FRenderAssetUpdate
typedef FAutoDeleteAsyncTask< FMipUpdateTask > FAsyncMipUpdateTask
 
- Protected Attributes inherited from FTexture2DStreamIn
TArray< FStreamMipData, TInlineAllocator< MAX_TEXTURE_MIP_COUNT > > MipData
 
void * InitialMipDataForAsyncCreate [MAX_TEXTURE_MIP_COUNT]
 
- Protected Attributes inherited from FTexture2DUpdate
FTextureRHIRef IntermediateTextureRHI
 
- Protected Attributes inherited from TRenderAssetUpdate< FTexture2DUpdateContext >
EThreadType TaskThread
 
FCallback TaskCallback
 
EThreadType CancelationThread
 
FCallback CancelationCallback
 
- Protected Attributes inherited from FRenderAssetUpdate
const FStreamableRenderResourceState ResourceState
 
const int32 CurrentFirstLODIdx = INDEX_NONE
 
const int32 PendingFirstLODIdx = INDEX_NONE
 
FCriticalSection CS
 
int32 ScheduledGTTasks
 
int32 ScheduledRenderTasks
 
int32 ScheduledAsyncTasks
 
const UStreamableRenderAsset * StreamableAsset = nullptr
 
FThreadSafeCounter TaskSynchronization
 
bool bIsCancelled
 
bool bDeferExecution
 
bool bSuccess
 
volatile ETaskState TaskState
 

Constructor & Destructor Documentation

◆ FTexture2DStreamIn_IO()

FTexture2DStreamIn_IO::FTexture2DStreamIn_IO ( UTexture2D *  InTexture,
bool  InPrioritizedIORequest 
)

◆ ~FTexture2DStreamIn_IO()

FTexture2DStreamIn_IO::~FTexture2DStreamIn_IO ( )

Member Function Documentation

◆ Abort()

void FTexture2DStreamIn_IO::Abort ( )
overrideprotectedvirtual

Cancel the current update. Will also attempt to cancel pending IO requests, see FTexture2DStreamIn_IO::Abort(). This is called outside of the update loop when a cancelation is required for external events.

Reimplemented from FRenderAssetUpdate.

◆ CanAbandon()

bool FTexture2DStreamIn_IO::CanAbandon ( ) const
overrideprotectedvirtual

Allows the update to be decoupled from its UStreamableRenderAsset so it can be independently garbage collected. This is called when we query IsReadyForFinishDestroy on the UStreamableRenderAsset. Returns true if the asset update can handle being abandoned.

Reimplemented from FRenderAssetUpdate.

◆ CancelIORequests()

void FTexture2DStreamIn_IO::CancelIORequests ( )
protected

◆ ClearIORequests()

void FTexture2DStreamIn_IO::ClearIORequests ( const FContext &  Context)
protected

◆ ReportIOError()

void FTexture2DStreamIn_IO::ReportIOError ( const FContext &  Context)
protected

◆ SetAsyncFileCallback()

void FTexture2DStreamIn_IO::SetAsyncFileCallback ( )
inlineprotected

◆ SetIORequests()

void FTexture2DStreamIn_IO::SetIORequests ( const FContext &  Context)
protected

Friends And Related Symbol Documentation

◆ FCancelIORequestsTask

friend class FCancelIORequestsTask
friend
The documentation for this class was generated from the following files: