wayland::server::zwp_linux_surface_synchronization_v1_t - per-surface explicit synchronization support

       Generated automatically by Doxygen for Wayland++ from the source code.

Version 1.0.0                                Wed May 1 2024 1wayland::server::zwp_l...ce_synchronization_v1_t(3)

       per-surface explicit synchronization support

       This object implements per-surface explicit synchronization.

       Synchronization refers to co-ordination of pipelined operations performed on buffers. Most GPU clients
       will schedule an asynchronous operation to render to the buffer, then immediately send the buffer to the
       compositor to be attached to a surface.

       In implicit synchronization, ensuring that the rendering operation is complete before the compositor
       displays the buffer is an implementation detail handled by either the kernel or userspace graphics
       driver.

       By contrast, in explicit synchronization, dma_fence objects mark when the asynchronous operations are
       complete. When submitting a buffer, the client provides an acquire fence which will be waited on before
       the compositor accesses the buffer. The Wayland server, through a zwp_linux_buffer_release_v1 object,
       will inform the client with an event which may be accompanied by a release fence, when the compositor
       will no longer access the buffer contents due to the specific commit that requested the release event.

       Each surface can be associated with only one object of this interface at any time.

       In version 1 of this interface, explicit synchronization is only guaranteed to be supported for buffers
       created with any version of the wp_linux_dmabuf buffer factory. Version 2 additionally guarantees
       explicit synchronization support for opaque EGL buffers, which is a type of platform specific buffers
       described in the EGL_WL_bind_wayland_display extension. Compositors are free to support explicit
       synchronization for additional buffer types.

       Definition at line 2455 of file wayland-server-protocol-unstable.hpp.

std::stringwayland::server::resource_t::get_class()[inherited]
       Retrieve the interface name (class) of a resource object.

       Returns
           Interface name of the resource object.

   client_twayland::server::resource_t::get_client()const[inherited]
       Get the associated client

       Returns
           the client that owns the resource.

   uint32_twayland::server::resource_t::get_id()const[inherited]
       Get the internal ID of the resource

       Returns
           the internal ID of the resource

   unsignedintwayland::server::resource_t::get_version()const[inherited]
       Get interface version

       Returns
           Interface version this resource has been constructed with.

   std::function<void()>&zwp_linux_surface_synchronization_v1_t::on_destroy()
       destroy synchronization object Destroy this explicit synchronization object.

       Any fence set by this object with set_acquire_fence since the last commit will be discarded by the
       server. Any fences set by this object before the last commit are not affected.

       zwp_linux_buffer_release_v1 objects created by this object are not affected by this request.

       Definition at line 5250 of file wayland-server-protocol-unstable.cpp.

   std::function<void(zwp_linux_buffer_release_v1_t)>&zwp_linux_surface_synchronization_v1_t::on_get_release()
       release fence for last-attached buffer

       Parametersrelease new zwp_linux_buffer_release_v1 object

       Create a listener for the release of the buffer attached by the client with wl_surface.attach. See
       zwp_linux_buffer_release_v1 documentation for more information.

       The release object is double-buffered state, and will be associated with the buffer that is attached to
       the surface at wl_surface.commit time.

       If a zwp_linux_buffer_release_v1 object has already been requested for the surface in the same commit
       cycle, a DUPLICATE_RELEASE error is raised.

       If the associated wl_surface was destroyed, a NO_SURFACE error is raised.

       If at surface commit time there is no buffer attached, a NO_BUFFER error is raised.

       Definition at line 5262 of file wayland-server-protocol-unstable.cpp.

   std::function<void(int)>&zwp_linux_surface_synchronization_v1_t::on_set_acquire_fence()
       set the acquire fence

       Parametersfd acquire fence fd

       Set the acquire fence that must be signaled before the compositor may sample from the buffer attached
       with wl_surface.attach. The fence is a dma_fence kernel object.

       The acquire fence is double-buffered state, and will be applied on the next wl_surface.commit request for
       the associated surface. Thus, it applies only to the buffer that is attached to the surface at commit
       time.

       If the provided fd is not a valid dma_fence fd, then an INVALID_FENCE error is raised.

       If a fence has already been attached during the same commit cycle, a DUPLICATE_FENCE error is raised.

       If the associated wl_surface was destroyed, a NO_SURFACE error is raised.

       If at surface commit time the attached buffer does not support explicit synchronization, an
       UNSUPPORTED_BUFFER error is raised.

       If at surface commit time there is no buffer attached, a NO_BUFFER error is raised.

       Definition at line 5256 of file wayland-server-protocol-unstable.cpp.

   voidzwp_linux_surface_synchronization_v1_t::post_duplicate_fence(std::stringconst&msg)
       Post error: multiple fences added for a single surface commit.

       Definition at line 5273 of file wayland-server-protocol-unstable.cpp.

   voidzwp_linux_surface_synchronization_v1_t::post_duplicate_release(std::stringconst&msg)
       Post error: multiple releases added for a single surface commit.

       Definition at line 5278 of file wayland-server-protocol-unstable.cpp.

   voidzwp_linux_surface_synchronization_v1_t::post_invalid_fence(std::stringconst&msg)
       Post error: the fence specified by the client could not be imported.

       Definition at line 5268 of file wayland-server-protocol-unstable.cpp.

   voidzwp_linux_surface_synchronization_v1_t::post_no_buffer(std::stringconst&msg)
       Post error: no buffer was attached.

       Definition at line 5293 of file wayland-server-protocol-unstable.cpp.

   voidwayland::server::resource_t::post_no_memory()const[inherited]
       Post 'not enough memory' error to the client

       If the compositor has not enough memory to fulfill a certail request of the client, this function can be
       called to notify the client of this circumstance.

   voidzwp_linux_surface_synchronization_v1_t::post_no_surface(std::stringconst&msg)
       Post error: the associated wl_surface was destroyed.

       Definition at line 5283 of file wayland-server-protocol-unstable.cpp.

   voidzwp_linux_surface_synchronization_v1_t::post_unsupported_buffer(std::stringconst&msg)
       Post error: the buffer does not support explicit synchronization.

       Definition at line 5288 of file wayland-server-protocol-unstable.cpp.

   boolwayland::server::resource_t::proxy_has_object()const[inherited]
       Check whether this wrapper actually wraps an object.

       Returns
           true if there is an underlying object, false if this wrapper is empty

       wayland::server::zwp_linux_surface_synchronization_v1_t - per-surface explicit synchronization support

       #include <wayland-server-protocol-unstable.hpp>

       Inherits wayland::server::resource_t.

   PublicMemberFunctions
       std::function< void()> & on_destroy ()
           destroy synchronization object
       std::function< void(int)> & on_set_acquire_fence ()
           set the acquire fence
       std::function< void(zwp_linux_buffer_release_v1_t)> & on_get_release ()
           release fence for last-attached buffer
       void post_invalid_fence (std::string const &msg)
           Post error: the fence specified by the client could not be imported.
       void post_duplicate_fence (std::string const &msg)
           Post error: multiple fences added for a single surface commit.
       void post_duplicate_release (std::string const &msg)
           Post error: multiple releases added for a single surface commit.
       void post_no_surface (std::string const &msg)
           Post error: the associated wl_surface was destroyed.
       void post_unsupported_buffer (std::string const &msg)
           Post error: the buffer does not support explicit synchronization.
       void post_no_buffer (std::string const &msg)
           Post error: no buffer was attached.
       bool proxy_has_object () const
           Check whether this wrapper actually wraps an object.
       void post_no_memory () const
       uint32_t get_id () const
       client_t get_client () const
       unsigned int get_version () const
       std::string get_class ()