Navigation
API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/USparseVolumeTextureFrame
Description
Retrieves a frame from the given SparseVolumeTexture and also issues a streaming request for it. StreamingInstanceKey can be any arbitrary value that is suitable to keep track of the source of requests for a given SVT. This key is used internally to associate incoming requests with prior requests issued for the same SVT. A good value to pass here might be the pointer of the component the SVT is used within. FrameRate is an optional argument which helps to more accurately predict the required bandwidth when using non-blocking requests. FrameIndex is of float type so that the streaming system can use the fractional part to more easily keep track of playback speed and direction (forward/reverse playback). MipLevel is the lowest mip level that the caller intends to use but does not guarantee that the mip is actually resident. If bBlocking is true, DDC streaming requests will block on completion, guaranteeing that the requested frame will have been streamed in after the next streaming system update. If streaming cooked data from disk, the highest priority will be used, but no guarantee is given. if bHasValidFrameRate is true, the FrameRate argument will be use to predict the required streaming IO bandwidth.
| Name | GetFrameAndIssueStreamingRequest |
| Type | function |
| Header File | /Engine/Source/Runtime/Engine/Classes/SparseVolumeTexture/SparseVolumeTexture.h |
| Include Path | #include "SparseVolumeTexture/SparseVolumeTexture.h" |
| Source | /Engine/Source/Runtime/Engine/Private/SparseVolumeTexture/SparseVolumeTexture.cpp |
static USparseVolumeTextureFrame * GetFrameAndIssueStreamingRequest
(
USparseVolumeTexture * SparseVolumeTexture,
uint32 StreamingInstanceKey,
float FrameRate,
float FrameIndex,
float MipLevel,
bool bBlocking,
bool bHasValidFrameRate
)