unreal.SharedMemoryMediaOutput

class unreal.SharedMemoryMediaOutput(outer: Object | None = None, name: Name | str = 'None')

Bases: MediaOutput

Output information for a SharedMemory media capture.

C++ Source:

  • Plugin: nDisplay

  • Module: SharedMemoryMedia

  • File: SharedMemoryMediaOutput.h

Editor Properties: (see get_editor_property/set_editor_property)

  • cross_gpu (bool): [Read-Write] If checked, the texture will be shared across different GPUs. Disable if not needed for faster performance

  • invert_alpha (bool): [Read-Write] If checked, the alpha channel of the texture will be inverted

  • number_of_texture_buffers (int32): [Read-Write] Number of texture used to transfer the texture from the GPU to the system memory. A smaller number is most likely to block the GPU (wait for the transfer to complete). A bigger number is most likely to increase latency. note: Some Capture are not are executed on the GPU. If it’s the case then no buffer will be needed and no buffer will be created.

  • unique_name (str): [Read-Write] Shared memory will be opened by using this name. Should be unique per media output.

property cross_gpu: bool

[Read-Write] If checked, the texture will be shared across different GPUs. Disable if not needed for faster performance

Type:

(bool)

property invert_alpha: bool

[Read-Write] If checked, the alpha channel of the texture will be inverted

Type:

(bool)

property unique_name: str

[Read-Write] Shared memory will be opened by using this name. Should be unique per media output.

Type:

(str)