Enum FrameCap 

#[non_exhaustive]
pub enum FrameCap {
    Off,
    Fps(u16),
}

The most frames a second the platform shows.

60 by default (FrameCap::DEFAULT): enough for a smooth picture on most displays, and a game that does little uses little of the CPU. Build one with FrameCap::fps, which checks the range; a cap out of the range (MIN_FPS to MAX_FPS), set as Fps(n) in code or read from a file, is held to it when the platform applies it (limit).

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Off

No cap: the platform shows frames as fast as vsync, the display or the machine let it, on purpose.

Fps(u16)

At most this many frames a second.

Implementations

impl FrameCap

pub const DEFAULT: Self

The engine’s default: 60 frames a second.

pub const fn fps(n: u16) -> Result<Self, CapError>

A cap of n frames a second; out of MIN_FPS to MAX_FPS is CapError::OutOfRange.

pub fn limit(self) -> Option<u16>

The most frames a second it allows, held to MIN_FPS to MAX_FPS; None for no cap.

pub const fn key(self) -> &'static str

The text key of its name: FPS_KEY or UNLIMITED_KEY.

pub fn name<G: GameData>(self, ctx: &Ctx<G>) -> String

Its name on an options screen, in ctx’s language: "60 FPS" (FPS_KEY, with the number as {n}) or "Unlimited" (UNLIMITED_KEY).

Trait Implementations

impl Clone for FrameCap

fn clone(&self) -> FrameCap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for FrameCap

impl Debug for FrameCap

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

Formats the value using the given formatter.

impl Default for FrameCap

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FrameCap

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for FrameCap

impl Hash for FrameCap

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for FrameCap

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for FrameCap

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 FrameCap