Struct wayland_protocols::unstable::fullscreen_shell::v1::client::zwp_fullscreen_shell_v1::ZwpFullscreenShellV1

pub struct ZwpFullscreenShellV1(_);

Implementations

impl ZwpFullscreenShellV1

pub fn release(&self)

release the wl_fullscreen_shell interface

Release the binding from the wl_fullscreen_shell interface.

This destroys the server-side object and frees this binding. If the client binds to wl_fullscreen_shell multiple times, it may wish to free some of those bindings.

This is a destructor, you cannot send requests to this object any longer once this method is called.

pub fn present_surface(
    &self,
    surface: Option<&WlSurface>,
    method: PresentMethod,
    output: Option<&WlOutput>
)

present surface for display

Present a surface on the given output.

If the output is null, the compositor will present the surface on whatever display (or displays) it thinks best. In particular, this may replace any or all surfaces currently presented so it should not be used in combination with placing surfaces on specific outputs.

The method parameter is a hint to the compositor for how the surface is to be presented. In particular, it tells the compositor how to handle a size mismatch between the presented surface and the output. The compositor is free to ignore this parameter.

The “zoom”, “zoom_crop”, and “stretch” methods imply a scaling operation on the surface. This will override any kind of output scaling, so the buffer_scale property of the surface is effectively ignored.

This request gives the surface the role of a fullscreen shell surface. If the surface already has another role, it raises a role protocol error.

pub fn present_surface_for_mode(
    &self,
    surface: &WlSurface,
    output: &WlOutput,
    framerate: i32
) -> Main<ZwpFullscreenShellModeFeedbackV1>

present surface for display at a particular mode

Presents a surface on the given output for a particular mode.

If the current size of the output differs from that of the surface, the compositor will attempt to change the size of the output to match the surface. The result of the mode-switch operation will be returned via the provided wl_fullscreen_shell_mode_feedback object.

If the current output mode matches the one requested or if the compositor successfully switches the mode to match the surface, then the mode_successful event will be sent and the output will contain the contents of the given surface. If the compositor cannot match the output size to the surface size, the mode_failed will be sent and the output will contain the contents of the previously presented surface (if any). If another surface is presented on the given output before either of these has a chance to happen, the present_cancelled event will be sent.

Due to race conditions and other issues unknown to the client, no mode-switch operation is guaranteed to succeed. However, if the mode is one advertised by wl_output.mode or if the compositor advertises the ARBITRARY_MODES capability, then the client should expect that the mode-switch operation will usually succeed.

If the size of the presented surface changes, the resulting output is undefined. The compositor may attempt to change the output mode to compensate. However, there is no guarantee that a suitable mode will be found and the client has no way to be notified of success or failure.

The framerate parameter specifies the desired framerate for the output in mHz. The compositor is free to ignore this parameter. A value of 0 indicates that the client has no preference.

If the value of wl_output.scale differs from wl_surface.buffer_scale, then the compositor may choose a mode that matches either the buffer size or the surface size. In either case, the surface will fill the output.

This request gives the surface the role of a fullscreen shell surface. If the surface already has another role, it raises a role protocol error.

Trait Implementations

impl AsRef<Proxy<ZwpFullscreenShellV1>> for ZwpFullscreenShellV1

fn as_ref(&self) -> &Proxy<Self>

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for ZwpFullscreenShellV1

fn clone(&self) -> ZwpFullscreenShellV1

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ZwpFullscreenShellV1

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

Formats the value using the given formatter.

impl From<Proxy<ZwpFullscreenShellV1>> for ZwpFullscreenShellV1

fn from(value: Proxy<Self>) -> Self

Converts to this type from the input type.

impl From<ZwpFullscreenShellV1> for Proxy<ZwpFullscreenShellV1>

fn from(value: ZwpFullscreenShellV1) -> Self

Converts to this type from the input type.

impl Interface for ZwpFullscreenShellV1

type Request = Request

Set of requests associated to this interface

type Event = Event

Set of events associated to this interface

const NAME: &'static str = "zwp_fullscreen_shell_v1"

Name of this interface

const VERSION: u32 = 1u32

Maximum supported version of this interface

fn c_interface() -> *const wl_interface

Pointer to the C representation of this interface

impl PartialEq<ZwpFullscreenShellV1> for ZwpFullscreenShellV1

fn eq(&self, other: &ZwpFullscreenShellV1) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ZwpFullscreenShellV1

impl StructuralEq for ZwpFullscreenShellV1

impl StructuralPartialEq for ZwpFullscreenShellV1