xwayland_shell_v1

• # xwayland_shell_v1

  xwayland_shell_v1 is a singleton global object that provides the ability to create a xwayland_surface_v1 object for a given wl_surface. This interface is intended to be bound by the Xwayland server. A compositor must not allow clients other than Xwayland to bind to this interface. A compositor should hide this global from other clients' wl_registry. A client the compositor does not consider to be an Xwayland server attempting to bind this interface will result in an implementation-defined error. An Xwayland server that has bound this interface must not set the `WL_SURFACE_ID` atom on a window.

  Requests

  • #

    destroy

    destroy the Xwayland shell object
    void xwayland_shell_v1_destroy(

    struct xwayland_shell_v1* xwayland_shell_v1

    )
    Destroy the xwayland_shell_v1 object. The child objects created via this interface are unaffected.
  • #

    get_xwayland_surface

    assign the xwayland_surface surface role
    struct xwayland_surface_v1* xwayland_shell_v1_get_xwayland_surface(

    struct xwayland_shell_v1* xwayland_shell_v1,

    struct wl_surface* surface

    )
    Create an xwayland_surface_v1 interface for a given wl_surface object and gives it the xwayland_surface role. It is illegal to create an xwayland_surface_v1 for a wl_surface which already has an assigned role and this will result in the `role` protocol error. See the documentation of xwayland_surface_v1 for more details about what an xwayland_surface_v1 is and how it is used.

  Enums

  • #

    error
    XWAYLAND_SHELL_V1_ERROR_ROLE /* given wl_surface has another role */

• # xwayland_surface_v1

  An Xwayland surface is a surface managed by an Xwayland server. It is used for associating surfaces to Xwayland windows. The Xwayland server associated with actions in this interface is determined by the Wayland client making the request. The client must call wl_surface.commit on the corresponding wl_surface for the xwayland_surface_v1 state to take effect.

  Requests

  • #

    set_serial

    associates a Xwayland window to a wl_surface
    void xwayland_surface_v1_set_serial(

    struct xwayland_surface_v1* xwayland_surface_v1,

    uint32_t serial_lo, /* The lower 32-bits of the serial number associated with the X11 window */

    uint32_t serial_hi /* The upper 32-bits of the serial number associated with the X11 window */

    )
    Associates an Xwayland window to a wl_surface. The association state is double-buffered, see wl_surface.commit. The `serial_lo` and `serial_hi` parameters specify a non-zero monotonic serial number which is entirely unique and provided by the Xwayland server equal to the serial value provided by a client message with a message type of the `WL_SURFACE_SERIAL` atom on the X11 window for this surface to be associated to. The serial value in the `WL_SURFACE_SERIAL` client message is specified as having the lo-bits specified in `l[0]` and the hi-bits specified in `l[1]`. If the serial value provided by `serial_lo` and `serial_hi` is not valid, the `invalid_serial` protocol error will be raised. An X11 window may be associated with multiple surfaces throughout its lifespan. (eg. unmapping and remapping a window). For each wl_surface, this state must not be committed more than once, otherwise the `already_associated` protocol error will be raised.
  • #

    destroy

    destroy the Xwayland surface object
    void xwayland_surface_v1_destroy(

    struct xwayland_surface_v1* xwayland_surface_v1

    )
    Destroy the xwayland_surface_v1 object. Any already existing associations are unaffected by this action.

  Enums

  • #

    error
    XWAYLAND_SURFACE_V1_ERROR_ALREADY_ASSOCIATED /* given wl_surface is already associated with an X11 window */
    XWAYLAND_SURFACE_V1_ERROR_INVALID_SERIAL /* serial was not valid */

Copyright Info