xdg_foreign_unstable_v2

• # zxdg_exporter_v2

  A global interface used for exporting surfaces that can later be imported using xdg_importer.

  Requests

  • #

    destroy

    destroy the xdg_exporter object
    void zxdg_exporter_v2_destroy(

    struct zxdg_exporter_v2* zxdg_exporter_v2

    )
    Notify the compositor that the xdg_exporter object will no longer be used.
  • #

    export_toplevel

    export a toplevel surface
    struct zxdg_exported_v2* zxdg_exporter_v2_export_toplevel(

    struct zxdg_exporter_v2* zxdg_exporter_v2,

    struct wl_surface* surface /* the surface to export */

    )
    The export_toplevel request exports the passed surface so that it can later be imported via xdg_importer. When called, a new xdg_exported object will be created and xdg_exported.handle will be sent immediately. See the corresponding interface and event for details. A surface may be exported multiple times, and each exported handle may be used to create an xdg_imported multiple times. Only xdg_toplevel equivalent surfaces may be exported, otherwise an invalid_surface protocol error is sent.

  Enums

  • #

    error

    error values
    ZXDG_EXPORTER_V2_ERROR_INVALID_SURFACE /* surface is not an xdg_toplevel */
    These errors can be emitted in response to invalid xdg_exporter requests.

• # zxdg_importer_v2

  A global interface used for importing surfaces exported by xdg_exporter. With this interface, a client can create a reference to a surface of another client.

  Requests

  • #

    destroy

    destroy the xdg_importer object
    void zxdg_importer_v2_destroy(

    struct zxdg_importer_v2* zxdg_importer_v2

    )
    Notify the compositor that the xdg_importer object will no longer be used.
  • #

    import_toplevel

    import a toplevel surface
    struct zxdg_imported_v2* zxdg_importer_v2_import_toplevel(

    struct zxdg_importer_v2* zxdg_importer_v2,

    const char* handle /* the exported surface handle */

    )
    The import_toplevel request imports a surface from any client given a handle retrieved by exporting said surface using xdg_exporter.export_toplevel. When called, a new xdg_imported object will be created. This new object represents the imported surface, and the importing client can manipulate its relationship using it. See xdg_imported for details.

• # zxdg_exported_v2

  An xdg_exported object represents an exported reference to a surface. The exported surface may be referenced as long as the xdg_exported object not destroyed. Destroying the xdg_exported invalidates any relationship the importer may have established using xdg_imported.

  Requests

  • #

    destroy

    unexport the exported surface
    void zxdg_exported_v2_destroy(

    struct zxdg_exported_v2* zxdg_exported_v2

    )
    Revoke the previously exported surface. This invalidates any relationship the importer may have set up using the xdg_imported created given the handle sent via xdg_exported.handle.

  Events

  • #

    handle

    the exported surface handle
    const char* handle /* the exported surface handle */
    The handle event contains the unique handle of this exported surface reference. It may be shared with any client, which then can use it to import the surface by calling xdg_importer.import_toplevel. A handle may be used to import the surface multiple times.

• # zxdg_imported_v2

  An xdg_imported object represents an imported reference to surface exported by some client. A client can use this interface to manipulate relationships between its own surfaces and the imported surface.

  Requests

  • #

    destroy

    destroy the xdg_imported object
    void zxdg_imported_v2_destroy(

    struct zxdg_imported_v2* zxdg_imported_v2

    )
    Notify the compositor that it will no longer use the xdg_imported object. Any relationship that may have been set up will at this point be invalidated.
  • #

    set_parent_of

    set as the parent of some surface
    void zxdg_imported_v2_set_parent_of(

    struct zxdg_imported_v2* zxdg_imported_v2,

    struct wl_surface* surface /* the child surface */

    )
    Set the imported surface as the parent of some surface of the client. The passed surface must be an xdg_toplevel equivalent, otherwise an invalid_surface protocol error is sent. Calling this function sets up a surface to surface relation with the same stacking and positioning semantics as xdg_toplevel.set_parent.

  Events

  • #

    destroyed

    the imported surface handle has been destroyed
    The imported surface handle has been destroyed and any relationship set up has been invalidated. This may happen for various reasons, for example if the exported surface or the exported surface handle has been destroyed, if the handle used for importing was invalid.

  Enums

  • #

    error

    error values
    ZXDG_IMPORTED_V2_ERROR_INVALID_SURFACE /* surface is not an xdg_toplevel */
    These errors can be emitted in response to invalid xdg_imported requests.

Copyright Info