Navigation
API > API/Plugins > API/Plugins/GeometryCacheStreamer
Interface to stream GeometryCacheMeshData asynchronously from any source through the GeometryCacheStreamer
| Name | IGeometryCacheStream |
| Type | class |
| Header File | /Engine/Plugins/Runtime/GeometryCache/Source/GeometryCacheStreamer/Public/IGeometryCacheStream.h |
| Include Path | #include "IGeometryCacheStream.h" |
Syntax
class IGeometryCacheStream
Derived Classes
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IGeometryCacheStream() |
IGeometryCacheStream.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
int32 CancelRequests() |
Cancel the scheduled read requests. Return the number of requests that were canceled | IGeometryCacheStream.h | |
bool GetFrameData
(
int32 FrameIndex, |
Get the MeshData at given FrameIndex without waiting for data to be ready Return true if MeshData could be retrieved | IGeometryCacheStream.h | |
uint32 GetNumFramesNeeded() |
Return the number of frame indices needed to be loaded | IGeometryCacheStream.h | |
const FGeometryCacheStreamStats & GetStreamStats() |
Return the memory usage and related stats for the stream | IGeometryCacheStream.h | |
void Prefetch
(
int32 StartFrameIndex, |
Prefetch NumFrames starting from the given StartFrameIndex. | IGeometryCacheStream.h | |
bool RequestFrameData () |
Request a read of the next frame as determined by the stream. | IGeometryCacheStream.h | |
void SetLimits
(
float MaxMemoryAllowed, |
Set the memory usage limits for the stream | IGeometryCacheStream.h | |
void UpdateRequestStatus
(
TArray< int32 >& OutFramesCompleted |
Update the status of the read requests currently in progress. | IGeometryCacheStream.h |