1. Epic GamesDeveloper
  3. FTickableObjectRenderThread

FTickableObjectRenderThread

This class provides common registration for render thread tickable objects.

API > API/Runtime > API/Runtime/RenderCore

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

   
Name FTickableObjectRenderThread
Type class
Header File /Engine/Source/Runtime/RenderCore/Public/TickableObjectRenderThread.h
Include Path #include "TickableObjectRenderThread.h"

Syntax

class FTickableObjectRenderThread

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

FTickableObjectRenderThread ( bool bRegisterImmediately,
bool bInHighFrequency
)

 Registers this instance with the static array of tickable objects. TickableObjectRenderThread.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FTickableObjectRenderThread()

 Removes this instance from the static array of tickable objects. TickableObjectRenderThread.h  

Structs

Name Remarks
FRenderingThreadTickableObjectsArray Static array of tickable objects that are ticked from rendering thread

Constants

Name Type Remarks Include Path
RenderingThreadHighFrequencyTickableObjects FRenderingThreadTickableObjectsArray   TickableObjectRenderThread.h
RenderingThreadTickableObjects FRenderingThreadTickableObjectsArray Static array of tickable objects that are ticked from rendering thread TickableObjectRenderThread.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bHighFrequency const bool   TickableObjectRenderThread.h  
bRegistered bool   TickableObjectRenderThread.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

TStatId GetStatId()

 Return the stat id to use for this tickable TickableObjectRenderThread.h  

bool IsTickable ()

 Pure virtual that must be overloaded by the inheriting class. TickableObjectRenderThread.h  

virtual bool NeedsRenderingResumedForRenderingThreadTick()

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

void Register ()

 Registers the object for ticking. TickableObjectRenderThread.h  

void Register ( bool bIsRenderingThreadObject
)

   TickableObjectRenderThread.h  

void Tick ( FRHICommandListImmediate& RHICmdList,
float DeltaTime
)

 Pure virtual that must be overloaded by the inheriting class. TickableObjectRenderThread.h  

void Unregister()

   TickableObjectRenderThread.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page