NVIDIA EGLStream controller

nvidia-eglstream-controller

attach_eglstream_consumer(wl_surface: object<wl_surface>, wl_resource: object<wl_buffer>)
Argument
Type
Description
wl_surfaceobject<wl_surface>
wl_surface corresponds to the client surface associated with newly created eglstream
wl_resourceobject<wl_buffer>
wl_resource corresponding to an EGLStream
Create server stream and attach consumer

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

attach_eglstream_consumer_attribs(wl_surface: object<wl_surface>, wl_resource: object<wl_buffer>, attribs: array)
Argument
Type
Description
wl_surfaceobject<wl_surface>
wl_surface corresponds to the client surface associated with newly created eglstream
wl_resourceobject<wl_buffer>
wl_resource corresponding to an EGLStream
attribsarray
Stream consumer attachment attribs
List of attributes with consumer attachment data

It contains key-value pairs compatible with intptr_t type. A key must be one of wl_eglstream_controller_attrib enumeration values. What a value represents is attribute-specific.

Create server stream and attach consumer using attributes

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

present_mode { dont_care, fifo, mailbox } 
Argument
Value
Description
dont_care0
Let the Server decide present mode
fifo1
Use a fifo present mode
mailbox2
Use a mailbox mode
Stream present mode

- 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.

Argument
Value
Description
present_mode0
Tells the server the desired present mode
fifo_length1
Tells the server the desired fifo length when the desired presenation_mode is fifo.
Stream consumer attachment attributes

- 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.


Copyright (c) 2017-2018, NVIDIA CORPORATION. All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.