Struct runa_wayland_protocols::wayland::wl_shell_surface::v1::requests::SetFullscreen

pub struct SetFullscreen {
    pub method: FullscreenMethod,
    pub framerate: u32,
    pub output: Object,
}

make the surface a fullscreen surface

Map the surface as a fullscreen surface.

If an output parameter is given then the surface will be made fullscreen on that output. If the client does not specify the output then the compositor will apply its policy - usually choosing the output on which the surface has the biggest surface area.

The client may specify a method to resolve a size conflict between the output size and the surface size - this is provided through the method parameter.

The framerate parameter is used only when the method is set to “driver”, to indicate the preferred framerate. A value of 0 indicates that the client does not care about framerate. The framerate is specified in mHz, that is framerate of 60000 is 60Hz.

A method of “scale” or “driver” implies a scaling operation of the surface, either via a direct scaling operation or a change of the output mode. This will override any kind of output scaling, so that mapping a surface with a buffer size equal to the mode can fill the screen independent of buffer_scale.

A method of “fill” means we don’t scale up the buffer, however any output scale is applied. This means that you may run into an edge case where the application maps a buffer with the same size of the output mode but buffer_scale 1 (thus making a surface larger than the output). In this case it is allowed to downscale the results to fit the screen.

The compositor must reply to this request with a configure event with the dimensions for the output on which the surface will be made fullscreen.

Fields

method: FullscreenMethod

framerate: u32

output: Object

Implementations

impl SetFullscreen

pub const OPCODE: u16 = 5u16

Trait Implementations

impl Clone for SetFullscreen

fn clone(&self) -> SetFullscreen

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SetFullscreen

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

Formats the value using the given formatter.

impl<'a> Deserialize<'a> for SetFullscreen

fn deserialize(data: &'a [u8], fds: &'a [RawFd]) -> Result<Self, Error>

Deserialize from the given buffer. Returns deserialized message, and number of bytes and file descriptors consumed, respectively.

impl PartialEq<SetFullscreen> for SetFullscreen

fn eq(&self, other: &SetFullscreen) -> 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 Serialize for SetFullscreen

fn serialize<Fds: Extend<OwnedFd>>(self, buf: &mut BytesMut, fds: &mut Fds)

Serialize into the buffered writer. This function returns no errors, failures in seializing are generally program errors, and triggers panicking.

fn len(&self) -> u16

How many bytes will this message serialize to. Including the 8 byte header.

fn nfds(&self) -> u8

How many file descriptors will this message serialize to.

impl Copy for SetFullscreen

impl Eq for SetFullscreen

impl StructuralEq for SetFullscreen

impl StructuralPartialEq for SetFullscreen