ExecuteOnRenderThread_DoNotWait

Utility function for easily submitting [TFunction](API\Runtime\Core\GenericPlatform\TFunction) to be run on the render thread.

Windows
MacOS
Linux

References

Module

HeadMountedDisplay

Header

/Engine/Source/Runtime/HeadMountedDisplay/Public/XRThreadUtils.h

Include

#include "XRThreadUtils.h"

Source

/Engine/Source/Runtime/HeadMountedDisplay/Private/XRThreadUtils.cpp

Syntax

void ExecuteOnRenderThread_DoNotWait
(
    const TFunction< void &)> & Function
)

Remarks

Utility function for easily submitting TFunction to be run on the render thread. Must be invoked from the game thread. If rendering does not use a separate thread, the TFunction will be executed immediately, otherwise it will be added to the render thread task queue.

Returns

true if the function was queued, false if rendering does not use a separate thread, in which case, the function has already been executed.

Parameters

Parameter

Description

Function

the Function to be invoked on the render thread. When executed, it will get the current FRHICommandList instance passed in as its sole argument.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss