unreal.NiagaraRendererReadbackParameters

class unreal.NiagaraRendererReadbackParameters(coordinate_space: NiagaraRendererReadbackCoordinateSpace = Ellipsis, export_position: bool = False, export_tangent_basis: bool = False, export_color: bool = False, export_num_tex_coords: int = 0, export_tex_coord_bindings: None = [], export_materials: bool = False, apply_wpo: bool = False, view_index_to_capture: int | None = Ellipsis)

Bases: StructBase

Niagara Renderer Readback Parameters

C++ Source:

  • Plugin: Niagara

  • Module: Niagara

  • File: NiagaraRendererReadback.h

Editor Properties: (see get_editor_property/set_editor_property)

  • apply_wpo (bool): [Read-Write] When enabled material WPO will be included in the exported data

  • coordinate_space (NiagaraRendererReadbackCoordinateSpace): [Read-Write] What coordinate space to use when capturing positions / tangents / etc.

  • export_color (bool): [Read-Write] When enabled vertex colors will be exported

  • export_materials (bool): [Read-Write] When enabled we will attempt to export the materials used with each section When disabled no materials will be assigned, so the default material will be used

  • export_num_tex_coords (int32): [Read-Write] How many vertex texture coordinates to export

  • export_position (bool): [Read-Write] When enabled vertex positions will be exported

  • export_tangent_basis (bool): [Read-Write] When enabled the vertex tangent basis will be exported

  • export_tex_coord_bindings (Array[NiagaraRendererReadbackAttribute]): [Read-Write] Optional custom bindings for texture coordinate packing from the export process TexCoord0.X -> TexCoord0.Y, TexCoord1.X -> etc

  • view_index_to_capture (Optional[int32]): [Read-Write] When set we capture the batches from the view index provided When unset we capture batches from all views

property apply_wpo: bool

[Read-Write] When enabled material WPO will be included in the exported data

Type:

(bool)

property coordinate_space: NiagaraRendererReadbackCoordinateSpace

[Read-Write] What coordinate space to use when capturing positions / tangents / etc.

Type:

(NiagaraRendererReadbackCoordinateSpace)

property export_color: bool

[Read-Write] When enabled vertex colors will be exported

Type:

(bool)

property export_materials: bool

[Read-Write] When enabled we will attempt to export the materials used with each section When disabled no materials will be assigned, so the default material will be used

Type:

(bool)

property export_num_tex_coords: int

[Read-Write] How many vertex texture coordinates to export

Type:

(int32)

property export_position: bool

[Read-Write] When enabled vertex positions will be exported

Type:

(bool)

property export_tangent_basis: bool

[Read-Write] When enabled the vertex tangent basis will be exported

Type:

(bool)

property export_tex_coord_bindings: None

[Read-Write] Optional custom bindings for texture coordinate packing from the export process TexCoord0.X -> TexCoord0.Y, TexCoord1.X -> etc

Type:

(Array[NiagaraRendererReadbackAttribute])

property view_index_to_capture: int | None

[Read-Write] When set we capture the batches from the view index provided When unset we capture batches from all views

Type:

(Optional[int32])