Copyright © 2018 Rostislav Pehlivanov 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 (including the next paragraph) 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. An interface to capture surfaces in an efficient way. Overall usage: 1.) client registers with zwlr_screencontent_manager_v1 2.) server sends client info about surfaces via "receive_surface_info" 3.) client subscribes to capture a surface via the "capture" requests 4.) server sends client events via the "zwlr_screencontent_frame" interface 5.) client finishes and informs server via the "frame_destroy" event 6.) client optionally resubscribes via repeating steps 3.) through 5.) This object represents a frame which is ready to have its resources fetched and used. The receive callback shall be called first, followed by the "object" callback once per dmabuf object or the "plane" callback, once per dmabuf plane. The "ready" event is called last to indicate that all the data has been made available for readout, as well as the time at which presentation happened at. The ownership of the frame is passed to the client, who's responsible for destroying it via the "destroy" event once finished and by calling close() on the file descriptors received. All frames are read-only and may not be written into or altered. Special flags that should be respected by the client. Main callback supplying the client with information about the frame, as well as an object to serve as context for destruction. Always called first before any other events. The "transform" argument describes the orientation needed to be applied to correctly orient the buffer. For example, a buffer rotated by 90 degrees will have a value of "3" here, corresponding to the need to apply a 270 degree transpose to correctly present the buffer. Callback which serves to supply the client with the file descriptors containing the data for each object. Callback which supplies the client with plane information for each plane. Called as soon as the frame is presented, indicating it is available for reading. The timestamp is expressed as tv_sec_hi, tv_sec_lo, tv_nsec triples, each component being an unsigned 32-bit value. Whole seconds are in tv_sec which is a 64-bit value combined from tv_sec_hi and tv_sec_lo, and the additional fractional part in tv_nsec as nanoseconds. Hence, for valid timestamps tv_nsec must be in [0, 999999999]. The seconds part may have an arbitrary offset at start. Indicates reason for cancelling the frame. If the frame is no longer valid after the "frame" event has been called, this callback will be used to inform the client to scrap the frame. Source is still valid for as long as the subscription function does not return NULL. This may get called if for instance the surface is in the process of resizing. Unreferences the frame, allowing it to be reused. Must be called as soon as its no longer used. Can be called at any time by the client after the "frame" event, after which the compositor will not call any other events unless the client resubscribes to capture more. The client will still have to close any FDs it has been given. This object is a manager with which to start capturing from sources. Request to start capturing from an entire wl_output. All objects created by the manager will still remain valid, until their appropriate destroy request has been called.