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

Protected variable

uint8: 1

 

bCachedReadyForStreaming

Cached value of IsReadyForStreaming().

Public variable

uint8: 1

 

bForceMiplevelsToBeResident

Override whether to fully stream even if texture hasn't been rendered.

Public variable

uint8: 1

 

bGlobalForceMipLevelsToBeResident

Global and serialized version of ForceMiplevelsToBeResident.

Public variable

uint8: 1

 

bHasStreamingUpdatePending

Whether some mips might be streamed soon.

Public variable

uint8: 1

 

bIgnoreStreamingMipBias

Ignores the streaming mip bias used to accommodate memory constraints.

Public variable

uint8: 1

 

bIsStreamable

Whether the texture is currently streamable or not.

Protected variable

uint8: 1

 

bUseCinematicMipLevels

Whether to use the extra cinematic quality mip-levels, when we're forcing mip-levels to be resident.

Protected variable

int32

 

CachedCombinedLODBias

Cached combined group and texture LOD bias to use.

Protected variable

uint8

 

CachedNumResidentLODs

Cached value of GetNumResidentMips().

Protected variable

double

 

ForceMipLevelsToBeResidentTimestamp

WorldSettings timestamp that tells the streamer to force all miplevels to be resident up until that time.

Public variable

uint8: 1

 

NeverStream

Public variable

int32

 

NumCinematicMipLevels

Number of mip-levels to use for cinematic quality.

Protected variable

int32

 

StreamingIndex

FStreamingRenderAsset index used by the texture streaming system.

Constructors

Name Description

Public function

UStreamableRenderAsset

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Virtual Const

int32

 

CalcCumulativeLODSize

(
    int32 NumLODs
)

Public function Virtual Const

int32

 

CalcNumOptionalMips()

Public function Virtual

bool

 

CancelPendingMipChangeRequest()

Tries to cancel a pending LOD change request.

Public function Const

int32

 

GetCachedLODBias()

Returns the cached combined LOD bias based on texture LOD group and LOD bias.

Public function Const

uint8

 

GetCachedNumResidentLODs()

Public function Const

bool

 

GetCachedReadyForStreaming()

Public function Virtual Const

float

 

GetLastRenderTimeForStreaming()

Get the per-asset last render time.

Public function Virtual Const

int32

 

GetLODGroupForStreaming()

Get an integer representation of the LOD group

Public function Virtual Const

bool

 

GetMipDataFilename

(
    const int32 MipIndex,
    FString& OutBulkDataFilename
)

Public function Virtual Const

int32

 

GetNumMipsForStreaming()

Get the total number of LODs including non-streamable and optional LODs

Public function Virtual Const

int32

 

GetNumNonStreamingMips()

Returns the number of LODs in this asset that are not able to be streamed

Public function Virtual Const

int32

 

GetNumRequestedMips()

When the asset is being updated from StreamIn() or StreamOut(), returns the number of LODs requested

Public function Virtual Const

int32

 

GetNumResidentMips()

The number of LODs currently in memory

Public function Virtual Const

bool

 

HasPendingUpdate()

Public function Virtual

void

 

InvalidateLastRenderTimeForStreaming()

Invalidates per-asset last render time.

Public function Virtual Const

bool

 

IsPendingUpdateLocked()

Public function Virtual Const

bool

 

IsReadyForStreaming()

Public function

void

 

SetCachedNumResidentLODs

(
    uint8 NewVal
)

Public function

void

 

SetCachedReadyForStreaming

(
    bool NewVal
)

Public function

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.

Public function Virtual Const

bool

 

ShouldMipLevelsBeForcedResident()

Returns whether miplevels should be forced resident.

Public function Virtual

bool

 

StreamIn

(
    int32 NewMipCount,
    bool bHighPrio
)

Loads mips from disk to memory. Only usable if the asset is streamable.

Public function Virtual

bool

 

StreamOut

(
    int32 NewMipCount
)

Unload some mips from memory. Only usable if the asset is streamable.

Public function Virtual

bool

 

UpdateStreamingStatus

(
    bool bWaitForMipFading
)

Updates the streaming status of the asset and performs finalization when appropriate.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback