unreal.NiagaraDataInterfaceGrid2DCollection

class unreal.NiagaraDataInterfaceGrid2DCollection(outer=None, name='None')

Bases: unreal.NiagaraDataInterfaceGrid2D

Niagara Data Interface Grid 2DCollection

C++ Source:

  • Plugin: Niagara

  • Module: Niagara

  • File: NiagaraDataInterfaceGrid2DCollection.h

Editor Properties: (see get_editor_property/set_editor_property)

  • iteration_shader_stages (Set(int32)): [Read-Write] Iteration Shader Stages

  • num_attributes (int32): [Read-Write] Number of Attributes

  • num_cells_max_axis (int32): [Read-Write] Number of cells on the longest axis

  • num_cells_x (int32): [Read-Write] Number of cells in X

  • num_cells_y (int32): [Read-Write] Number of cells in Y

  • output_shader_stages (Set(int32)): [Read-Write] Output Shader Stages

  • override_buffer_format (NiagaraGpuBufferFormat): [Read-Write] When enabled overrides the format used to store data inside the grid, otherwise uses the project default setting. Lower bit depth formats will save memory and performance at the cost of precision.

  • override_format (bool): [Read-Write] Override Format

  • preview_attribute (Name): [Read-Write] When enabled allows you to preview the grid in a debug display

  • preview_grid (bool): [Read-Write] Preview Grid

  • render_target_user_parameter (NiagaraUserParameterBinding): [Read-Write] Reference to a user parameter if we’re reading one.

  • set_grid_from_max_axis (bool): [Read-Write] Set grid resolution according to longest axis

  • world_b_box_size (Vector2D): [Read-Write] World size of the grid

fill_raw_texture2d(component, dest) → (tiles_x=int32, tiles_y=int32) or None

Fill Raw Texture 2D deprecated: This function has been replaced by object user variables on the emitter to specify render targets to fill with data.

Parameters
Returns

tiles_x (int32):

tiles_y (int32):

Return type

tuple or None

fill_texture2d(component, dest, attribute_index) → bool

Fills a texture render target 2d with the current data from the simulation #todo(dmp): this will eventually go away when we formalize how data makes it out of Niagara deprecated: This function has been replaced by object user variables on the emitter to specify render targets to fill with data.

Parameters
Returns

Return type

bool

get_raw_texture_size(component) -> (size_x=int32, size_y=int32)

Get Raw Texture Size deprecated: This function has been replaced by object user variables on the emitter to specify render targets to fill with data.

Parameters

component (NiagaraComponent) –

Returns

size_x (int32):

size_y (int32):

Return type

tuple

get_texture_size(component) -> (size_x=int32, size_y=int32)

Get Texture Size

Parameters

component (NiagaraComponent) –

Returns

size_x (int32):

size_y (int32):

Return type

tuple