UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Classes | Public Member Functions | Static Public Member Functions | List of all members
FD3D11GPUFence Class Referencefinal

#include <D3D11Resources.h>

+ Inheritance diagram for FD3D11GPUFence:

Public Member Functions

 FD3D11GPUFence (FName InName)
 
void Clear () override
 
bool Poll () const override
 
void Wait (FRHICommandListImmediate &RHICmdList, FRHIGPUMask GPUMask) const override
 
void WriteGPUFence_TopOfPipe (FRHICommandListBase &RHICmdList)
 
- Public Member Functions inherited from FRHIGPUFence
 FRHIGPUFence (FName InName)
 
virtual bool Poll (FRHIGPUMask GPUMask) const
 
FName GetFName () const
 
- Public Member Functions inherited from FRHIResource
RHI_API FRHIResource (ERHIResourceType InResourceType)
 
uint32 AddRef () const
 
uint32 Release () const
 
uint32 GetRefCount () const
 
bool IsValid () const
 
void DisableLifetimeExtension ()
 
ERHIResourceType GetType () const
 
FName GetOwnerName () const
 
void SetOwnerName (FName InOwnerName)
 

Static Public Member Functions

static void PollFences ()
 

Additional Inherited Members

- Public Attributes inherited from FRHIGPUFence
FThreadSafeCounter NumPendingWriteCommands
 
- Protected Member Functions inherited from FRHIResource
virtual RHI_API ~FRHIResource ()
 
- Protected Attributes inherited from FRHIGPUFence
const FName FenceName
 

Constructor & Destructor Documentation

◆ FD3D11GPUFence()

FD3D11GPUFence::FD3D11GPUFence ( FName  InName)

Member Function Documentation

◆ Clear()

void FD3D11GPUFence::Clear ( )
overridevirtual

Implements FRHIGPUFence.

◆ Poll()

bool FD3D11GPUFence::Poll ( ) const
overridevirtual

Poll the fence to see if the GPU has signaled it.

Returns
True if and only if the GPU fence has been inserted and the GPU has signaled the fence.

CAUTION: Do not call poll in a loop to block until completion. Some platform RHIs will not signal fences unless the RHI thread continues to make progress and submit GPU work.

To block for completion, call Wait(), which can only be done from the render thread.

Use Poll() only to check a fence. If it returns false, continue to do useful work and recheck later, ideally on the following frame.

Implements FRHIGPUFence.

◆ PollFences()

static void FD3D11GPUFence::PollFences ( )
inlinestatic

◆ Wait()

void FD3D11GPUFence::Wait ( FRHICommandListImmediate &  RHICmdList,
FRHIGPUMask  GPUMask 
) const
overridevirtual

Blocks the caller until the fence has passed on the GPU. Can only be called from the render thread.

CAUTION: Use of this function may cause a hitch if the fence is not yet signalled and we have to wait for the GPU to catch up. Rendering code should be written to avoid immediately waiting on GPU fences.

Implements FRHIGPUFence.

◆ WriteGPUFence_TopOfPipe()

void FD3D11GPUFence::WriteGPUFence_TopOfPipe ( FRHICommandListBase &  RHICmdList)
The documentation for this class was generated from the following files: