unreal.DisplayClusterConfigurationICVFX_CameraCustomFrustum

class unreal.DisplayClusterConfigurationICVFX_CameraCustomFrustum(estimated_overscan_resolution: IntPoint = Ellipsis, inner_frustum_resolution: IntPoint = Ellipsis, overscan_pixels_increase: float = 0.0, enable: bool = False, adapt_resolution: bool = False, field_of_view_multiplier: float = 0.0, mode: DisplayClusterConfigurationViewportCustomFrustumMode = Ellipsis, left: float = 0.0, right: float = 0.0, top: float = 0.0, bottom: float = 0.0)

Bases: StructBase

Display Cluster Configuration ICVFX Camera Custom Frustum

C++ Source:

  • Plugin: nDisplay

  • Module: DisplayClusterConfiguration

  • File: DisplayClusterConfigurationTypes_ICVFX.h

Editor Properties: (see get_editor_property/set_editor_property)

  • adapt_resolution (bool): [Read-Write] Enable adaptive resolution.

  • bottom (float): [Read-Write] Pixel/Percent value to alter the frustum to the bottom

  • enable (bool): [Read-Write] Enable Custom Frustum.

  • estimated_overscan_resolution (IntPoint): [Read-Only] Expected ICVFX camera resolution when both ‘Adapt Resolution’ and ‘Enable Inner Frustum Overscan’ are enabled.

  • field_of_view_multiplier (float): [Read-Write] Multiply the field of view for the ICVFX camera by this value. This can increase the overall size of the inner frustum to help provide a buffer against latency when moving the camera.

  • inner_frustum_resolution (IntPoint): [Read-Only] Real ICVFX camera resolution for current settings.

  • left (float): [Read-Write] Pixel/Percent value to alter the frustum to the left side

  • mode (DisplayClusterConfigurationViewportCustomFrustumMode): [Read-Write] Enable/disable inner camera custom frustum and specify units as percent or pixel values.

  • overscan_pixels_increase (float): [Read-Write] This value shows the ratio of “Overscan Estimated Resolution” pixels to “Frustum Internal Resolution” pixels.

  • right (float): [Read-Write] Pixel/Percent value to alter the frustum to the right side

  • top (float): [Read-Write] Pixel/Percent value to alter the frustum to the top

property adapt_resolution: bool

[Read-Write] Enable adaptive resolution.

Type:

(bool)

property bottom: float

[Read-Write] Pixel/Percent value to alter the frustum to the bottom

Type:

(float)

property enable: bool

[Read-Write] Enable Custom Frustum.

Type:

(bool)

property estimated_overscan_resolution: IntPoint

[Read-Only] Expected ICVFX camera resolution when both ‘Adapt Resolution’ and ‘Enable Inner Frustum Overscan’ are enabled.

Type:

(IntPoint)

property field_of_view_multiplier: float

[Read-Write] Multiply the field of view for the ICVFX camera by this value. This can increase the overall size of the inner frustum to help provide a buffer against latency when moving the camera.

Type:

(float)

property inner_frustum_resolution: IntPoint

[Read-Only] Real ICVFX camera resolution for current settings.

Type:

(IntPoint)

property left: float

[Read-Write] Pixel/Percent value to alter the frustum to the left side

Type:

(float)

property mode: DisplayClusterConfigurationViewportCustomFrustumMode

[Read-Write] Enable/disable inner camera custom frustum and specify units as percent or pixel values.

Type:

(DisplayClusterConfigurationViewportCustomFrustumMode)

property overscan_pixels_increase: float

[Read-Only] This value shows the ratio of “Overscan Estimated Resolution” pixels to “Frustum Internal Resolution” pixels.

Type:

(float)

property right: float

[Read-Write] Pixel/Percent value to alter the frustum to the right side

Type:

(float)

property top: float

[Read-Write] Pixel/Percent value to alter the frustum to the top

Type:

(float)