Skip to main content

FerroHeadlessPlatformOptions

Struct FerroHeadlessPlatformOptions 

Source
pub struct FerroHeadlessPlatformOptions {
    pub fps: i32,
    pub should_render_on_ui_thread: bool,
    pub use_headless_drawing: bool,
    pub frame_buffer_format: PixelFormat,
    pub overlay_popups: bool,
    pub use_shared_mouse_device: Option<bool>,
    pub supports_window_positioning: bool,
    pub use_logical_desktop_coordinates: bool,
}
Expand description

Options for configuring the headless platform.

Fields§

§fps: i32

Gets or sets the number of frames per second at which the renderer should run. Default 60.

§should_render_on_ui_thread: bool

Render directly on the UI thread instead of using a dedicated render thread. This can be usable if your device doesn’t have multiple cores to begin with. This setting is true by default (the documentation of the original says false).

§use_headless_drawing: bool

Gets or sets a value indicating whether to use headless drawing mode, which allows rendering without creating an actual window.

Disable this option if you are using the Skia backend or another drawing backend.

§frame_buffer_format: PixelFormat

Gets or sets the pixel format to be used for the headless window framebuffers.

§overlay_popups: bool

Embeds popups to the window when set to true. The default value is true.

§use_shared_mouse_device: Option<bool>

Shares a single mouse device between all top-levels when set to true, so that pointer capture and click counting are global rather than per-window, as they are on the other platforms. When None or false, every top-level gets its own mouse device.

§supports_window_positioning: bool

When false, top-level windows always report a PixelPoint origin position and ignore moves, as on Wayland where the compositor owns window placement. Popups still report their position relative to their parent. The default value is true.

§use_logical_desktop_coordinates: bool

When true, desktop scaling is always 1 and screen coordinates (window position, point_to_screen, point_to_client) are logical units regardless of render scaling, as on macOS and Wayland. The default value is false: screen coordinates are physical pixels, as on Windows and X11.

Trait Implementations§

Source§

impl Clone for FerroHeadlessPlatformOptions

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FerroHeadlessPlatformOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for FerroHeadlessPlatformOptions

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PartialEq for FerroHeadlessPlatformOptions

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for FerroHeadlessPlatformOptions

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> AnyValue for T
where T: PartialEq + 'static,

Source§

fn any_value_as_any(&self) -> &(dyn Any + 'static)

Source§

fn any_value_eq(&self, other: &(dyn AnyValue + 'static)) -> bool

Source§

fn any_value_type_name(&self) -> &'static str

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> ClassDefaults for T
where T: ?Sized,

Source§

fn static_constructor()

The static constructor of a type: work done once per thread, after the properties of the type are registered and before its first instance exists (class handlers, affects_render, metadata overrides). Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PropertyValue for T
where T: Clone + PartialEq + 'static,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.