unreal.TextureShareBlueprintAPI

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

Bases: unreal.Interface

Texture Share Blueprint API

C++ Source:

• Plugin: TextureShare

• Module: TextureShare

• File: ITextureShareBlueprintAPI.h

apply_texture_share_postprocess(share_name, postprocess) → bool

Send from Input[], wait and receive result to Output[] from the remote process

Parameters

• share_name (str) – Unique share name (case insensitive)

• postprocess (TextureShareBPPostprocess) – Textures to exchange

Returns

True if the success

Return type

bool

create_texture_share(share_name, sync_mode, is_server=True) → bool

Create new textureshare object

Parameters

• share_name (str) – Unique share name (case insensitive)

• sync_mode (TextureShareBPSyncPolicy) – Sync options

• is_server (bool) –

Returns

True if the success

Return type

bool

get_sync_policy_settings() → TextureShareBPSyncPolicySettings

Get global synchronization settings

Returns

settings data struct

Return type

TextureShareBPSyncPolicySettings

link_scene_context_to_share(share_name, stereoscopic_pass=0, is_enabled=True) → bool

LinkUnlink SceneContext capture (for specified StereoscopicPass) to exist textureshare object

Parameters

• share_name (str) – Unique share name (case insensitive)

• stereoscopic_pass (int32) – stereo rendering and nDisplay purpose

• is_enabled (bool) – true to create link

Returns

True if the success

Return type

bool

release_texture_share(share_name) → bool

Release exist textureshare object

Parameters

share_name (str) – Unique share name (case insensitive)

Returns

True if the success

Return type

bool

set_sync_policy_settings(sync_policy_settings) → None

Get global synchronization settings

Parameters

sync_policy_settings (TextureShareBPSyncPolicySettings) – settings data struct