Crank

playdate_controls::peripherals

Struct Crank 

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

Crank

Implementations§

Source§

impl Crank<Default>

Source

pub fn Default() -> Self

Creates default Crank without type parameter requirement.

Uses ZST api::Default.

Source§

impl Crank<Cache>

Source

pub fn Cached() -> Self

Creates Crank without type parameter requirement.

Uses api::Cache.

Source§

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

Source

pub fn new() -> Self

Source§

impl<Api: Api> Crank<Api>

Source

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

Source§

impl<Api: Api> Crank<Api>

Source

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.

Source

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.

Source

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.

Source

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

Returns the previous value for this setting.

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

Trait Implementations§

Source§

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

Source§

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

Returns a duplicate of the value. Read more
1.0.0§

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

Performs copy-assignment from source. Read more
Source§

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

Source§

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

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

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

Source§

fn default() -> Self

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

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

Auto Trait Implementations§

§

impl<Api> Freeze for Crank<Api>
where Api: Freeze,

§

impl<Api> RefUnwindSafe for Crank<Api>
where Api: RefUnwindSafe,

§

impl<Api> Send for Crank<Api>
where Api: Send,

§

impl<Api> Sync for Crank<Api>
where Api: Sync,

§

impl<Api> Unpin for Crank<Api>
where Api: Unpin,

§

impl<Api> UnwindSafe for Crank<Api>
where Api: UnwindSafe,

Blanket Implementations§

§

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

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

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

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

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

§

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

Mutably borrows from an owned value. Read more
§

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

§

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
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

§

fn into(self) -> U

Calls U::from(self).

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

§

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

§

type Owned = T

The resulting type after obtaining ownership.
§

fn to_owned(&self) -> T

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

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

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

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

§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
§

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

§

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

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

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

Performs the conversion.

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.