Struct playdate_controls::peripherals::Crank

pub struct Crank<Api = Default>(/* private fields */);

Crank

Implementations

impl Crank<Default>

pub fn Default() -> Self

Creates default Crank without type parameter requirement.

Uses ZST api::Default.

impl Crank<Cache>

pub fn Cached() -> Self

Creates Crank without type parameter requirement.

Uses api::Cache.

impl<Api: Default + Api> Crank<Api>

pub fn new() -> Self

impl<Api: Api> Crank<Api>

pub const fn new_with(api: Api) -> Self

impl<Api: Api> Crank<Api>

pub fn docked(&self) -> bool

Returns boolean indicating whether or not the crank is folded into the unit.

Equivalent to sys::ffi::playdate_sys::isCrankDocked.

pub fn angle(&self) -> c_float

Returns the current position of the crank, in the range 0-360. Zero is pointing up, and the value increases as the crank moves clockwise, as viewed from the right side of the device.

Equivalent to sys::ffi::playdate_sys::getCrankAngle.

pub fn change(&self) -> c_float

Returns the angle change of the crank since the last time this function was called. Negative values are anti-clockwise.

Equivalent to sys::ffi::playdate_sys::getCrankChange.

pub fn disable_sounds(&self, disable: bool) -> bool

Returns the previous value for this setting.

Equivalent to sys::ffi::playdate_sys::setCrankSoundsDisabled.

Trait Implementations

impl<Api: Clone> Clone for Crank<Api>

fn clone(&self) -> Crank<Api>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Api: Debug> Debug for Crank<Api>

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

Formats the value using the given formatter.

impl<Api: Default + Api> Default for Crank<Api>

fn default() -> Self

Returns the “default value” for a type.

impl<Api: Copy> Copy for Crank<Api>

Layout

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.