unreal.FrameMetrics

class unreal.FrameMetrics(total_elapsed_time=0.0, frame_delta=0.0, frame_number=0, num_dropped_frames=0)

Bases: unreal.StructBase

Metrics that correspond to a particular frame

C++ Source:

  • Module: MovieSceneCapture

  • File: MovieSceneCaptureProtocolBase.h

Editor Properties: (see get_editor_property/set_editor_property)

  • frame_delta (float): [Read-Write] Frame Delta: The total amount of time, in seconds, that this specific frame took to render (not accounting for dropped frames)

  • frame_number (int32): [Read-Write] Frame Number: The index of this frame from the start of the capture, including dropped frames

  • num_dropped_frames (int32): [Read-Write] Num Dropped Frames: The number of frames we dropped in-between this frame, and the last one we captured

  • total_elapsed_time (float): [Read-Write] Total Elapsed Time: The total amount of time, in seconds, since the capture started

property frame_delta

[Read-Only] Frame Delta: The total amount of time, in seconds, that this specific frame took to render (not accounting for dropped frames)

Type

(float)

property frame_number

[Read-Only] Frame Number: The index of this frame from the start of the capture, including dropped frames

Type

(int32)

property num_dropped_frames

[Read-Only] Num Dropped Frames: The number of frames we dropped in-between this frame, and the last one we captured

Type

(int32)

property total_elapsed_time

[Read-Only] Total Elapsed Time: The total amount of time, in seconds, since the capture started

Type

(float)