unreal.PCGBlurSettings

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

Bases: PCGSettings

Select an attribute on a point data and blur it using the values from neighbors within some distance, center to center, and can be done over multiple iterations.

C++ Source:

  • Plugin: PCG

  • Module: PCG

  • File: PCGBlurElement.h

Editor Properties: (see get_editor_property/set_editor_property)

  • blur_mode (PCGBlurElementMode): [Read-Write]

  • break_debugger (bool): [Read-Write] If a debugger is attached, triggers a breakpoint inside IPCGElement::Execute(). Editor only. Transient.

  • category (Text): [Read-Write]

  • custom_standard_deviation (double): [Read-Write]

  • debug (bool): [Read-Write]

  • debug_buffer_size (int32): [Read-Write] Size (in number of floats) of the shader debug print buffer.

  • debug_settings (PCGDebugVisualizationSettings): [Read-Write]

  • description (Text): [Read-Write]

  • determinism_settings (PCGDeterminismSettings): [Read-Write]

  • dump_cooked_hlsl (bool): [Read-Write] Dump the cooked HLSL into the log after it is generated.

  • dump_data_descriptions (bool): [Read-Write] Dump the data descriptions of input/output pins to the log.

  • enabled (bool): [Read-Write]

  • execute_on_gpu (bool): [Read-Write] Whether this node should be executed on the GPU.

  • expose_to_library (bool): [Read-Write]

  • input_source (PCGAttributePropertyInputSelector): [Read-Write] Attribute to use as a base value. Needs to be numerical.

  • num_iterations (int32): [Read-Write] Number of iterations to apply the blur.

  • output_target (PCGAttributePropertyOutputSelector): [Read-Write] Attribute where the result will be written.

  • print_shader_debug_values (bool): [Read-Write] Enable use of ‘WriteDebugValue(uint Index, float Value)’ function in your kernel. Allows you to write float values to a buffer for logging on the CPU.

  • search_distance (double): [Read-Write] Radius for search.

  • seed (int32): [Read-Write]

  • use_custom_standard_deviation (bool): [Read-Write] By default, the standard deviation will be SearchDistance / 3, so that at search distance from the point it corresponds to 3 std deviation.

  • use_seed (bool): [Read-Write] deprecated: Implement the PCGSettings virtual UseSeed() override.

property blur_mode: PCGBlurElementMode

[Read-Write]

Type:

(PCGBlurElementMode)

property custom_standard_deviation: float

[Read-Write]

Type:

(double)

property input_source: PCGAttributePropertyInputSelector

[Read-Write] Attribute to use as a base value. Needs to be numerical.

Type:

(PCGAttributePropertyInputSelector)

property num_iterations: int

[Read-Write] Number of iterations to apply the blur.

Type:

(int32)

property output_target: PCGAttributePropertyOutputSelector

[Read-Write] Attribute where the result will be written.

Type:

(PCGAttributePropertyOutputSelector)

property search_distance: float

[Read-Write] Radius for search.

Type:

(double)

property use_custom_standard_deviation: bool

[Read-Write] By default, the standard deviation will be SearchDistance / 3, so that at search distance from the point it corresponds to 3 std deviation.

Type:

(bool)