wl_eglstream_controller protocol

wl_eglstream_controller interface version 2

Requests

attach_eglstream_consumer since version 1

attach_eglstream_consumer(wl_surface object[wl_surface], wl_resource object[wl_buffer])

Creates the corresponding server side EGLStream from the given wl_buffer and attaches a consumer to it.

Arguments
Name Type Description
wl_surface object[wl_surface] wl_surface corresponds to the client surface associated with newly created eglstream
wl_resource object[wl_buffer] wl_resource corresponding to an EGLStream

attach_eglstream_consumer_attribs since version 2

attach_eglstream_consumer_attribs(wl_surface object[wl_surface], wl_resource object[wl_buffer], attribs array)

Creates the corresponding server side EGLStream from the given wl_buffer and attaches a consumer to it using the given attributes.

Arguments
Name Type Description
wl_surface object[wl_surface] wl_surface corresponds to the client surface associated with newly created eglstream
wl_resource object[wl_buffer] wl_resource corresponding to an EGLStream
attribs array Stream consumer attachment attribs

Enums

present_mode since version 0

- dont_care: Using this enum will tell the server to make its own decisions regarding present mode. - fifo: Tells the server to use a fifo present mode. The decision to use fifo synchronous is left up to the server. - mailbox: Tells the server to use a mailbox present mode.

enum present_mode {
dont_care = 0,
fifo = 1,
mailbox = 2,
}
Entries
Name Value Description
dont_care 0 Let the Server decide present mode
fifo 1 Use a fifo present mode
mailbox 2 Use a mailbox mode

attrib since version 0

- present_mode: Must be one of wl_eglstream_controller_present_mode. Tells the server the desired present mode that should be used. - fifo_length: Only valid when the present_mode attrib is provided and its value is specified as fifo. Tells the server the desired fifo length to be used when the desired present_mode is fifo.

enum attrib {
present_mode = 0,
fifo_length = 1,
}
Entries
Name Value Description
present_mode 0 Tells the server the desired present mode
fifo_length 1 Tells the server the desired fifo length when the desired presenation_mode is fifo.

SPDX-FileCopyrightText: 2017-2018, NVIDIA CORPORATION. All rights reserved. SPDX-License-Identifier: MIT