unreal.MovieGraphOutputBurnInNode

class unreal.MovieGraphOutputBurnInNode(outer: Object | None = None, name: Name | str = 'None')

Bases: MovieGraphBurnInNode

A node which generates a widget burn-in, rendered to a standalone image or composited on top of a render layer.

This node is not meant to be added by the user directly. Instead, it’s injected into the graph by a specific output node (eg, JPG). It can control which output type(s) write it out (see the OutputRestriction property).

C++ Source:

  • Plugin: MovieRenderPipeline

  • Module: MovieRenderPipelineCore

  • File: MovieGraphBurnInNode.h

Editor Properties: (see get_editor_property/set_editor_property)

  • burn_in_class (SoftClassPath): [Read-Write] The widget that the burn-in should use.

  • composite_onto_final_image (bool): [Read-Write] If true, the pass will be composited onto each render. Does not apply to multi-layer EXR files.

  • dynamic_properties (InstancedPropertyBag): [Read-Write] Properties which can be dynamically declared on the node (vs. native properties which are always present).

  • file_name_format (str): [Read-Write] If not composited, this is the format string used for the file name that the burn-in is written to.

  • layer_name_format (str): [Read-Write] For multi-layer output formats, this is the format string used to generate the layer name.

  • output_name (str): [Read-Write] The name of the output that is associated with this burn-in (eg, “JPG”). Will be used as the instance name for the node, so it should be unique if multiple burn-in nodes need to co-exist in the same branch.

  • output_restriction (SoftClassPath): [Read-Write] The type(s) of nodes that can write out this burn-in. If no output types are specified, all active output types will write out the burn-in.

  • override_b_composite_onto_final_image (bool): [Read-Write]

  • override_burn_in_class (bool): [Read-Write]

  • override_file_name_format (bool): [Read-Write]

  • override_layer_name_format (bool): [Read-Write]

  • override_output_name (bool): [Read-Write]

  • override_output_restriction (bool): [Read-Write]

  • override_renderer_name (bool): [Read-Write]

  • override_renderer_sub_name (bool): [Read-Write]

  • renderer_name (str): [Read-Write] The value that will be used in the {renderer_name} token.

  • renderer_sub_name (str): [Read-Write] The value that will be used in the {renderer_sub_name} token.

  • script_tags (Array[str]): [Read-Write] Tags that can be used to identify this node within a pre/post render script. Tags can be unique in order to identify this specific node, or the same tag can be applied to multiple nodes in order to identify a grouping of nodes.

property file_name_format: str

[Read-Write] If not composited, this is the format string used for the file name that the burn-in is written to.

Type:

(str)

property layer_name_format: str

[Read-Write] For multi-layer output formats, this is the format string used to generate the layer name.

Type:

(str)

property output_name: str

[Read-Write] The name of the output that is associated with this burn-in (eg, “JPG”). Will be used as the instance name for the node, so it should be unique if multiple burn-in nodes need to co-exist in the same branch.

Type:

(str)

property output_restriction: SoftClassPath

[Read-Write] The type(s) of nodes that can write out this burn-in. If no output types are specified, all active output types will write out the burn-in.

Type:

(SoftClassPath)

property override_file_name_format: bool

[Read-Write]

Type:

(bool)

property override_layer_name_format: bool

[Read-Write]

Type:

(bool)

property override_output_name: bool

[Read-Write]

Type:

(bool)

property override_output_restriction: bool

[Read-Write]

Type:

(bool)