unreal.PCGTextureSamplerSettings

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

Bases: PCGSettings

PCGTexture Sampler Settings

C++ Source:

  • Plugin: PCG

  • Module: PCG

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

  • center_offset (Vector2D): [Read-Write]

  • color_channel (PCGTextureColorChannel): [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]

  • density_function (PCGTextureDensityFunction): [Read-Write] deprecated: Property ‘DensityFunction’ is deprecated.

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

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

  • force_editor_only_cpu_sampling (bool): [Read-Write] Even if the texture is not set to CPU-available, it can still be accessed from CPU memory under certain conditions (sRGB disabled, no mipmaps, and non-compressed format). Reading from CPU memory will be faster and more accurate than reading from GPU memory, since the texture will not be subject to compression or resolution clamping. Enable this flag to force a duplicate of the texture with the correct settings for CPU memory access. This is editor-only.

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

  • rotation (float): [Read-Write] Rotation to apply when sampling texture.

  • seed (int32): [Read-Write]

  • skip_readback_to_cpu (bool): [Read-Write] Skip CPU readback during initialization of the texture data.

  • synchronous_load (bool): [Read-Write] By default, texture loading is asynchronous, can force it synchronous if needed.

  • texel_size (float): [Read-Write] The size of one texel in cm, used when calling ToPointData.

  • texture (Texture): [Read-Write] Texture specific parameters

  • texture_array_index (int32): [Read-Write] Index of texture array slice. Only used when built with editor and if the type of Texture is UTexture2DArray.

  • tile_bounds_max (Vector2D): [Read-Write]

  • tile_bounds_min (Vector2D): [Read-Write]

  • tiling (Vector2D): [Read-Write]

  • transform (Transform): [Read-Write] Surface transform

  • 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_absolute_transform (bool): [Read-Write]

  • use_advanced_tiling (bool): [Read-Write] Whether to tile the source or to stretch it to fit target area.

  • use_density_source_channel (bool): [Read-Write]

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

  • use_tile_bounds (bool): [Read-Write]

property center_offset: Vector2D

[Read-Write]

Type:

(Vector2D)

property color_channel: PCGTextureColorChannel

[Read-Write]

Type:

(PCGTextureColorChannel)

property density_function: PCGTextureDensityFunction

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

Type:

(PCGTextureDensityFunction)

property filter: PCGTextureFilter

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

Type:

(PCGTextureFilter)

property force_editor_only_cpu_sampling: bool

[Read-Write] Even if the texture is not set to CPU-available, it can still be accessed from CPU memory under certain conditions (sRGB disabled, no mipmaps, and non-compressed format). Reading from CPU memory will be faster and more accurate than reading from GPU memory, since the texture will not be subject to compression or resolution clamping. Enable this flag to force a duplicate of the texture with the correct settings for CPU memory access. This is editor-only.

Type:

(bool)

property rotation: float

[Read-Write] Rotation to apply when sampling texture.

Type:

(float)

property skip_readback_to_cpu: bool

[Read-Write] Skip CPU readback during initialization of the texture data.

Type:

(bool)

property synchronous_load: bool

[Read-Write] By default, texture loading is asynchronous, can force it synchronous if needed.

Type:

(bool)

property texel_size: float

[Read-Write] The size of one texel in cm, used when calling ToPointData.

Type:

(float)

property texture: Texture

[Read-Write] Texture specific parameters

Type:

(Texture)

property texture_array_index: int

[Read-Write] Index of texture array slice. Only used when built with editor and if the type of Texture is UTexture2DArray.

Type:

(int32)

property tile_bounds_max: Vector2D

[Read-Write]

Type:

(Vector2D)

property tile_bounds_min: Vector2D

[Read-Write]

Type:

(Vector2D)

property tiling: Vector2D

[Read-Write]

Type:

(Vector2D)

property transform: Transform

[Read-Write] Surface transform

Type:

(Transform)

property use_absolute_transform: bool

[Read-Write]

Type:

(bool)

property use_advanced_tiling: bool

[Read-Write] Whether to tile the source or to stretch it to fit target area.

Type:

(bool)

property use_density_source_channel: bool

[Read-Write]

Type:

(bool)

property use_tile_bounds: bool

[Read-Write]

Type:

(bool)