unreal.DisplayClusterConfigurationICVFX_CameraCustomFrustum

class unreal.DisplayClusterConfigurationICVFX_CameraCustomFrustum(estimated_overscan_resolution=[0, 0], inner_frustum_resolution=[0, 0], overscan_pixels_increase=0.0, enable=False, adapt_resolution=False, field_of_view_multiplier=1.0, mode=DisplayClusterConfigurationViewportCustomFrustumMode.PERCENT, left=0.0, right=0.0, top=0.0, bottom=0.0)

Bases: unreal.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] Adapt Resolution: Enable Custom Frustum Frustum.

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

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

  • estimated_overscan_resolution (IntPoint): [Read-Only] Estimated Overscan Resolution

  • field_of_view_multiplier (float): [Read-Write] Field Of View Multiplier: 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] Inner Frustum Resolution

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

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

  • overscan_pixels_increase (float): [Read-Write] Overscan Pixels Increase

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

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

property adapt_resolution

[Read-Write] Adapt Resolution: Enable Custom Frustum Frustum.

Type

(bool)

property bottom

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

Type

(float)

property enable

[Read-Write] Enable: Enable Custom Frustum Frustum.

Type

(bool)

property estimated_overscan_resolution

[Read-Only] Estimated Overscan Resolution

Type

(IntPoint)

property field_of_view_multiplier

[Read-Write] Field Of View Multiplier: 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

[Read-Only] Inner Frustum Resolution

Type

(IntPoint)

property left

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

Type

(float)

property mode

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

Type

(DisplayClusterConfigurationViewportCustomFrustumMode)

property overscan_pixels_increase

[Read-Only] Overscan Pixels Increase

Type

(float)

property right

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

Type

(float)

property top

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

Type

(float)