unreal.ComposureLibrary

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

Bases: unreal.BlueprintFunctionLibrary

Composure Blueprint Library

C++ Source:

  • Plugin: Composure
  • Module: Composure
  • File: ComposureBlueprintLibrary.h
classmethod copy_camera_settings_to_scene_capture(src_camera, dst_capture_component) → None

Copy Camera Settings to Scene Capture

Parameters:
classmethod create_player_compositing_target(world_context_object) → ComposurePlayerCompositingTarget

Creates a Player Compositing Target which you can modify during gameplay.

Parameters:world_context_object (Object) –
Returns:
Return type:ComposurePlayerCompositingTarget
classmethod get_cropping_uv_transformation_matrix_from_post_move_settings(post_move_settings, aspect_ratio) -> (croping_uv_transformation_matrix=Matrix, uncroping_uv_transformation_matrix=Matrix)

Returns UV transformation matrix and its inversed to crop.

Parameters:
Returns:

croping_uv_transformation_matrix (Matrix):

uncroping_uv_transformation_matrix (Matrix):

Return type:

tuple

classmethod get_player_display_gamma(player_camera_manager) → float

Returns display gamma of a given player camera manager, or 0 if no scene viewport attached.

Parameters:player_camera_manager (PlayerCameraManager) –
Returns:display_gamma (float):
Return type:float
classmethod get_projection_matrix_from_post_move_settings(post_move_settings, horizontal_fov_angle, aspect_ratio) → Matrix

Returns a non-centered projection matrix.

Parameters:
  • post_move_settings (ComposurePostMoveSettings) –
  • horizontal_fov_angle (float) – The desired horizontal FOV in degrees.
  • aspect_ratio (float) – The desired aspect ratio.
Returns:

projection_matrix (Matrix):

Return type:

Matrix

classmethod get_red_green_uv_factors_from_chromatic_aberration(chromatic_aberration_amount) → Vector2D

Returns the red and green channel factors from percentage of chromatic aberration.

Parameters:chromatic_aberration_amount (float) –
Returns:red_green_uv_factors (Vector2D):
Return type:Vector2D
classmethod invert_uv_displacement_map_encoding_parameters(in_) → Vector2D

Converts displacement encoding parameters to decoding parameters. Can also be used to convert displacement decoding parameters to encoding parameters.

Parameters:in (Vector2D) –
Returns:out (Vector2D):
Return type:Vector2D
classmethod set_uv_map_settings_to_material_parameters(uv_map_settings, material) → None

Sets parameters of a material that uses Composure’s MF_UVMap_SampleLocation material function.

Parameters: