Struct PlatformFacts 

#[non_exhaustive]
pub struct PlatformFacts {
    pub target: String,
    pub quit: Quit,
    pub windowed: bool,
    pub keyboard: Keyboard,
    pub pointer: bool,
    pub touch: bool,
    pub device: Option<Device>,
}

Where the game runs: its target’s id, and what that target lets a game do and the player press.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

target: String

The target’s id, as its profile names it (desktop, web, steam-deck, playdate).

quit: Quit

How the player leaves the game: by its own Quit, or through the system (can_quit).

windowed: bool

Whether the game is in a window the player can switch to full screen and back. Where it isn’t, the Fullscreen setting does nothing, and the engine’s options screen leaves its row out.

keyboard: Keyboard

Whether the device has a keyboard: without one the game’s first-key screen never opens, and the key bindings screen shows the controller’s alone.

pointer: bool

Whether a mouse or another pointer exists.

touch: bool

Whether a touch screen exists.

device: Option<Device>

The device the player holds, where the target has just the one: help text names its buttons from the first frame, before any press (Ctx::device). None where it isn’t known until something is pressed.

Implementations

impl PlatformFacts

pub fn from_profile(profile: &TargetProfile) -> Self

The facts of the target profile describes.

pub fn with_device(self, device: Device) -> Self

The same facts on a target whose player holds device.

pub fn can_quit(&self) -> bool

Whether the game may offer its own Quit: where the player leaves through the system (a browser’s tab, a console’s home button), a Quit would do nothing, so a game leaves it out.

Trait Implementations

impl Clone for PlatformFacts

fn clone(&self) -> PlatformFacts

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PlatformFacts

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

Formats the value using the given formatter.

impl Default for PlatformFacts

fn default() -> Self

The engine’s desktop target’s facts: a window that can go full screen, the game’s own Quit, a keyboard and a pointer, no touch.

impl<'de> Deserialize<'de> for PlatformFacts

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for PlatformFacts

impl PartialEq for PlatformFacts

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for PlatformFacts

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PlatformFacts