unreal.DisplayClusterConfigurationICVFX_CameraDepthOfField

class unreal.DisplayClusterConfigurationICVFX_CameraDepthOfField(enable_depth_of_field_compensation: bool = False, automatically_set_distance_to_wall: bool = False, distance_to_wall: float = 0.0, distance_to_wall_offset: float = 0.0, depth_of_field_gain: float = 0.0, compensation_lut: Texture2D = Ellipsis)

Bases: StructBase

Display Cluster Configuration ICVFX Camera Depth Of Field

C++ Source:

  • Plugin: nDisplay

  • Module: DisplayClusterConfiguration

  • File: DisplayClusterConfigurationTypes_ICVFX.h

Editor Properties: (see get_editor_property/set_editor_property)

  • automatically_set_distance_to_wall (bool): [Read-Write] Allows the ICVFX camera to automatically compute its distance from the stage walls using ray casting every tick

  • compensation_lut (Texture2D): [Read-Write] Look-up texture that encodes the specific amount of compensation used for each combination of wall distance and object distance

  • depth_of_field_gain (float): [Read-Write] A gain factor that scales the amount of depth of field blur rendered on the wall

  • distance_to_wall (float): [Read-Write] The distance from the ICVFX camera to the wall it is pointing at

  • distance_to_wall_offset (float): [Read-Write] An offset applied to DistanceToWall (applied regardless of whether DistanceToWall is automatically set)

  • enable_depth_of_field_compensation (bool): [Read-Write] Enables depth of field correction on the wall, which dynamically adjusts the size of the defocus circle of confusion to compensate for the real-world camera blur when shooting the wall

property automatically_set_distance_to_wall: bool

[Read-Write] Allows the ICVFX camera to automatically compute its distance from the stage walls using ray casting every tick

Type:

(bool)

property compensation_lut: Texture2D

[Read-Write] Look-up texture that encodes the specific amount of compensation used for each combination of wall distance and object distance

Type:

(Texture2D)

property depth_of_field_gain: float

[Read-Write] A gain factor that scales the amount of depth of field blur rendered on the wall

Type:

(float)

property distance_to_wall: float

[Read-Write] The distance from the ICVFX camera to the wall it is pointing at

Type:

(float)

property distance_to_wall_offset: float

[Read-Write] An offset applied to DistanceToWall (applied regardless of whether DistanceToWall is automatically set)

Type:

(float)

property enable_depth_of_field_compensation: bool

[Read-Write] Enables depth of field correction on the wall, which dynamically adjusts the size of the defocus circle of confusion to compensate for the real-world camera blur when shooting the wall

Type:

(bool)