screen_create_stream()

Updated: May 27, 2022

Create a stream that can be used to provide graphical content to generic consumers

Synopsis:

#include <screen/screen.h>
int screen_create_stream(screen_stream_t *pstream,
                         screen_context_t ctx)

Arguments:

pstream
A pointer to the newly created stream.
ctx
The connection to Screen. This context must have been created with screen_create_context().

Library:

libscreen

Description:

Function Type: Immediate Execution

This function creates a stream object. The stream size defaults to fullscreen when it's created, if a display is present. Note that after calling screen_create_stream(), the object exists locally as a handle. The stream is created in the Screen when buffers are created with screen_create_stream_buffers(), when buffers are attached with screen_attach_stream_buffers(), or when buffers are shared with screen_consume_stream_buffers().

Returns:

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