Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > Engine > UStreamableRenderAsset

Light Theme

Dark Theme

UStreamableRenderAsset

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Engine/StreamableRenderAsset.h
Include	#include "Engine/StreamableRenderAsset.h"

Syntax

class UStreamableRenderAsset : public UObject

Variables

	Name	Description
uint8: 1	bForceMiplevelsToBeResident	Override whether to fully stream even if texture hasn't been rendered.
uint8: 1	bGlobalForceMipLevelsToBeResident	Global and serialized version of ForceMiplevelsToBeResident.
uint8: 1	bHasStreamingUpdatePending	Whether some mips might be streamed soon.
uint8: 1	bIgnoreStreamingMipBias	When forced fully resident, ignores the streaming mip bias used to accommodate memory constraints.
uint8: 1	bUseCinematicMipLevels	Whether to use the extra cinematic quality mip-levels, when we're forcing mip-levels to be resident.
int32	CachedCombinedLODBias	Cached combined group and texture LOD bias to use.
FStreamableRend...	CachedSRRState	Gamethread coherent state of the resource.
double	ForceMipLevelsToBeResidentTimestamp	WorldSettings timestamp that tells the streamer to force all miplevels to be resident up until that time.
TArray< FLODStr...	MipChangeCallbacks
uint8: 1	NeverStream
int32	NumCinematicMipLevels	Number of mip-levels to use for cinematic quality.
TRefCountPtr< c...	PendingUpdate	An update structure used to handle streaming strategy.
int32	StreamingIndex	FStreamingRenderAsset index used by the texture streaming system.

Constructors

	Name	Description
	UStreamableRenderAsset ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
int32	CalcCumulativeLODSize ( int32 NumLODs )
void	CancelPendingStreamingRequest()	Tries to cancel a pending LOD change request.
bool	DoesMipDataExist ( const int32 MipIndex )
int32	GetCachedLODBias()	Returns the cached combined LOD bias based on texture LOD group and LOD bias.
float	GetLastRenderTimeForStreaming()	Get the per-asset last render time.
int32	GetLODGroupForStreaming()	Get an integer representation of the LOD group
FIoFilenameH...	GetMipIoFilenameHash ( const int32 MipIndex )
EStreamableR...	GetRenderAssetType()
const FStrea...	GetStreamableResourceState()	Return the streaming state of the render resources.
int32	GetStreamingIndex()
bool	HasPendingInitOrStreaming ( bool bWaitForLODTransition )	Whether a stream in / out request is pending.
bool	HasPendingLODTransition()
bool	HasPendingRenderResourceInitialization()	Also returns false if the render resource is non existent, to prevent stalling on an event that will never complete.
void	InvalidateLastRenderTimeForStreaming()	Invalidates per-asset last render time.
bool	IsFullyStreamedIn()	Whether all miplevels of this texture have been fully streamed in, LOD settings permitting.
bool	IsPendingStreamingRequestLocked()	Whether there is a pending update and it is locked within an update step.
bool	IsStreamable()	Whether the current asset render resource is streamable from a gamethread timeline.
void	LinkStreaming()	Links texture to the texture streaming manager.
void	RegisterMipLevelChangeCallback ( UPrimitiveComponent* Component, int32 LODIdx, float TimeoutSecs, bool bOnStreamIn, FLODStreamingCallback&& Callback )	Register a callback to get notified when a certain mip or LOD is resident or evicted.
void	RemoveAllMipLevelChangeCallbacks()	Not thread safe and must be called on GT timeline but not necessarily on GT (e.g. ParallelFor called from GT).
void	RemoveMipLevelChangeCallback ( UPrimitiveComponent* Component )	Remove mip level change callbacks registered by a component.
bool	RenderResourceSupportsStreaming()	Whether the current asset render resource is streamable from a gamethread timeline.
void	SetForceMipLevelsToBeResident ( float Seconds, int32 CinematicLODGroupMask )	Tells the streaming system that it should force all mip-levels to be resident for a number of seconds.
bool	ShouldMipLevelsBeForcedResident()	Returns whether miplevels should be forced resident.
bool	StreamIn ( int32 NewMipCount, bool bHighPrio )	Loads mips from disk to memory. Only usable if the asset is streamable.
bool	StreamOut ( int32 NewMipCount )	Unload some mips from memory. Only usable if the asset is streamable.
void	TickMipLevelChangeCallbacks ( TArray< UStreamableRenderAsset*... )	Invoke registered mip level change callbacks.
void	TickStreaming ( bool bSendCompletionEvents, TArray< UStreamableRenderAsset*... )
void	UnlinkStreaming()	Unlinks texture from the texture streaming manager.
void	WaitForPendingInitOrStreaming ( bool bWaitForLODTransition, bool bSendCompletionEvents )	Wait for any pending operation (like InitResource and Streaming) to complete.
void	WaitForStreaming ( bool bWaitForLODTransition, bool bSendCompletionEvents )	Wait for any pending operation and make sure that the asset streamer has performed requested ops on this asset.

Overridden from UObject

		Name	Description
	void	BeginDestroy()	Called before destroying the object.
	bool	IsReadyForFinishDestroy()	Called to check if the object is ready for FinishDestroy.

Classes

	Name	Description
	FLODStreamingCallbackPayload

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

Take our survey

Dismiss