unreal.PCGPinPropertiesGPUStruct

class unreal.PCGPinPropertiesGPUStruct(initialization_mode: PCGPinInitMode = Ellipsis, pins_to_inititalize_from: None = [], data_count_mode: PCGDataCountMode = Ellipsis, data_multiplicity: PCGDataMultiplicity = Ellipsis, data_count: int = 0, element_count_mode: PCGElementCountMode = Ellipsis, element_multiplicity: PCGElementMultiplicity = Ellipsis, element_count: int = 0, num_elements2d: IntPoint = Ellipsis, texture_format_inheritance_mode: PCGPropertyInheritanceMode = Ellipsis, texture_format: PCGRenderTargetFormat = Ellipsis, initialize_texture_transform_from_generation_volume: bool = False, texture_transform_inheritance_mode: PCGPropertyInheritanceMode = Ellipsis, texture_transform: Transform = Ellipsis, texture_filter_inheritance_mode: PCGPropertyInheritanceMode = Ellipsis, texture_filter: PCGTextureFilter = Ellipsis, texture_array_size_inheritance_mode: PCGPropertyInheritanceMode = Ellipsis, texture_array_size: int = 0, element_count_multiplier: int = 0, initialize_to_zero: bool = False, auto_initialize_output: bool = False, attribute_inheritance_mode: PCGAttributeInheritanceMode = Ellipsis)

Bases: StructBase

Helper struct to nest GPU pin properties inside a UI category.

C++ Source:

  • Plugin: PCG

  • Module: PCG

  • File: PCGPinPropertiesGPU.h

Editor Properties: (see get_editor_property/set_editor_property)

  • attribute_inheritance_mode (PCGAttributeInheritanceMode): [Read-Write] How to inherit attribute names, types, and values.

  • auto_initialize_output (bool): [Read-Write] Automatically initialize output data from input before executing the kernel. When enabled the kernel only needs to write elements that differ from input. Warning: Use with caution - unwritten data will have unitialized data and can intermittently fail or trigger undefined behaviour downstream.

  • created_kernel_attribute_keys (Array[PCGKernelAttributeKey]): [Read-Write] Add entries to create new attributes on data emitted by this pin. This is optional, as of 5.8 attributes are automatically created when written from HLSL.

  • data_count (int32): [Read-Write] Number of data to create.

  • data_count_mode (PCGDataCountMode): [Read-Write] How the number of data is determined.

  • data_multiplicity (PCGDataMultiplicity): [Read-Write] How to combine data counts.

  • element_count (int32): [Read-Write] Fixed number of elements to create in each output data.

  • element_count_mode (PCGElementCountMode): [Read-Write] How the number of elements is determined.

  • element_count_multiplier (int32): [Read-Write] Scalar on the fixed number of elements to create in each output data.

  • element_multiplicity (PCGElementMultiplicity): [Read-Write] How to combine element counts.

  • initialization_mode (PCGPinInitMode): [Read-Write] How the output data for this pin will be initialized.

  • initialize_texture_transform_from_generation_volume (bool): [Read-Write]

  • initialize_to_zero (bool): [Read-Write] Statically initialize data to 0 from CPU before execution.

  • num_elements2d (IntPoint): [Read-Write] Fixed number of elements to create in each output data.

  • pins_to_inititalize_from (Array[Name]): [Read-Write] Input pins to initialize this pin’s data from.

  • texture_array_size (int32): [Read-Write] Number of layers in the texture array created by this pin.

  • texture_array_size_inheritance_mode (PCGPropertyInheritanceMode): [Read-Write] Method for inheriting texture array size.

  • texture_filter (PCGTextureFilter): [Read-Write] Method used to determine the value for a sample based on the value of nearby texels.

  • texture_filter_inheritance_mode (PCGPropertyInheritanceMode): [Read-Write] Method for inheriting texture filter.

  • texture_format (PCGRenderTargetFormat): [Read-Write] Format for all texture data produced on this pin.

  • texture_format_inheritance_mode (PCGPropertyInheritanceMode): [Read-Write] Method for inheriting texture format.

  • texture_transform (Transform): [Read-Write]

  • texture_transform_inheritance_mode (PCGPropertyInheritanceMode): [Read-Write] Method for inheriting texture transform.

property attribute_inheritance_mode: PCGAttributeInheritanceMode

[Read-Write] How to inherit attribute names, types, and values.

Type:

(PCGAttributeInheritanceMode)

property auto_initialize_output: bool

[Read-Write] Automatically initialize output data from input before executing the kernel. When enabled the kernel only needs to write elements that differ from input. Warning: Use with caution - unwritten data will have unitialized data and can intermittently fail or trigger undefined behaviour downstream.

Type:

(bool)

property data_count: int

[Read-Write] Number of data to create.

Type:

(int32)

property data_count_mode: PCGDataCountMode

[Read-Write] How the number of data is determined.

Type:

(PCGDataCountMode)

property data_multiplicity: PCGDataMultiplicity

[Read-Write] How to combine data counts.

Type:

(PCGDataMultiplicity)

property element_count: int

[Read-Write] Fixed number of elements to create in each output data.

Type:

(int32)

property element_count_mode: PCGElementCountMode

[Read-Write] How the number of elements is determined.

Type:

(PCGElementCountMode)

property element_count_multiplier: int

[Read-Write] Scalar on the fixed number of elements to create in each output data.

Type:

(int32)

property element_multiplicity: PCGElementMultiplicity

[Read-Write] How to combine element counts.

Type:

(PCGElementMultiplicity)

property initialization_mode: PCGPinInitMode

[Read-Write] How the output data for this pin will be initialized.

Type:

(PCGPinInitMode)

property initialize_texture_transform_from_generation_volume: bool

[Read-Write]

Type:

(bool)

property initialize_to_zero: bool

[Read-Write] Statically initialize data to 0 from CPU before execution.

Type:

(bool)

property num_elements2d: IntPoint

[Read-Write] Fixed number of elements to create in each output data.

Type:

(IntPoint)

property pins_to_inititalize_from: None

[Read-Write] Input pins to initialize this pin’s data from.

Type:

(Array[Name])

property texture_array_size: int

[Read-Write] Number of layers in the texture array created by this pin.

Type:

(int32)

property texture_array_size_inheritance_mode: PCGPropertyInheritanceMode

[Read-Write] Method for inheriting texture array size.

Type:

(PCGPropertyInheritanceMode)

property texture_filter: PCGTextureFilter

[Read-Write] Method used to determine the value for a sample based on the value of nearby texels.

Type:

(PCGTextureFilter)

property texture_filter_inheritance_mode: PCGPropertyInheritanceMode

[Read-Write] Method for inheriting texture filter.

Type:

(PCGPropertyInheritanceMode)

property texture_format: PCGRenderTargetFormat

[Read-Write] Format for all texture data produced on this pin.

Type:

(PCGRenderTargetFormat)

property texture_format_inheritance_mode: PCGPropertyInheritanceMode

[Read-Write] Method for inheriting texture format.

Type:

(PCGPropertyInheritanceMode)

property texture_transform: Transform

[Read-Write]

Type:

(Transform)

property texture_transform_inheritance_mode: PCGPropertyInheritanceMode

[Read-Write] Method for inheriting texture transform.

Type:

(PCGPropertyInheritanceMode)