/* Generated by wayland-scanner 1.23.0 */ #ifndef PRESENTATION_TIME_SERVER_PROTOCOL_H #define PRESENTATION_TIME_SERVER_PROTOCOL_H #include <stdint.h> #include <stddef.h> #include "wayland-server.h" #ifdef __cplusplus extern "C" { #endif struct wl_client; struct wl_resource; /** * @page page_presentation_time The presentation_time protocol * @section page_ifaces_presentation_time Interfaces * - @subpage page_iface_wp_presentation - timed presentation related wl_surface requests * - @subpage page_iface_wp_presentation_feedback - presentation time feedback event * @section page_copyright_presentation_time Copyright * <pre> * * Copyright © 2013-2014 Collabora, Ltd. * * 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. * </pre> */ struct wl_output; struct wl_surface; struct wp_presentation; struct wp_presentation_feedback; #ifndef WP_PRESENTATION_INTERFACE #define WP_PRESENTATION_INTERFACE /** * @page page_iface_wp_presentation wp_presentation * @section page_iface_wp_presentation_desc Description * * * * * The main feature of this interface is accurate presentation * timing feedback to ensure smooth video playback while maintaining * audio/video synchronization. Some features use the concept of a * presentation clock, which is defined in the * presentation.clock_id event. * * A content update for a wl_surface is submitted by a * wl_surface.commit request. Request 'feedback' associates with * the wl_surface.commit and provides feedback on the content * update, particularly the final realized presentation time. * * * * When the final realized presentation time is available, e.g. * after a framebuffer flip completes, the requested * presentation_feedback.presented events are sent. The final * presentation time can differ from the compositor's predicted * display update time and the update's target time, especially * when the compositor misses its target vertical blanking period. * @section page_iface_wp_presentation_api API * See @ref iface_wp_presentation. */ /** * @defgroup iface_wp_presentation The wp_presentation interface * * * * * The main feature of this interface is accurate presentation * timing feedback to ensure smooth video playback while maintaining * audio/video synchronization. Some features use the concept of a * presentation clock, which is defined in the * presentation.clock_id event. * * A content update for a wl_surface is submitted by a * wl_surface.commit request. Request 'feedback' associates with * the wl_surface.commit and provides feedback on the content * update, particularly the final realized presentation time. * * * * When the final realized presentation time is available, e.g. * after a framebuffer flip completes, the requested * presentation_feedback.presented events are sent. The final * presentation time can differ from the compositor's predicted * display update time and the update's target time, especially * when the compositor misses its target vertical blanking period. */ extern const struct wl_interface wp_presentation_interface; #endif #ifndef WP_PRESENTATION_FEEDBACK_INTERFACE #define WP_PRESENTATION_FEEDBACK_INTERFACE /** * @page page_iface_wp_presentation_feedback wp_presentation_feedback * @section page_iface_wp_presentation_feedback_desc Description * * A presentation_feedback object returns an indication that a * wl_surface content update has become visible to the user. * One object corresponds to one content update submission * (wl_surface.commit). There are two possible outcomes: the * content update is presented to the user, and a presentation * timestamp delivered; or, the user did not see the content * update because it was superseded or its surface destroyed, * and the content update is discarded. * * Once a presentation_feedback object has delivered a 'presented' * or 'discarded' event it is automatically destroyed. * @section page_iface_wp_presentation_feedback_api API * See @ref iface_wp_presentation_feedback. */ /** * @defgroup iface_wp_presentation_feedback The wp_presentation_feedback interface * * A presentation_feedback object returns an indication that a * wl_surface content update has become visible to the user. * One object corresponds to one content update submission * (wl_surface.commit). There are two possible outcomes: the * content update is presented to the user, and a presentation * timestamp delivered; or, the user did not see the content * update because it was superseded or its surface destroyed, * and the content update is discarded. * * Once a presentation_feedback object has delivered a 'presented' * or 'discarded' event it is automatically destroyed. */ extern const struct wl_interface wp_presentation_feedback_interface; #endif #ifndef WP_PRESENTATION_ERROR_ENUM #define WP_PRESENTATION_ERROR_ENUM /** * @ingroup iface_wp_presentation * fatal presentation errors * * These fatal protocol errors may be emitted in response to * illegal presentation requests. */ enum wp_presentation_error { … }; /** * @ingroup iface_wp_presentation * Validate a wp_presentation error value. * * @return true on success, false on error. * @ref wp_presentation_error */ static inline bool wp_presentation_error_is_valid(uint32_t value, uint32_t version) { … } #endif /* WP_PRESENTATION_ERROR_ENUM */ /** * @ingroup iface_wp_presentation * @struct wp_presentation_interface */ struct wp_presentation_interface { … }; #define WP_PRESENTATION_CLOCK_ID … /** * @ingroup iface_wp_presentation */ #define WP_PRESENTATION_CLOCK_ID_SINCE_VERSION … /** * @ingroup iface_wp_presentation */ #define WP_PRESENTATION_DESTROY_SINCE_VERSION … /** * @ingroup iface_wp_presentation */ #define WP_PRESENTATION_FEEDBACK_SINCE_VERSION … /** * @ingroup iface_wp_presentation * Sends an clock_id event to the client owning the resource. * @param resource_ The client's resource * @param clk_id platform clock identifier */ static inline void wp_presentation_send_clock_id(struct wl_resource *resource_, uint32_t clk_id) { … } #ifndef WP_PRESENTATION_FEEDBACK_KIND_ENUM #define WP_PRESENTATION_FEEDBACK_KIND_ENUM /** * @ingroup iface_wp_presentation_feedback * bitmask of flags in presented event * * These flags provide information about how the presentation of * the related content update was done. The intent is to help * clients assess the reliability of the feedback and the visual * quality with respect to possible tearing and timings. */ enum wp_presentation_feedback_kind { … }; /** * @ingroup iface_wp_presentation_feedback * Validate a wp_presentation_feedback kind value. * * @return true on success, false on error. * @ref wp_presentation_feedback_kind */ static inline bool wp_presentation_feedback_kind_is_valid(uint32_t value, uint32_t version) { … } #endif /* WP_PRESENTATION_FEEDBACK_KIND_ENUM */ #define WP_PRESENTATION_FEEDBACK_SYNC_OUTPUT … #define WP_PRESENTATION_FEEDBACK_PRESENTED … #define WP_PRESENTATION_FEEDBACK_DISCARDED … /** * @ingroup iface_wp_presentation_feedback */ #define WP_PRESENTATION_FEEDBACK_SYNC_OUTPUT_SINCE_VERSION … /** * @ingroup iface_wp_presentation_feedback */ #define WP_PRESENTATION_FEEDBACK_PRESENTED_SINCE_VERSION … /** * @ingroup iface_wp_presentation_feedback */ #define WP_PRESENTATION_FEEDBACK_DISCARDED_SINCE_VERSION … /** * @ingroup iface_wp_presentation_feedback * Sends an sync_output event to the client owning the resource. * @param resource_ The client's resource * @param output presentation output */ static inline void wp_presentation_feedback_send_sync_output(struct wl_resource *resource_, struct wl_resource *output) { … } /** * @ingroup iface_wp_presentation_feedback * Sends an presented event to the client owning the resource. * @param resource_ The client's resource * @param tv_sec_hi high 32 bits of the seconds part of the presentation timestamp * @param tv_sec_lo low 32 bits of the seconds part of the presentation timestamp * @param tv_nsec nanoseconds part of the presentation timestamp * @param refresh nanoseconds till next refresh * @param seq_hi high 32 bits of refresh counter * @param seq_lo low 32 bits of refresh counter * @param flags combination of 'kind' values */ static inline void wp_presentation_feedback_send_presented(struct wl_resource *resource_, uint32_t tv_sec_hi, uint32_t tv_sec_lo, uint32_t tv_nsec, uint32_t refresh, uint32_t seq_hi, uint32_t seq_lo, uint32_t flags) { … } /** * @ingroup iface_wp_presentation_feedback * Sends an discarded event to the client owning the resource. * @param resource_ The client's resource */ static inline void wp_presentation_feedback_send_discarded(struct wl_resource *resource_) { … } #ifdef __cplusplus } #endif #endif
Codebase Browser
chromium