linux_drm_syncobj_v1

• # wp_linux_drm_syncobj_manager_v1

  This global is a factory interface, allowing clients to request explicit synchronization for buffers on a per-surface basis. See wp_linux_drm_syncobj_surface_v1 for more information.

  Requests

  • #

    destroy

    destroy explicit synchronization factory object
    void wp_linux_drm_syncobj_manager_v1_destroy(

    struct wp_linux_drm_syncobj_manager_v1* wp_linux_drm_syncobj_manager_v1

    )
    Destroy this explicit synchronization factory object. Other objects shall not be affected by this request.
  • #

    get_surface

    extend surface interface for explicit synchronization
    struct wp_linux_drm_syncobj_surface_v1* wp_linux_drm_syncobj_manager_v1_get_surface(

    struct wp_linux_drm_syncobj_manager_v1* wp_linux_drm_syncobj_manager_v1,

    struct wl_surface* surface /* the surface */

    )
    Instantiate an interface extension for the given wl_surface to provide explicit synchronization. If the given wl_surface already has an explicit synchronization object associated, the surface_exists protocol error is raised. Graphics APIs, like EGL or Vulkan, that manage the buffer queue and commits of a wl_surface themselves, are likely to be using this extension internally. If a client is using such an API for a wl_surface, it should not directly use this extension on that surface, to avoid raising a surface_exists protocol error.
  • #

    import_timeline

    import a DRM syncobj timeline
    struct wp_linux_drm_syncobj_timeline_v1* wp_linux_drm_syncobj_manager_v1_import_timeline(

    struct wp_linux_drm_syncobj_manager_v1* wp_linux_drm_syncobj_manager_v1,

    int32_t fd /* drm_syncobj file descriptor */

    )
    Import a DRM synchronization object timeline. If the FD cannot be imported, the invalid_timeline error is raised.

  Enums

  • #

    error
    WP_LINUX_DRM_SYNCOBJ_MANAGER_V1_ERROR_SURFACE_EXISTS /* the surface already has a synchronization object associated */
    WP_LINUX_DRM_SYNCOBJ_MANAGER_V1_ERROR_INVALID_TIMELINE /* the timeline object could not be imported */

• # wp_linux_drm_syncobj_timeline_v1

  This object represents an explicit synchronization object timeline imported by the client to the compositor.

  Requests

  • #

    destroy

    destroy the timeline
    void wp_linux_drm_syncobj_timeline_v1_destroy(

    struct wp_linux_drm_syncobj_timeline_v1* wp_linux_drm_syncobj_timeline_v1

    )
    Destroy the synchronization object timeline. Other objects are not affected by this request, in particular timeline points set by set_acquire_point and set_release_point are not unset.

• # wp_linux_drm_syncobj_surface_v1

  This object is an add-on interface for wl_surface to enable explicit synchronization. Each surface can be associated with only one object of this interface at any time. Explicit synchronization is guaranteed to be supported for buffers created with any version of the linux-dmabuf protocol. Compositors are free to support explicit synchronization for additional buffer types. If at surface commit time the attached buffer does not support explicit synchronization, an unsupported_buffer error is raised. As long as the wp_linux_drm_syncobj_surface_v1 object is alive, the compositor may ignore implicit synchronization for buffers attached and committed to the wl_surface. The delivery of wl_buffer.release events for buffers attached to the surface becomes undefined. Clients must set both acquire and release points if and only if a non-null buffer is attached in the same surface commit. See the no_buffer, no_acquire_point and no_release_point protocol errors. If at surface commit time the acquire and release DRM syncobj timelines are identical, the acquire point value must be strictly less than the release point value, or else the conflicting_points protocol error is raised.

  Requests

  • #

    destroy

    destroy the surface synchronization object
    void wp_linux_drm_syncobj_surface_v1_destroy(

    struct wp_linux_drm_syncobj_surface_v1* wp_linux_drm_syncobj_surface_v1

    )
    Destroy this surface synchronization object. Any timeline point set by this object with set_acquire_point or set_release_point since the last commit may be discarded by the compositor. Any timeline point set by this object before the last commit will not be affected.
  • #

    set_acquire_point

    set the acquire timeline point
    void wp_linux_drm_syncobj_surface_v1_set_acquire_point(

    struct wp_linux_drm_syncobj_surface_v1* wp_linux_drm_syncobj_surface_v1,

    struct wp_linux_drm_syncobj_timeline_v1* timeline,

    uint32_t point_hi, /* high 32 bits of the point value */

    uint32_t point_lo /* low 32 bits of the point value */

    )
    Set the timeline point that must be signalled before the compositor may sample from the buffer attached with wl_surface.attach. The 64-bit unsigned value combined from point_hi and point_lo is the point value. The acquire point 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 an acquire point has already been attached during the same commit cycle, the new point replaces the old one. If the associated wl_surface was destroyed, a no_surface error is raised. If at surface commit time there is a pending acquire timeline point set but no pending buffer attached, a no_buffer error is raised. If at surface commit time there is a pending buffer attached but no pending acquire timeline point set, the no_acquire_point protocol error is raised.
  • #

    set_release_point

    set the release timeline point
    void wp_linux_drm_syncobj_surface_v1_set_release_point(

    struct wp_linux_drm_syncobj_surface_v1* wp_linux_drm_syncobj_surface_v1,

    struct wp_linux_drm_syncobj_timeline_v1* timeline,

    uint32_t point_hi, /* high 32 bits of the point value */

    uint32_t point_lo /* low 32 bits of the point value */

    )
    Set the timeline point that must be signalled by the compositor when it has finished its usage of the buffer attached with wl_surface.attach for the relevant commit. Once the timeline point is signaled, and assuming the associated buffer is not pending release from other wl_surface.commit requests, no additional explicit or implicit synchronization with the compositor is required to safely re-use the buffer. Note that clients cannot rely on the release point being always signaled after the acquire point: compositors may release buffers without ever reading from them. In addition, the compositor may use different presentation paths for different commits, which may have different release behavior. As a result, the compositor may signal the release points in a different order than the client committed them. Because signaling a timeline point also signals every previous point, it is generally not safe to use the same timeline object for the release points of multiple buffers. The out-of-order signaling described above may lead to a release point being signaled before the compositor has finished reading. To avoid this, it is strongly recommended that each buffer should use a separate timeline for its release points. The 64-bit unsigned value combined from point_hi and point_lo is the point value. The release point 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 a release point has already been attached during the same commit cycle, the new point replaces the old one. If the associated wl_surface was destroyed, a no_surface error is raised. If at surface commit time there is a pending release timeline point set but no pending buffer attached, a no_buffer error is raised. If at surface commit time there is a pending buffer attached but no pending release timeline point set, the no_release_point protocol error is raised.

  Enums

  • #

    error
    WP_LINUX_DRM_SYNCOBJ_SURFACE_V1_ERROR_NO_SURFACE /* the associated wl_surface was destroyed */
    WP_LINUX_DRM_SYNCOBJ_SURFACE_V1_ERROR_UNSUPPORTED_BUFFER /* the buffer does not support explicit synchronization */
    WP_LINUX_DRM_SYNCOBJ_SURFACE_V1_ERROR_NO_BUFFER /* no buffer was attached */
    WP_LINUX_DRM_SYNCOBJ_SURFACE_V1_ERROR_NO_ACQUIRE_POINT /* no acquire timeline point was set */
    WP_LINUX_DRM_SYNCOBJ_SURFACE_V1_ERROR_NO_RELEASE_POINT /* no release timeline point was set */
    WP_LINUX_DRM_SYNCOBJ_SURFACE_V1_ERROR_CONFLICTING_POINTS /* acquire and release timeline points are in conflict */

Copyright Info