zwlr_output_configuration_v1¤
Output configuration
This object is used by the client to describe a full output configuration.
First, the client needs to setup the output configuration. Each head can be either enabled (and configured) or disabled. It is a protocol error to send two enable_head or disable_head requests with the same head. It is a protocol error to omit a head in a configuration.
Then, the client can apply or test the configuration. The compositor will then reply with a succeeded, failed or cancelled event. Finally the client should destroy the configuration object.
Methods:
-
enable_head–Enable and configure a head
-
disable_head–Disable a head
-
apply–Apply the configuration
-
test–Test the configuration
-
destroy–Destroy the output configuration
-
on_succeeded–Configuration changes succeeded.
-
on_failed–Configuration changes failed.
-
on_cancelled–Configuration has been cancelled.
-
already_configured_head–Head has been configured twice -
unconfigured_head–Head has not been configured -
already_used–Request sent after configuration has been applied or tested
succeeded() -> None
Configuration changes succeeded
Sent after the compositor has successfully applied the changes or tested them.
Upon receiving this event, the client should destroy this object.
If the current configuration has changed, events to describe the changes will be sent followed by a wlr_output_manager.done event.
failed() -> None
Configuration changes failed
Sent if the compositor rejects the changes or failed to apply them. The compositor should revert any changes made by the apply request that triggered this event.
Upon receiving this event, the client should destroy this object.
cancelled() -> None
Configuration has been cancelled
Sent if the compositor cancels the configuration because the state of an output changed and the client has outdated information (e.g. after an output has been hotplugged).
The client can create a new configuration with a newer serial and try again.
Upon receiving this event, the client should destroy this object.
enable_head(head: zwlr_output_head_v1) -> zwlr_output_configuration_head_v1
Enable and configure a head
Enable a head. This request creates a head configuration object that can be used to change the head's properties.
Parameters:
-
(head¤zwlr_output_head_v1) –The head to be enabled
Returns:
-
zwlr_output_configuration_head_v1(zwlr_output_configuration_head_v1) –The created object
disable_head(head: zwlr_output_head_v1) -> None
apply() -> None
Apply the configuration
Apply the new output configuration.
In case the configuration is successfully applied, there is no guarantee that the new output state matches completely the requested configuration. For instance, a compositor might round the scale if it doesn't support fractional scaling.
After this request has been sent, the compositor must respond with an succeeded, failed or cancelled event. Sending a request that isn't the destructor is a protocol error.
test() -> None
Test the configuration
Test the new output configuration. The configuration won't be applied, but will only be validated.
Even if the compositor succeeds to test a configuration, applying it may fail.
After this request has been sent, the compositor must respond with an succeeded, failed or cancelled event. Sending a request that isn't the destructor is a protocol error.
destroy() -> None
Destroy the output configuration
Using this request a client can tell the compositor that it is not going to use the configuration object anymore. Any changes to the outputs that have not been applied will be discarded.
This request also destroys wlr_output_configuration_head objects created via this object.
on_succeeded() -> None
Configuration changes succeeded.
Override to handle wayland.zwlr_output_configuration_v1.events.succeeded.
on_failed() -> None
Configuration changes failed.
Override to handle wayland.zwlr_output_configuration_v1.events.failed.
on_cancelled() -> None
Configuration has been cancelled.
Override to handle wayland.zwlr_output_configuration_v1.events.cancelled.