FTickableObjectRenderThread Class Reference

#include <TickableObjectRenderThread.h>

Inheritance diagram for FTickableObjectRenderThread:

Classes
struct	FRenderingThreadTickableObjectsArray

Public Member Functions
	FTickableObjectRenderThread (bool bRegisterImmediately=true, bool bInHighFrequency=false)
virtual	~FTickableObjectRenderThread ()
void	Unregister ()
void	Register ()
void	Register (bool bIsRenderingThreadObject)
virtual void	Tick (FRHICommandListImmediate &RHICmdList, float DeltaTime)=0
virtual TStatId	GetStatId () const =0
virtual bool	IsTickable () const =0
virtual bool	NeedsRenderingResumedForRenderingThreadTick () const

Static Public Attributes
static RENDERCORE_API FRenderingThreadTickableObjectsArray	RenderingThreadTickableObjects
static RENDERCORE_API FRenderingThreadTickableObjectsArray	RenderingThreadHighFrequencyTickableObjects

Detailed Description

This class provides common registration for render thread tickable objects. It is an abstract base class requiring you to implement the Tick() method.

Constructor & Destructor Documentation

FTickableObjectRenderThread()

FTickableObjectRenderThread::FTickableObjectRenderThread ( bool  bRegisterImmediately = true, bool  bInHighFrequency = false  )

inline

Registers this instance with the static array of tickable objects.

Parameters

bRegisterImmediately

true if the object should be registered immediately.

~FTickableObjectRenderThread()

virtual FTickableObjectRenderThread::~FTickableObjectRenderThread ( )

inlinevirtual

Removes this instance from the static array of tickable objects.

Member Function Documentation

GetStatId()

virtual TStatId FTickableObjectRenderThread::GetStatId ( ) const

pure virtual

return the stat id to use for this tickable

Implemented in FShaderPipelineCache, FGlobalDynamicMeshIndexPool, FGlobalDynamicMeshVertexPool, FBoneBufferPool, FClothBufferPool, and FDefaultGameMoviePlayer.

IsTickable()

virtual bool FTickableObjectRenderThread::IsTickable ( ) const

pure virtual

Pure virtual that must be overloaded by the inheriting class. It is used to determine whether an object is ready to be ticked. This is required for example for all UObject derived classes as they might be loaded async and therefore won't be ready immediately.

Returns

true if class is ready to be ticked, false otherwise.

Implemented in FShaderPipelineCache, TRenderResourcePool< ResourceType, ResourcePoolPolicy, ResourceCreationArguments >, TRenderResourcePool< FBufferRHIRef, FGlobalDynamicMeshIndexPolicy, FGlobalDynamicMeshPoolPolicy::CreationArguments >, TRenderResourcePool< FBufferRHIRef, FGlobalDynamicMeshVertexPolicy, FGlobalDynamicMeshPoolPolicy::CreationArguments >, TRenderResourcePool< FVertexBufferAndSRV, FBoneBufferPoolPolicy, FSharedPoolPolicyData::CreationArguments >, TRenderResourcePool< FVertexBufferAndSRV, FClothBufferPoolPolicy, FSharedPoolPolicyData::CreationArguments >, and FDefaultGameMoviePlayer.

NeedsRenderingResumedForRenderingThreadTick()

virtual bool FTickableObjectRenderThread::NeedsRenderingResumedForRenderingThreadTick ( ) const

inlinevirtual

Used to determine if a rendering thread tickable object must have rendering in a non-suspended state during it's Tick function.

Returns

true if the RHIResumeRendering should be called before tick if rendering has been suspended

Reimplemented in FShaderPipelineCache, TRenderResourcePool< ResourceType, ResourcePoolPolicy, ResourceCreationArguments >, TRenderResourcePool< FBufferRHIRef, FGlobalDynamicMeshIndexPolicy, FGlobalDynamicMeshPoolPolicy::CreationArguments >, TRenderResourcePool< FBufferRHIRef, FGlobalDynamicMeshVertexPolicy, FGlobalDynamicMeshPoolPolicy::CreationArguments >, TRenderResourcePool< FVertexBufferAndSRV, FBoneBufferPoolPolicy, FSharedPoolPolicyData::CreationArguments >, and TRenderResourcePool< FVertexBufferAndSRV, FClothBufferPoolPolicy, FSharedPoolPolicyData::CreationArguments >.

Register() [1/2]

void FTickableObjectRenderThread::Register ( )

inline

Registers the object for ticking.

Register() [2/2]

void FTickableObjectRenderThread::Register ( bool  bIsRenderingThreadObject )

inline

Tick()

virtual void FTickableObjectRenderThread::Tick ( FRHICommandListImmediate &  RHICmdList, float  DeltaTime  )

pure virtual

Pure virtual that must be overloaded by the inheriting class. It will be called from the rendering thread.

Parameters

DeltaTime

Game time passed since the last call.

Implemented in FShaderPipelineCache, TRenderResourcePool< ResourceType, ResourcePoolPolicy, ResourceCreationArguments >, TRenderResourcePool< FBufferRHIRef, FGlobalDynamicMeshIndexPolicy, FGlobalDynamicMeshPoolPolicy::CreationArguments >, TRenderResourcePool< FBufferRHIRef, FGlobalDynamicMeshVertexPolicy, FGlobalDynamicMeshPoolPolicy::CreationArguments >, TRenderResourcePool< FVertexBufferAndSRV, FBoneBufferPoolPolicy, FSharedPoolPolicyData::CreationArguments >, TRenderResourcePool< FVertexBufferAndSRV, FClothBufferPoolPolicy, FSharedPoolPolicyData::CreationArguments >, and FDefaultGameMoviePlayer.

Unregister()

void FTickableObjectRenderThread::Unregister ( )

inline

Member Data Documentation

RenderingThreadHighFrequencyTickableObjects

FTickableObjectRenderThread::FRenderingThreadTickableObjectsArray FTickableObjectRenderThread::RenderingThreadHighFrequencyTickableObjects

static

RenderingThreadTickableObjects

FTickableObjectRenderThread::FRenderingThreadTickableObjectsArray FTickableObjectRenderThread::RenderingThreadTickableObjects

static

Static array of tickable objects that are ticked from rendering thread

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/RenderCore/Public/TickableObjectRenderThread.h
• Engine/Source/Runtime/RenderCore/Private/TickableObjectRenderThread.cpp