Struct Mode

pub struct Mode {
    pub active_area: SizeU,
    pub refresh_rate_millihertz: u32,
    pub flags: ModeFlags,
}

Describes an operational mode for a display device attached to the system.

The operational parameters that make up a mode description must be updated atomically, using a resource-intensive “mode setting” operation. Parameters that can be changed quickly, such as brightness and contrast, do not belong in a mode description.

Fields

active_area: SizeU

The dimensions of the displayed image, in pixels.

This describes the image data sent to the display, which is also called the “active area” or “active pixels” in raster scan terminology. Despite the name, some of the “active pixels” may not actually be shown to the user, for example due to corners or notches.

Valid modes have non-empty active areas.

refresh_rate_millihertz: u32

Number of images transmitted to the display in 1,000 seconds.

This quantity is also known as the display’s frame rate, or the display’s vertical refresh rate. The rate is measured in millihertz (mHz).

Valid modes have positive refresh rates.

flags: ModeFlags

Trait Implementations

impl Clone for Mode

fn clone(&self) -> Mode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Mode

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

Formats the value using the given formatter.

impl<D: ResourceDialect> Decode<Mode, D> for Mode

fn new_empty() -> Self

Creates a valid instance of Self. The specific value does not matter, since it will be overwritten by decode.

unsafe fn decode( &mut self, decoder: &mut Decoder<'_, D>, offset: usize, _depth: Depth, ) -> Result<()>

Decodes an object of type T from the decoder’s buffers into self.

impl<D: ResourceDialect> Encode<Mode, D> for &Mode

unsafe fn encode( self, encoder: &mut Encoder<'_, D>, offset: usize, _depth: Depth, ) -> Result<()>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID.

impl<D: ResourceDialect, T0: Encode<SizeU, D>, T1: Encode<u32, D>, T2: Encode<ModeFlags, D>> Encode<Mode, D> for (T0, T1, T2)

unsafe fn encode( self, encoder: &mut Encoder<'_, D>, offset: usize, depth: Depth, ) -> Result<()>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID.

impl PartialEq for Mode

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl TypeMarker for Mode

type Owned = Mode

The owned Rust type which this FIDL type decodes into.

fn inline_align(_context: Context) -> usize

Returns the minimum required alignment of the inline portion of the encoded object. It must be a (nonzero) power of two.

fn inline_size(_context: Context) -> usize

Returns the size of the inline portion of the encoded object, including padding for alignment. Must be a multiple of inline_align.

fn encode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and encoding requires no validation. When true, we can optimize encoding arrays and vectors of Self::Owned to a single memcpy.

fn decode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and decoding requires no validation. When true, we can optimize decoding arrays and vectors of Self::Owned to a single memcpy.

impl ValueTypeMarker for Mode

type Borrowed<'a> = &'a Mode

The Rust type to use for encoding. This is a particular Encode<Self> type cheaply obtainable from &Self::Owned. There are three cases:

fn borrow(value: &<Self as TypeMarker>::Owned) -> Self::Borrowed<'_>

Cheaply converts from &Self::Owned to Self::Borrowed.

impl Persistable for Mode

impl StructuralPartialEq for Mode