screen_share_stream_buffers()

Updated: October 26, 2022

Cause a window to display content produced by another stream

Synopsis:

#include <screen/screen.h>
int screen_share_stream_buffers(screen_window_t win,
                                screen_stream_t share)

Arguments:

win
The handle of the window that is sharing the buffer(s) owned by another stream.
share
The handle of the stream whose buffer is to be displayed.

Library:

libscreen

Description:

Function Type: Flushing Execution

This function is used when a window needs to share the content of another stream. For this operation to be successful, the stream that's the owner of the buffer(s) to be shared must have at least one buffer that was created with screen_create_stream_buffers(), or attached with screen_attach_stream_buffers(). Updates can be posted using only the stream that's the owner of the buffers (i.e., the stream whose handle is identified as share).

The following properties of the window are ignored if you set them prior to calling this function:

Returns:

0 if successful, or -1 if an error occurred (errno is set; refer to errno.h for more details).