Enum Request

#[non_exhaustive]
pub enum Request<'a> {
    InhibitOutput,
    InhibitOutputDone,
    CreateHotspot {
        hotspot: u32,
        threshold: u32,
        timeout: u32,
    },
}

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

InhibitOutput

Don’t render the output

Request the compositor to not render the output, so the output usually is cleared to black color. To enable output rendering again, call inhibit_output_done.

InhibitOutputDone

Render the output

Stop inhibiting the output. This must be called as many times as inhibit_output was called to actually uninhibit rendering.

The inhibit/inhibit_done requests can be called multiple times, even from different apps, so don’t assume that a call to inhibit_done would always mean actually starting the rendering process.

CreateHotspot

Create a hotspot on the output

A hotspot on the output is an edge or a corner region of the output where the mouse or touch point has been residing for a given amount of time.

The hotspot can be used for example for autohiding panels, where the panel is shown when the input hovers on the edge of the output for a specific amount of time.

Fields

hotspot: u32

bitwise or of the edges the output

threshold: u32

distance from the edge of the output

timeout: u32

minimum time for the mouse to be in the hotspot

Implementations

impl<'a> Request<'a>

pub fn opcode(&self) -> u16

Get the opcode number of this message

Trait Implementations

impl<'a> Debug for Request<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.