unreal.MoviePipelineSegmentWorkMetrics

class unreal.MoviePipelineSegmentWorkMetrics(segment_name='', output_frame_index=- 1, total_output_frame_count=- 1, output_sub_sample_index=- 1, total_sub_sample_count=- 1, engine_warm_up_frame_index=- 1, total_engine_warm_up_frame_count=- 1)

Bases: unreal.StructBase

Movie Pipeline Segment Work Metrics

C++ Source:

  • Plugin: MovieRenderPipeline

  • Module: MovieRenderPipelineCore

  • File: MovieRenderPipelineDataTypes.h

Editor Properties: (see get_editor_property/set_editor_property)

  • engine_warm_up_frame_index (int32): [Read-Only] The index of the engine warm up frame that we are working on. No rendering samples are produced for these.

  • output_frame_index (int32): [Read-Only] Index of the output frame we are working on right now.

  • output_sub_sample_index (int32): [Read-Only] Which temporal/spatial sub sample are we working on right now. This counts temporal, spatial, and tile samples to accurately reflect how much work is needed for this output frame.

  • segment_name (str): [Read-Only] The name of the segment (if any)

  • total_engine_warm_up_frame_count (int32): [Read-Only] The total number of engine warm up frames for this segment.

  • total_output_frame_count (int32): [Read-Only] The number of output frames we expect to make for this segment.

  • total_sub_sample_count (int32): [Read-Only] The total number of samples we will have to build to render this output frame.

property engine_warm_up_frame_index

[Read-Only] The index of the engine warm up frame that we are working on. No rendering samples are produced for these.

Type

(int32)

property output_frame_index

[Read-Only] Index of the output frame we are working on right now.

Type

(int32)

property output_sub_sample_index

[Read-Only] Which temporal/spatial sub sample are we working on right now. This counts temporal, spatial, and tile samples to accurately reflect how much work is needed for this output frame.

Type

(int32)

property segment_name

[Read-Only] The name of the segment (if any)

Type

(str)

property total_engine_warm_up_frame_count

[Read-Only] The total number of engine warm up frames for this segment.

Type

(int32)

property total_output_frame_count

[Read-Only] The number of output frames we expect to make for this segment.

Type

(int32)

property total_sub_sample_count

[Read-Only] The total number of samples we will have to build to render this output frame.

Type

(int32)