FSlowTask::EnterProgressFrame

Indicate that we are to enter a frame that will take up the specified amount of work.

Choose your operating system:

Windows

macOS

Linux

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Misc/SlowTask.h

Include

#include "Misc/SlowTask.h"

Source

/Engine/Source/Runtime/Core/Private/Misc/SlowTask.cpp

Syntax

void EnterProgressFrame
(
    float ExpectedWorkThisFrame,
    const FText & Text
)

Remarks

Indicate that we are to enter a frame that will take up the specified amount of work. Completes any previous frames (potentially contributing to parent scopes' progress).

Parameters

Parameter

Description

ExpectedWorkThisFrame

The amount of work that will happen between now and the next frame, as a numerator of TotalAmountOfWork.

Text

Optional text to describe this frame's purpose.