unreal.PCGDensityFilterSettings

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

Bases: PCGSettings

PCGDensity Filter Settings

C++ Source:

  • Plugin: PCG

  • Module: PCG

  • File: PCGDensityFilter.h

Editor Properties: (see get_editor_property/set_editor_property)

  • break_debugger (bool): [Read-Write] If a debugger is attached, a breakpoint will be triggered in the execution code to enable debugging. Only applies when inspecting a debug object. Transient and Editor-only.

  • category (Text): [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.

  • execution_dependency_required (bool): [Read-Write] If enabled, the execution dependency pin will require to be connected for execution (as any other required pin) and will be used for culling.

  • expose_to_library (bool): [Read-Write]

  • invert_filter (bool): [Read-Write]

  • keep_zero_density_points (bool): [Read-Write]

  • lower_bound (float): [Read-Write]

  • normalize_output_density (bool): [Read-Write] If checked, the result density will be remapped from [LowerBound, UpperBound] to [0, 1]. If LowerBound == UpperBound, then the density will be set to 0.5. Only available when we do not invert the filter, as it is not clear how to normalize disjoint ranges. Also not available if bKeepZeroDensityPoints is true, as they will not be different from points that have their density equal to lower bound.

  • 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.

  • profile_kernel_index (int32): [Read-Write] Index of kernel emitted by this node to repeatedly dispatch every frame to enable profiling. Set to -1 to disable profiling. PCG_GPU_KERNEL_PROFILING must be defined in PCG.Build.cs.

  • seed (int32): [Read-Write]

  • trigger_render_capture (bool): [Read-Write] Will trigger a render capture when this node executes and a debug object is selected in the graph editor. Transient and Editor-only. Render captures must be enabled (e.g. -AttachRenderDoc or -AttachPIX).

  • upper_bound (float): [Read-Write]

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

property invert_filter: bool

[Read-Write]

Type:

(bool)

property keep_zero_density_points: bool

[Read-Write]

Type:

(bool)

property lower_bound: float

[Read-Write]

Type:

(float)

property normalize_output_density: bool

[Read-Write] If checked, the result density will be remapped from [LowerBound, UpperBound] to [0, 1]. If LowerBound == UpperBound, then the density will be set to 0.5. Only available when we do not invert the filter, as it is not clear how to normalize disjoint ranges. Also not available if bKeepZeroDensityPoints is true, as they will not be different from points that have their density equal to lower bound.

Type:

(bool)

property upper_bound: float

[Read-Write]

Type:

(float)