FTickableObjectRenderThread

This class provides common registration for render thread tickable objects.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

RenderCore

Header

/Engine/Source/Runtime/RenderCore/Public/TickableObjectRenderThread.h

Include

#include "TickableObjectRenderThread.h"

Syntax

class FTickableObjectRenderThread

Remarks

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

Constructors

Name Description

Public function

FTickableObjectRenderThread

(
    bool bRegisterImmediately,
    bool bInHighFrequency
)

Registers this instance with the static array of tickable objects.

Destructors

Name Description

Public function Virtual

~FTickableObjectRenderThread()

Removes this instance from the static array of tickable objects.

Functions

Name Description

Public function Const

TStatId

 

GetStatId()

Return the stat id to use for this tickable

Public function Const

bool

 

IsTickable()

Pure virtual that must be overloaded by the inheriting class.

Public function Virtual Const

bool

 

NeedsRenderingResumedForRenderingThreadTick()

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

Public function

void

 

Register

(
    bool bIsRenderingThreadObject
)

Registers the object for ticking.

Public function

void

 

Tick

(
    float DeltaTime
)

Pure virtual that must be overloaded by the inheriting class.

Public function

void

 

Unregister()

Classes

Name

Description

Public struct

FRenderingThreadTickableObjectsArray

Static array of tickable objects that are ticked from rendering thread

Constants

Name

Description

RenderingThreadHighFrequencyTickableObjects

RenderingThreadTickableObjects

Tick all rendering thread tickable objectsStatic array of tickable objects that are ticked from rendering thread

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback