unreal.PCGSceneCaptureSettings

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

Bases: PCGSettings

Perform a 2D orthographic scene capture and write the result to a render target data. Can be costly, use with caution with runtime generation.

C++ Source:

• Plugin: PCG

• Module: PCG

• File: PCGSceneCapture.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.

• capture_from_top_of_extents (bool): [Read-Write] Scene capture position will be translated such that the capture is taken from the top of the capture extents rather than from the center.

• capture_half_extents (Vector): [Read-Write] Used to determine the orthographic width of the scene capture. Extents on Z are used for the resulting texture data’s Z extents.

• capture_location (Vector): [Read-Write] Positions the scene capture.

• capture_rotation (Quat): [Read-Write] Rotates the scene capture.

• capture_source (SceneCaptureSource): [Read-Write] Specifies which component of the scene rendering should be output to the render target.

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

• exclude_pcg_content (bool): [Read-Write] Exclude content created from PCG.

• excluded_tags (Array[Name]): [Read-Write] Tags to match against actors/components when selecting for exclusion from the scene capture.

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

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

• included_tags (Array[Name]): [Read-Write] Tags to match against actors/components when selecting for inclusion in the scene capture.

• only_capture_content_matching_included_tags (bool): [Read-Write] Only capture actors and primitive components that have tags listed in Included Tags.

• orientation_mode (PCGSceneCaptureOrientationMode): [Read-Write] Defines how the scene capture bounds and transform are computed.

• pixel_format (TextureRenderTargetFormat): [Read-Write] Subset of EPixelFormat exposed to UTextureRenderTarget2D.

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

• skip_readback_to_cpu (bool): [Read-Write] deprecated: Property ‘bSkipReadbackToCPU’ is deprecated.

• texel_size (float): [Read-Write] Size of a texel in the render target in world units (cm).

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

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

property capture_from_top_of_extents: bool

[Read-Write] Scene capture position will be translated such that the capture is taken from the top of the capture extents rather than from the center.

Type:

(bool)

property capture_half_extents: Vector

[Read-Write] Used to determine the orthographic width of the scene capture. Extents on Z are used for the resulting texture data’s Z extents.

Type:

(Vector)

property capture_location: Vector

[Read-Write] Positions the scene capture.

Type:

(Vector)

property capture_rotation: Quat

[Read-Write] Rotates the scene capture.

Type:

(Quat)

property capture_source: SceneCaptureSource

[Read-Write] Specifies which component of the scene rendering should be output to the render target.

Type:

(SceneCaptureSource)

property exclude_pcg_content: bool

[Read-Write] Exclude content created from PCG.

Type:

(bool)

property excluded_tags: None

[Read-Write] Tags to match against actors/components when selecting for exclusion from the scene capture.

Type:

(Array[Name])

property filter: PCGTextureFilter

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

Type:

(PCGTextureFilter)

property included_tags: None

[Read-Write] Tags to match against actors/components when selecting for inclusion in the scene capture.

Type:

(Array[Name])

property only_capture_content_matching_included_tags: bool

[Read-Write] Only capture actors and primitive components that have tags listed in Included Tags.

Type:

(bool)

property orientation_mode: PCGSceneCaptureOrientationMode

[Read-Write] Defines how the scene capture bounds and transform are computed.

Type:

(PCGSceneCaptureOrientationMode)

property pixel_format: TextureRenderTargetFormat

[Read-Write] Subset of EPixelFormat exposed to UTextureRenderTarget2D.

Type:

(TextureRenderTargetFormat)

property skip_readback_to_cpu: bool

[Read-Write] deprecated: Property ‘bSkipReadbackToCPU’ is deprecated.

Type:

(bool)

property texel_size: float

[Read-Write] Size of a texel in the render target in world units (cm).

Type:

(float)