RenderCommandFence.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Tasks/Task.h"
 
// Render fences
 
class FRenderCommandFence
{
public:
    enum class ESyncDepth
    {
        // The fence will be signalled by the render thread.
        RenderThread,
 
        // The fence will be enqueued to the RHI thread via a command on the immediate command list
        // and signalled once all prior parallel translation and submission is complete.
        RHIThread,
 
        // The fence will be signalled according to the rate of flips in the swapchain.
        // This is only supported on some platforms. On unsupported platforms, this behaves like RHIThread mode.
        Swapchain
    };
 
    RENDERCORE_API void BeginFence(ESyncDepth SyncDepth = ESyncDepth::RenderThread);
 
    RENDERCORE_API void Wait(bool bProcessGameThreadTasks = false) const;
 
    // return true if the fence is complete
    RENDERCORE_API bool IsFenceComplete() const;
 
    // Ctor/dtor
    RENDERCORE_API FRenderCommandFence();
    RENDERCORE_API ~FRenderCommandFence();
 
private:
    mutable UE::Tasks::FTask CompletionTask;
};