unreal.MovieGraphTimeStepData

class unreal.MovieGraphTimeStepData(output_frame_number: int = 0, frame_delta_time: float = 0.0, world_time_dilation: float = 0.0, world_seconds: float = 0.0, motion_blur_fraction: float = 0.0, is_first_temporal_sample_for_frame: bool = False, is_last_temporal_sample_for_frame: bool = False, requires_accumulator: bool = False, evaluated_config: MovieGraphEvaluatedConfig = Ellipsis)

Bases: StructBase

This data structure needs to be filled out each frame by the UMovieGraphTimeStepBase, which will eventually be passed to the renderer. It controls per-sample behavior such as the delta time, if this is the first/last sample for an output frame, etc.

C++ Source:

  • Plugin: MovieRenderPipeline

  • Module: MovieRenderPipelineCore

  • File: MovieGraphTimeStepData.h

Editor Properties: (see get_editor_property/set_editor_property)

  • evaluated_config (MovieGraphEvaluatedConfig): [Read-Write] The evaluated config holds the configuration used for this given frame. This pointer can potentially change each frame (if the graph for that frame is different) but users can rely on the EvaluatedConfig being correct for a given frame, thus all resolves (such as filenames) should use the config for that frame, not the latest one available.

  • frame_delta_time (float): [Read-Write]

  • is_first_temporal_sample_for_frame (bool): [Read-Write] Should be set to true for the first sample of each output frame. Used to determine if various systems need to reset or gather data for a new frame. Can be true at the same time as bIsLastTemporalSampleForFrame (ie: 1TS)

  • is_last_temporal_sample_for_frame (bool): [Read-Write] Should be set to true for the last sample of each output frame. Can be true at the same time as bIsFirstTemporalSampleForFrame (ie: 1TS)

  • motion_blur_fraction (float): [Read-Write]

  • output_frame_number (int32): [Read-Write]

  • requires_accumulator (bool): [Read-Write] Should be set to true for every sample if there is more than one temporal sample making up this render. This will cause the renderer to allocate accumulators to store the multi-frame data into.

  • world_seconds (float): [Read-Write]

  • world_time_dilation (float): [Read-Write]

property evaluated_config: MovieGraphEvaluatedConfig

[Read-Write] The evaluated config holds the configuration used for this given frame. This pointer can potentially change each frame (if the graph for that frame is different) but users can rely on the EvaluatedConfig being correct for a given frame, thus all resolves (such as filenames) should use the config for that frame, not the latest one available.

Type:

(MovieGraphEvaluatedConfig)

property frame_delta_time: float

[Read-Write]

Type:

(float)

property is_first_temporal_sample_for_frame: bool

[Read-Write] Should be set to true for the first sample of each output frame. Used to determine if various systems need to reset or gather data for a new frame. Can be true at the same time as bIsLastTemporalSampleForFrame (ie: 1TS)

Type:

(bool)

property is_last_temporal_sample_for_frame: bool

[Read-Write] Should be set to true for the last sample of each output frame. Can be true at the same time as bIsFirstTemporalSampleForFrame (ie: 1TS)

Type:

(bool)

property motion_blur_fraction: float

[Read-Write]

Type:

(float)

property output_frame_number: int

[Read-Write]

Type:

(int32)

property requires_accumulator: bool

[Read-Write] Should be set to true for every sample if there is more than one temporal sample making up this render. This will cause the renderer to allocate accumulators to store the multi-frame data into.

Type:

(bool)

property world_seconds: float

[Read-Write]

Type:

(float)

property world_time_dilation: float

[Read-Write]

Type:

(float)