Navigation
API > API/Runtime > API/Runtime/StateStream
Interface used by TStateStream to define all the GT/RT functions required to create/update/destroy the state stream on GT and to update/interpolate the result on RT
| Name | IStateStream |
| Type | class |
| Header File | /Engine/Source/Runtime/StateStream/Public/StateStream.h |
| Include Path | #include "StateStream.h" |
Syntax
class IStateStream
Derived Classes
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IStateStream() |
StateStream.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Game_BeginTick
(
uint32 LaneId |
Create current tick data that will be update later on. | StateStream.h | |
void Game_EndTick
(
StateStreamTime AbsoluteTime, |
Make the current tick available to the renderer (update oldest/newest ticks) and then reset it. | StateStream.h | |
void Game_Exit() |
Release all the instance/ticks/dynamic states stored within that stream. | StateStream.h | |
void * Game_GetVoidPointer() |
Get the state stream interface pointer. | StateStream.h | |
void Game_SetDefaultLane
(
uint32 LaneId |
Set the lane that will be used if provided lane is DefaultLaneId. | StateStream.h | |
uint32 GetId() |
Get the state stream id. | StateStream.h | |
void Render_Enable
(
bool Enable |
Enable the state stream render interpolation. | StateStream.h | |
void Render_Exit() |
Last update of the render dynamic state. | StateStream.h | |
void Render_GarbageCollect() |
Release all the ticks/data stored before the updated render tick. | StateStream.h | |
void Render_PostUpdate() |
Destroy the updated render state. | StateStream.h | |
void Render_Update
(
StateStreamTime AbsoluteTime |
Interpolate the instance render dynamic state from the available ticks [oldest-newest] given a time. | StateStream.h |
Public Virtual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Game_CreateLane() |
StateStream.h | ||
virtual void Game_DebugRender
(
IStateStreamDebugRenderer& Renderer |
Debug render streams data on GT. | StateStream.h | |
virtual void Game_DestroyLane
(
uint32 LaneId |
StateStream.h | ||
virtual void Game_SetLaneUserData
(
uint32 LaneId, |
StateStream.h | ||
virtual const TCHAR * GetDebugName() |
Get the state stream debug name. | StateStream.h |