# This file has been autogenerated by the pywayland scanner

# Copyright 2016 The Chromium Authors.
# Copyright 2017 Intel Corporation
# Copyright 2018 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.

from __future__ import annotations

import enum

from pywayland.protocol_core import Argument, ArgumentType, Global, Interface, Proxy, Resource

from .wayland import WlSurface
from .wayland import WlSurfaceProxy


class ZwpLinuxBufferReleaseV1(Interface):
    """Buffer release explicit synchronization

    This object is instantiated in response to a
    :func:`ZwpLinuxSurfaceSynchronizationV1.get_release()
    <pywayland.protocol.zwp_linux_explicit_synchronization_unstable_v1.ZwpLinuxSurfaceSynchronizationV1.get_release>`
    request.

    It provides an alternative to :func:`WlBuffer.release()
    <pywayland.protocol.wayland.WlBuffer.release>` events, providing a unique
    release from a single :func:`WlSurface.commit()
    <pywayland.protocol.wayland.WlSurface.commit>` request. The release event
    also supports explicit synchronization, providing a fence FD for the client
    to synchronize against.

    Exactly one event, either a fenced_release or an immediate_release, will be
    emitted for the :func:`WlSurface.commit()
    <pywayland.protocol.wayland.WlSurface.commit>` request. The compositor can
    choose release by release which event it uses.

    This event does not replace :func:`WlBuffer.release()
    <pywayland.protocol.wayland.WlBuffer.release>` events; servers are still
    required to send those events.

    Once a buffer release object has delivered a 'fenced_release' or an
    'immediate_release' event it is automatically destroyed.
    """

    name = "zwp_linux_buffer_release_v1"
    version = 1


class ZwpLinuxExplicitSynchronizationV1(Interface):
    """Protocol for providing explicit synchronization

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

    See
    :class:`~pywayland.protocol.zwp_linux_explicit_synchronization_unstable_v1.ZwpLinuxSurfaceSynchronizationV1`
    for more information.

    This interface is derived from Chromium's
    zcr_linux_explicit_synchronization_v1.

    Note: this protocol is superseded by linux-drm-syncobj.

    Warning! The protocol described in this file is experimental and backward
    incompatible changes may be made. Backward compatible changes may be added
    together with the corresponding interface version bump. Backward
    incompatible changes are done by bumping the version number in the protocol
    and interface names and resetting the interface version. Once the protocol
    is to be declared stable, the 'z' prefix and the version number in the
    protocol and interface names are removed and the interface version number
    is reset.
    """

    name = "zwp_linux_explicit_synchronization_v1"
    version = 2

    class error(enum.IntEnum):
        synchronization_exists = 0


class ZwpLinuxSurfaceSynchronizationV1(Interface):
    """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
    :class:`~pywayland.protocol.zwp_linux_explicit_synchronization_unstable_v1.ZwpLinuxBufferReleaseV1`
    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.
    """

    name = "zwp_linux_surface_synchronization_v1"
    version = 2

    class error(enum.IntEnum):
        invalid_fence = 0
        duplicate_fence = 1
        duplicate_release = 2
        no_surface = 3
        unsupported_buffer = 4
        no_buffer = 5


class ZwpLinuxBufferReleaseV1Resource(Resource[ZwpLinuxBufferReleaseV1]):
    interface = ZwpLinuxBufferReleaseV1

    @ZwpLinuxBufferReleaseV1.event(
        Argument(ArgumentType.FileDescriptor),
    )
    def fenced_release(self, fence: int) -> None:
        """Release buffer with fence

        Sent when the compositor has finalised its usage of the associated
        buffer for the relevant commit, providing a dma_fence which will be
        signaled when all operations by the compositor on that buffer for that
        commit have finished.

        Once the fence has signaled, and assuming the associated buffer is not
        pending release from other :func:`WlSurface.commit()
        <pywayland.protocol.wayland.WlSurface.commit>` requests, no additional
        explicit or implicit synchronization is required to safely reuse or
        destroy the buffer.

        This event destroys the :class:`ZwpLinuxBufferReleaseV1` object.

        :param fence:
            fence for last operation on buffer
        :type fence:
            `ArgumentType.FileDescriptor`
        """
        self._post_event(0, fence)

    @ZwpLinuxBufferReleaseV1.event()
    def immediate_release(self) -> None:
        """Release buffer immediately

        Sent when the compositor has finalised its usage of the associated
        buffer for the relevant commit, and either performed no operations
        using it, or has a guarantee that all its operations on that buffer for
        that commit have finished.

        Once this event is received, and assuming the associated buffer is not
        pending release from other :func:`WlSurface.commit()
        <pywayland.protocol.wayland.WlSurface.commit>` requests, no additional
        explicit or implicit synchronization is required to safely reuse or
        destroy the buffer.

        This event destroys the :class:`ZwpLinuxBufferReleaseV1` object.
        """
        self._post_event(1)


class ZwpLinuxExplicitSynchronizationV1Resource(Resource[ZwpLinuxExplicitSynchronizationV1]):
    interface = ZwpLinuxExplicitSynchronizationV1


class ZwpLinuxSurfaceSynchronizationV1Resource(Resource[ZwpLinuxSurfaceSynchronizationV1]):
    interface = ZwpLinuxSurfaceSynchronizationV1


class ZwpLinuxBufferReleaseV1Proxy(Proxy[ZwpLinuxBufferReleaseV1]):
    interface = ZwpLinuxBufferReleaseV1


class ZwpLinuxExplicitSynchronizationV1Proxy(Proxy[ZwpLinuxExplicitSynchronizationV1]):
    interface = ZwpLinuxExplicitSynchronizationV1

    @ZwpLinuxExplicitSynchronizationV1.request()
    def destroy(self) -> None:
        """Destroy explicit synchronization factory object

        Destroy this explicit synchronization factory object. Other objects,
        including
        :class:`~pywayland.protocol.zwp_linux_explicit_synchronization_unstable_v1.ZwpLinuxSurfaceSynchronizationV1`
        objects created by this factory, shall not be affected by this request.
        """
        self._marshal(0)
        self._destroy()

    @ZwpLinuxExplicitSynchronizationV1.request(
        Argument(ArgumentType.NewId, interface=ZwpLinuxSurfaceSynchronizationV1),
        Argument(ArgumentType.Object, interface=WlSurface),
    )
    def get_synchronization(self, surface: WlSurfaceProxy) -> ZwpLinuxSurfaceSynchronizationV1Proxy:
        """Extend surface interface for explicit synchronization

        Instantiate an interface extension for the given
        :class:`~pywayland.protocol.wayland.WlSurface` to provide explicit
        synchronization.

        If the given :class:`~pywayland.protocol.wayland.WlSurface` already has
        an explicit synchronization object associated, the
        synchronization_exists protocol error is raised.

        Graphics APIs, like EGL or Vulkan, that manage the buffer queue and
        commits of a :class:`~pywayland.protocol.wayland.WlSurface` themselves,
        are likely to be using this extension internally. If a client is using
        such an API for a :class:`~pywayland.protocol.wayland.WlSurface`, it
        should not directly use this extension on that surface, to avoid
        raising a synchronization_exists protocol error.

        :param surface:
            the surface
        :type surface:
            :class:`~pywayland.protocol.wayland.WlSurface`
        :returns:
            :class:`~pywayland.protocol.zwp_linux_explicit_synchronization_unstable_v1.ZwpLinuxSurfaceSynchronizationV1`
            -- the new synchronization interface id
        """
        id = self._marshal_constructor(1, ZwpLinuxSurfaceSynchronizationV1, surface)
        return id


class ZwpLinuxSurfaceSynchronizationV1Proxy(Proxy[ZwpLinuxSurfaceSynchronizationV1]):
    interface = ZwpLinuxSurfaceSynchronizationV1

    @ZwpLinuxSurfaceSynchronizationV1.request()
    def destroy(self) -> None:
        """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.

        :class:`~pywayland.protocol.zwp_linux_explicit_synchronization_unstable_v1.ZwpLinuxBufferReleaseV1`
        objects created by this object are not affected by this request.
        """
        self._marshal(0)
        self._destroy()

    @ZwpLinuxSurfaceSynchronizationV1.request(
        Argument(ArgumentType.FileDescriptor),
    )
    def set_acquire_fence(self, fd: int) -> None:
        """Set the acquire fence

        Set the acquire fence that must be signaled before the compositor may
        sample from the buffer attached with :func:`WlSurface.attach()
        <pywayland.protocol.wayland.WlSurface.attach>`. The fence is a
        dma_fence kernel object.

        The acquire fence is double-buffered state, and will be applied on the
        next :func:`WlSurface.commit()
        <pywayland.protocol.wayland.WlSurface.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 :class:`~pywayland.protocol.wayland.WlSurface` 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.

        :param fd:
            acquire fence fd
        :type fd:
            `ArgumentType.FileDescriptor`
        """
        self._marshal(1, fd)

    @ZwpLinuxSurfaceSynchronizationV1.request(
        Argument(ArgumentType.NewId, interface=ZwpLinuxBufferReleaseV1),
    )
    def get_release(self) -> ZwpLinuxBufferReleaseV1Proxy:
        """Release fence for last-attached buffer

        Create a listener for the release of the buffer attached by the client
        with :func:`WlSurface.attach()
        <pywayland.protocol.wayland.WlSurface.attach>`. See
        :class:`~pywayland.protocol.zwp_linux_explicit_synchronization_unstable_v1.ZwpLinuxBufferReleaseV1`
        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
        :func:`WlSurface.commit()
        <pywayland.protocol.wayland.WlSurface.commit>` time.

        If a
        :class:`~pywayland.protocol.zwp_linux_explicit_synchronization_unstable_v1.ZwpLinuxBufferReleaseV1`
        object has already been requested for the surface in the same commit
        cycle, a DUPLICATE_RELEASE error is raised.

        If the associated :class:`~pywayland.protocol.wayland.WlSurface` was
        destroyed, a NO_SURFACE error is raised.

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

        :returns:
            :class:`~pywayland.protocol.zwp_linux_explicit_synchronization_unstable_v1.ZwpLinuxBufferReleaseV1`
            -- new
            :class:`~pywayland.protocol.zwp_linux_explicit_synchronization_unstable_v1.ZwpLinuxBufferReleaseV1`
            object
        """
        release = self._marshal_constructor(2, ZwpLinuxBufferReleaseV1)
        return release


class ZwpLinuxBufferReleaseV1Global(Global[ZwpLinuxBufferReleaseV1]):
    interface = ZwpLinuxBufferReleaseV1


class ZwpLinuxExplicitSynchronizationV1Global(Global[ZwpLinuxExplicitSynchronizationV1]):
    interface = ZwpLinuxExplicitSynchronizationV1


class ZwpLinuxSurfaceSynchronizationV1Global(Global[ZwpLinuxSurfaceSynchronizationV1]):
    interface = ZwpLinuxSurfaceSynchronizationV1


ZwpLinuxBufferReleaseV1._gen_c()
ZwpLinuxBufferReleaseV1.proxy_class = ZwpLinuxBufferReleaseV1Proxy
ZwpLinuxBufferReleaseV1.resource_class = ZwpLinuxBufferReleaseV1Resource
ZwpLinuxBufferReleaseV1.global_class = ZwpLinuxBufferReleaseV1Global


ZwpLinuxExplicitSynchronizationV1._gen_c()
ZwpLinuxExplicitSynchronizationV1.proxy_class = ZwpLinuxExplicitSynchronizationV1Proxy
ZwpLinuxExplicitSynchronizationV1.resource_class = ZwpLinuxExplicitSynchronizationV1Resource
ZwpLinuxExplicitSynchronizationV1.global_class = ZwpLinuxExplicitSynchronizationV1Global


ZwpLinuxSurfaceSynchronizationV1._gen_c()
ZwpLinuxSurfaceSynchronizationV1.proxy_class = ZwpLinuxSurfaceSynchronizationV1Proxy
ZwpLinuxSurfaceSynchronizationV1.resource_class = ZwpLinuxSurfaceSynchronizationV1Resource
ZwpLinuxSurfaceSynchronizationV1.global_class = ZwpLinuxSurfaceSynchronizationV1Global
