Class IStreamingHandler

Base interface for all streamable resource handlers that implement resource streaming policy.

IStreamingHandler
Assembly: FlaxEngine.dll
File: Engine/Streaming/IStreamingHandler.h
Syntax
public class IStreamingHandler

Constructors

~IStreamingHandler()

Declaration
public virtual ~IStreamingHandler() = default

Methods

CalculateRequestedResidency(StreamableResource* resource, int32 targetResidency)

Calculates the residency level to stream for a given resource and target residency.

Declaration
public virtual int32 CalculateRequestedResidency(StreamableResource* resource, int32 targetResidency) = 0
Parameters
StreamableResource resource

The resource.
int32 targetResidency

The target residency level.
Returns
int32

Residency level to stream

CalculateResidency(StreamableResource* resource, float quality)

Calculates the residency level for a given resource and quality level.

Declaration
public virtual int32 CalculateResidency(StreamableResource* resource, float quality) = 0
Parameters
StreamableResource resource

The resource.
float quality

The quality level (0-1).
Returns
int32

Residency level

CalculateTargetQuality(StreamableResource* resource, double currentTime)

Calculates target quality level (0-1) for the given resource.

Declaration
public virtual float CalculateTargetQuality(StreamableResource* resource, double currentTime) = 0
Parameters
StreamableResource resource

The resource.
double currentTime

The current platform time (seconds).
Returns
float

Target quality (0-1).

RequiresStreaming(StreamableResource* resource, int32 currentResidency, int32 targetResidency)

Determines if the specified resource requires the streaming.

Declaration
public virtual bool RequiresStreaming(StreamableResource* resource, int32 currentResidency, int32 targetResidency)
Parameters
StreamableResource resource

The resource.
int32 currentResidency

The current residency level.
int32 targetResidency

The target residency level.
Returns
bool

True if perform resource streaming, otherwise false.