Navigation
API > API/Plugins > API/Plugins/XRBase
Overloads
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ExecuteOnRenderThread
(
const TFunctionRef< void()>& Function |
Utility function for easily running a TFunctionRef on the render thread. | XRThreadUtils.h | |
void ExecuteOnRenderThread
(
const TFunctionRef< void(FRHICommandListImmediate&)>& Function |
Utility function for easily running a TFunctionRef on the render thread. | XRThreadUtils.h |
ExecuteOnRenderThread(const TFunctionRef< void()> &)
Description
Utility function for easily running a TFunctionRef 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. This method will flush rendering commands meaning that the function will be executed before ExecuteOnRenderThread returns.
| Name | ExecuteOnRenderThread |
| Type | function |
| Header File | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRThreadUtils.h |
| Include Path | #include "XRThreadUtils.h" |
| Source | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Private/XRThreadUtils.cpp |
void ExecuteOnRenderThread
(
const TFunctionRef< void()> & Function
)
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
| Name | Remarks |
|---|---|
| Function | the Function to be invoked on the render thread. |
ExecuteOnRenderThread(const TFunctionRef< void(FRHICommandListImmediate &)> &)
Description
Utility function for easily running a TFunctionRef 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. This method will flush rendering commands meaning that the function will be executed before ExecuteOnRenderThread returns.
| Name | ExecuteOnRenderThread |
| Type | function |
| Header File | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Public/XRThreadUtils.h |
| Include Path | #include "XRThreadUtils.h" |
| Source | /Engine/Plugins/Runtime/XRBase/Source/XRBase/Private/XRThreadUtils.cpp |
void ExecuteOnRenderThread
(
const TFunctionRef< void(FRHICommandListImmediate &)> & Function
)
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
| Name | Remarks |
|---|---|
| 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. |