Skip to content

wp_drm_lease_connector_v1¤

wayland.wp_drm_lease_connector_v1 ¤

A leasable drm connector

Represents a DRM connector which is available for lease. These objects are created via wp_drm_lease_device_v1.connector events, and should be passed to lease requests via wp_drm_lease_request_v1.request_connector. Immediately after the wp_drm_lease_connector_v1 object is created the compositor will send a name, a description, a connector_id and a done event. When the description is updated the compositor will send a description event followed by a done event.

Methods:

events

name ¤

name(name: str) -> None

Name

The compositor sends this event once the connector is created to indicate the name of this connector. This will not change for the duration of the Wayland session, but is not guaranteed to be consistent between sessions.

If the compositor supports wl_output version 4 and this connector corresponds to a wl_output, the compositor should use the same name as for the wl_output.

Parameters:

  • name ¤

    (str) –

    Connector name

description ¤

description(description: str) -> None

Description

The compositor sends this event once the connector is created to provide a human-readable description for this connector, which may be presented to the user. The compositor may send this event multiple times over the lifetime of this object to reflect changes in the description.

Parameters:

  • description ¤

    (str) –

    Connector description

connector_id ¤

connector_id(connector_id: int) -> None

connector_id

The compositor sends this event once the connector is created to indicate the DRM object ID which represents the underlying connector that is being offered. Note that the final lease may include additional object IDs, such as CRTCs and planes.

Parameters:

  • connector_id ¤

    (int) –

    Drm connector id

done ¤

done() -> None

All properties have been sent

This event is sent after all properties of a connector have been sent. This allows changes to the properties to be seen as atomic even if they happen via multiple events.

withdrawn ¤

withdrawn() -> None

Lease offer withdrawn

Sent to indicate that the compositor will no longer honor requests for DRM leases which include this connector. The client may still issue a lease request including this connector, but the compositor will send wp_drm_lease_v1.finished without issuing a lease fd. Compositors are encouraged to send this event when they lose access to connector, for example when the connector is hot-unplugged, when the connector gets leased to a client or when the compositor loses DRM master.

If a client holds a lease for the connector, the status of the lease remains the same. The client should destroy the object after receiving this event.

destroy ¤

destroy() -> None

Destroy connector

The client may send this request to indicate that it will not use this connector. Clients are encouraged to send this after receiving the "withdrawn" event so that the server can release the resources associated with this connector offer. Neither existing lease requests nor leases will be affected.

on_name ¤

on_name(name: str) -> None

Name.

Override to handle wayland.wp_drm_lease_connector_v1.events.name.

on_description ¤

on_description(description: str) -> None

Description.

Override to handle wayland.wp_drm_lease_connector_v1.events.description.

on_connector_id ¤

on_connector_id(connector_id: int) -> None

connector_id.

Override to handle wayland.wp_drm_lease_connector_v1.events.connector_id.

on_done ¤

on_done() -> None

All properties have been sent.

Override to handle wayland.wp_drm_lease_connector_v1.events.done.

on_withdrawn ¤

on_withdrawn() -> None

Lease offer withdrawn.

Override to handle wayland.wp_drm_lease_connector_v1.events.withdrawn.