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

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	bCachedReadyForStreaming	Cached value of IsReadyForStreaming().
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	bIsStreamable	Whether the texture is currently streamable or not.
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.
uint8	CachedNumResidentLODs	Cached value of GetNumResidentMips().
double	ForceMipLevelsToBeResidentTimestamp	WorldSettings timestamp that tells the streamer to force all miplevels to be resident up until that time.
uint8: 1	NeverStream
int32	NumCinematicMipLevels	Number of mip-levels to use for cinematic quality.
int32	StreamingIndex	FStreamingRenderAsset index used by the texture streaming system.

Constructors

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

Functions

	Name	Description
int32	CalcCumulativeLODSize ( int32 NumLODs )
int32	CalcNumOptionalMips()
bool	CancelPendingMipChangeRequest()	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.
uint8	GetCachedNumResidentLODs()
bool	GetCachedReadyForStreaming()
float	GetLastRenderTimeForStreaming()	Get the per-asset last render time.
int32	GetLODGroupForStreaming()	Get an integer representation of the LOD group
bool	GetMipDataFilename ( const int32 MipIndex, FString& OutBulkDataFilename )
int32	GetNumMipsForStreaming()	Get the total number of LODs including non-streamable and optional LODs
int32	GetNumNonStreamingMips()	Returns the number of LODs in this asset that are not able to be streamed
int32	GetNumRequestedMips()	When the asset is being updated from StreamIn() or StreamOut(), returns the number of LODs requested
int32	GetNumResidentMips()	The number of LODs currently in memory
bool	HasPendingUpdate()
void	InvalidateLastRenderTimeForStreaming()	Invalidates per-asset last render time.
bool	IsPendingUpdateLocked()
bool	IsReadyForStreaming()
void	SetCachedNumResidentLODs ( uint8 NewVal )
void	SetCachedReadyForStreaming ( bool NewVal )
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.
bool	UpdateStreamingStatus ( bool bWaitForMipFading )	Updates the streaming status of the asset and performs finalization when appropriate.

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

Take our survey

Dismiss