unreal.LensDistortionLibrary

class unreal.LensDistortionLibrary(outer=None, name='None')

Bases: unreal.BlueprintFunctionLibrary

Lens Distortion Blueprint Library

C++ Source:

  • Plugin: LensDistortion

  • Module: LensDistortion

  • File: LensDistortionBlueprintLibrary.h

classmethod draw_uv_displacement_to_render_target(world_context_object, camera_model, distorted_horizontal_fov, distorted_aspect_ratio, undistort_overscan_factor, output_render_target, output_multiply=0.5, output_add=0.5) → None

Draws UV displacement map within the output render target. - Red & green channels hold the distortion displacement; - Blue & alpha channels hold the undistortion displacement.

Parameters

  • world_context_object (Object) –

  • camera_model (LensDistortionCameraModel) –

  • distorted_horizontal_fov (float) – The desired horizontal FOV in the distorted render.

  • distorted_aspect_ratio (float) – The desired aspect ratio of the distorted render.

  • undistort_overscan_factor (float) – The factor of the overscan for the undistorted render.

  • output_render_target (TextureRenderTarget2D) – The render target to draw to. Don’t necessarily need to have same resolution or aspect ratio as distorted render.

  • output_multiply (float) – The multiplication factor applied on the displacement.

  • output_add (float) – Value added to the multiplied displacement before storing into the output render target.

classmethod equal_equal_compare_lens_distortion_models(a, b) → bool

Returns true if A is equal to B (A == B)

Parameters
Returns

Return type

bool

classmethod get_undistort_overscan_factor(camera_model, distorted_horizontal_fov, distorted_aspect_ratio) → float

Returns the overscan factor required for the undistort rendering to avoid unrendered distorted pixels.

Parameters
Returns

undistort_overscan_factor (float):

Return type

float

classmethod not_equal_compare_lens_distortion_models(a, b) → bool

Returns true if A is not equal to B (A != B)

Parameters
Returns

Return type

bool