FRenderCommandFence Class Reference

#include <RenderCommandFence.h>

Public Types
enum class	ESyncDepth { RenderThread , RHIThread , Swapchain }

Public Member Functions
RENDERCORE_API void	BeginFence (ESyncDepth SyncDepth=ESyncDepth::RenderThread)
RENDERCORE_API void	Wait (bool bProcessGameThreadTasks=false) const
RENDERCORE_API bool	IsFenceComplete () const
RENDERCORE_API	FRenderCommandFence ()
RENDERCORE_API	~FRenderCommandFence ()

Detailed Description

Used to track pending rendering commands from the game thread.

Member Enumeration Documentation

ESyncDepth

enum class FRenderCommandFence::ESyncDepth

strong

Enumerator
RenderThread
RHIThread
Swapchain

Constructor & Destructor Documentation

FRenderCommandFence()

FRenderCommandFence::FRenderCommandFence ( )

default

~FRenderCommandFence()

FRenderCommandFence::~FRenderCommandFence ( )

default

Member Function Documentation

BeginFence()

void FRenderCommandFence::BeginFence

(

ESyncDepth

SyncDepth = ESyncDepth::RenderThread

)

Inserts this fence in the rendering pipeline.

Parameters

SyncDepth,determines

which stage of the pipeline will signal the fence.

IsFenceComplete()

bool FRenderCommandFence::IsFenceComplete

(

)

const

Wait()

void FRenderCommandFence::Wait

(

bool

bProcessGameThreadTasks = false

)

const

Waits for pending fence commands to retire.

Parameters

bProcessGameThreadTasks,if

true we are on a short callstack where it is safe to process arbitrary game thread tasks while we wait

Waits for pending fence commands to retire.

---

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

• Engine/Source/Runtime/RenderCore/Public/RenderCommandFence.h
• Engine/Source/Runtime/RenderCore/Private/RenderingThread.cpp