FRenderCommandPipe Class Reference

#include <RenderingThread.h>

Inheritance diagram for FRenderCommandPipe:

Public Types
using	FCommandListFunction = TUniqueFunction< void(FRHICommandList &)>
using	FEmptyFunction = TUniqueFunction< void()>

Public Member Functions
RENDERCORE_API	FRenderCommandPipe (const TCHAR *Name, ERenderCommandPipeFlags Flags, const TCHAR *CVarName, const TCHAR *CVarDescription)
const TCHAR *	GetName () const
bool	IsValid () const
int32	GetIndex () const
bool	IsReplaying () const
bool	IsRecording () const
bool	IsEmpty () const
void	SetEnabled (bool bInIsEnabled)
bool	Enqueue (FRenderCommandList *RenderCommandList)
template<typename RenderCommandTag >
bool	Enqueue (FCommandListFunction &Function)
template<typename RenderCommandTag >
bool	Enqueue (FEmptyFunction &Function)
Public Member Functions inherited from FRenderCommandPipeBase
	~FRenderCommandPipeBase ()

Friends
class	FRenderCommandPipeRegistry
class	FRenderCommandDispatcher

Additional Inherited Members
Protected Member Functions inherited from FRenderCommandPipeBase
void	ResetContext ()
Protected Attributes inherited from FRenderCommandPipeBase
FContext *	Context = new FContext
UE::FMutex	Mutex

Member Typedef Documentation

FCommandListFunction

using FRenderCommandPipe::FCommandListFunction = TUniqueFunction<void(FRHICommandList&)>

FEmptyFunction

using FRenderCommandPipe::FEmptyFunction = TUniqueFunction<void()>

Constructor & Destructor Documentation

FRenderCommandPipe()

FRenderCommandPipe::FRenderCommandPipe	(	const TCHAR *	Name,
		ERenderCommandPipeFlags	Flags,
		const TCHAR *	CVarName,
		const TCHAR *	CVarDescription
	)

Member Function Documentation

Enqueue() [1/3]

template<typename RenderCommandTag >

bool FRenderCommandPipe::Enqueue ( FCommandListFunction &  Function )

inline

Enqueue() [2/3]

template<typename RenderCommandTag >

bool FRenderCommandPipe::Enqueue ( FEmptyFunction &  Function )

inline

Enqueue() [3/3]

bool FRenderCommandPipe::Enqueue ( FRenderCommandList *  RenderCommandList )

inline

GetIndex()

int32 FRenderCommandPipe::GetIndex ( ) const

inline

GetName()

const TCHAR * FRenderCommandPipe::GetName ( ) const

inline

IsEmpty()

bool FRenderCommandPipe::IsEmpty ( ) const

inline

IsRecording()

bool FRenderCommandPipe::IsRecording ( ) const

inline

IsReplaying()

bool FRenderCommandPipe::IsReplaying ( ) const

inline

IsValid()

bool FRenderCommandPipe::IsValid ( ) const

inline

SetEnabled()

void FRenderCommandPipe::SetEnabled ( bool  bInIsEnabled )

inline

Friends And Related Symbol Documentation

FRenderCommandDispatcher

friend class FRenderCommandDispatcher

friend

FRenderCommandPipeRegistry

friend class FRenderCommandPipeRegistry

friend

---

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

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