devela::_dep::sdl3::sys::haptic

Struct SDL_HapticPeriodic

Help

#[repr(C)]
pub struct SDL_HapticPeriodic {Show 14 fields
    pub type: u16,
    pub direction: SDL_HapticDirection,
    pub length: u32,
    pub delay: u16,
    pub button: u16,
    pub interval: u16,
    pub period: u16,
    pub magnitude: i16,
    pub offset: i16,
    pub phase: u16,
    pub attack_length: u16,
    pub attack_level: u16,
    pub fade_length: u16,
    pub fade_level: u16,
}

Available on crate feature dep_sdl3 only.

Expand description

A structure containing a template for a Periodic effect.

The struct handles the following effects:

A periodic effect consists in a wave-shaped effect that repeats itself over time. The type determines the shape of the wave and the parameters determine the dimensions of the wave.

Phase is given by hundredth of a degree meaning that giving the phase a value of 9000 will displace it 25% of its period. Here are sample values:

0: No phase displacement.
9000: Displaced 25% of its period.
18000: Displaced 50% of its period.
27000: Displaced 75% of its period.
36000: Displaced 100% of its period, same as 0, but 0 is preferred.

Examples:

  SDL_HAPTIC_SINE
    __      __      __      __
   /  \    /  \    /  \    /
  /    \__/    \__/    \__/

  SDL_HAPTIC_SQUARE
   __    __    __    __    __
  |  |  |  |  |  |  |  |  |  |
  |  |__|  |__|  |__|  |__|  |

  SDL_HAPTIC_TRIANGLE
    /\    /\    /\    /\    /\
   /  \  /  \  /  \  /  \  /
  /    \/    \/    \/    \/

  SDL_HAPTIC_SAWTOOTHUP
    /|  /|  /|  /|  /|  /|  /|
   / | / | / | / | / | / | / |
  /  |/  |/  |/  |/  |/  |/  |

  SDL_HAPTIC_SAWTOOTHDOWN
  \  |\  |\  |\  |\  |\  |\  |
   \ | \ | \ | \ | \ | \ | \ |
    \|  \|  \|  \|  \|  \|  \|

§Availability

This struct is available since SDL 3.2.0.

§See also

Fields§

§type: u16

SDL_HAPTIC_SINE, SDL_HAPTIC_SQUARE SDL_HAPTIC_TRIANGLE, SDL_HAPTIC_SAWTOOTHUP or SDL_HAPTIC_SAWTOOTHDOWN

§direction: SDL_HapticDirection

Direction of the effect.

§length: u32

Duration of the effect.

§delay: u16

Delay before starting the effect.

§button: u16

Button that triggers the effect.

§interval: u16

How soon it can be triggered again after button.

§period: u16

Period of the wave.

§magnitude: i16

Peak value; if negative, equivalent to 180 degrees extra phase shift.

§offset: i16

Mean value of the wave.

§phase: u16

Positive phase shift given by hundredth of a degree.

§attack_length: u16

Duration of the attack.

§attack_level: u16

Level at the start of the attack.

§fade_length: u16

Duration of the fade.

§fade_level: u16

Level at the end of the fade.

Trait Implementations§

§

impl Clone for SDL_HapticPeriodic

§

fn clone(&self) -> SDL_HapticPeriodic

Returns a copy of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

§

impl Default for SDL_HapticPeriodic

§

fn default() -> SDL_HapticPeriodic

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

§

impl Copy for SDL_HapticPeriodic

Auto Trait Implementations§

§

impl UnwindSafe for SDL_HapticPeriodic

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> 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> ByteSized for T

Source §

const BYTE_ALIGN: usize = _

The alignment of this type in bytes.

Source §

const BYTE_SIZE: usize = _

The size of this type in bytes.

Source §

fn byte_align(&self) -> usize

Returns the alignment of this type in bytes.

Source §

fn byte_size(&self) -> usize

Returns the size of this type in bytes. Read more

Source §

fn ptr_size_ratio(&self) -> [usize; 2]

Returns the size ratio between Ptr::BYTES and BYTE_SIZE. Read more

Source §

impl<T, R> Chain<R> for T
where T: ?Sized,

Source §

fn chain<F>(self, f: F) -> R
where F: FnOnce(Self) -> R, Self: Sized,

Chain a function which takes the parameter by value.

Source §

fn chain_ref<F>(&self, f: F) -> R
where F: FnOnce(&Self) -> R,

Chain a function which takes the parameter by shared reference.

Source §

fn chain_mut<F>(&mut self, f: F) -> R
where F: FnOnce(&mut Self) -> R,

Chain a function which takes the parameter by exclusive reference.

Source §

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

Source §

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

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dst. Read more

Source §

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

Source §

fn type_id() -> TypeId

Returns the TypeId of Self. Read more

Source §

fn type_of(&self) -> TypeId

Returns the TypeId of self. Read more

Source §

fn type_name(&self) -> &'static str ⓘ

Returns the type name of self. Read more

Source §

fn type_is<T: 'static>(&self) -> bool

Returns true if Self is of type T. Read more

Source §

fn type_hash(&self) -> u64

Returns a deterministic hash of the TypeId of Self.

Source §

fn type_hash_with<H: Hasher>(&self, hasher: H) -> u64

Returns a deterministic hash of the TypeId of Self using a custom hasher.

Source §

fn as_any_ref(&self) -> &dyn Any
where Self: Sized,

Upcasts &self as &dyn Any. Read more

Source §

fn as_any_mut(&mut self) -> &mut dyn Any
where Self: Sized,

Upcasts &mut self as &mut dyn Any. Read more

Source §

fn as_any_box(self: Box<Self>) -> Box<dyn Any>
where Self: Sized,

Upcasts Box<self> as Box<dyn Any>. Read more

Source §

fn downcast_ref<T: 'static>(&self) -> Option<&T> ⓘ

Available on crate feature unsafe_layout only.

Returns some shared reference to the inner value if it is of type T. Read more

Source §

fn downcast_mut<T: 'static>(&mut self) -> Option<&mut T> ⓘ

Available on crate feature unsafe_layout only.

Returns some exclusive reference to the inner value if it is of type T. Read more

Source §

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

Source §

const NEEDS_DROP: bool = _

Know whether dropping values of this type matters, in compile-time.

Source §

fn mem_align_of<T>() -> usize

Returns the minimum alignment of the type in bytes. Read more

Source §

fn mem_align_of_val(&self) -> usize

Returns the alignment of the pointed-to value in bytes. Read more

Source §

fn mem_size_of<T>() -> usize

Returns the size of a type in bytes. Read more

Source §

fn mem_size_of_val(&self) -> usize

Returns the size of the pointed-to value in bytes. Read more

Source §

fn mem_copy(&self) -> Self
where Self: Copy,

Bitwise-copies a value. Read more

Source §

fn mem_needs_drop(&self) -> bool

Returns true if dropping values of this type matters. Read more

Source §

fn mem_drop(self)
where Self: Sized,

Drops self by running its destructor. Read more

Source §

fn mem_forget(self)
where Self: Sized,

Forgets about self without running its destructor. Read more

Source §

fn mem_replace(&mut self, other: Self) -> Self
where Self: Sized,

Replaces self with other, returning the previous value of self. Read more

Source §

fn mem_take(&mut self) -> Self
where Self: Default,

Replaces self with its default value, returning the previous value of self. Read more

Source §

fn mem_swap(&mut self, other: &mut Self)
where Self: Sized,

Swaps the value of self and other without deinitializing either one. Read more

Source §

unsafe fn mem_zeroed<T>() -> T

Available on crate feature unsafe_layout only.

Returns the value of type T represented by the all-zero byte-pattern. Read more

Source §

unsafe fn mem_transmute_copy<Src, Dst>(src: &Src) -> Dst

Available on crate feature unsafe_layout only.

Returns the value of type T represented by the all-zero byte-pattern. Read more

Source §

fn mem_as_bytes(&self) -> &[u8] ⓘ
where Self: Sync + Unpin,

Available on crate feature unsafe_slice only.

View a Sync + Unpin self as &[u8]. Read more

Source §

fn mem_as_bytes_mut(&mut self) -> &mut [u8] ⓘ
where Self: Sync + Unpin,

Available on crate feature unsafe_slice only.

View a Sync + Unpin self as &mut [u8]. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<S> FromSample<S> for S

§

fn from_sample_(s: S) -> S

Source §

impl<T> Hook for T

Source §

fn hook_ref<F>(self, f: F) -> Self
where F: FnOnce(&Self),

Applies a function which takes the parameter by shared reference, and then returns the (possibly) modified owned value. Read more

Source §

fn hook_mut<F>(self, f: F) -> Self
where F: FnOnce(&mut Self),

Applies a function which takes the parameter by exclusive reference, and then returns the (possibly) modified owned value. Read more

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Source §

impl<T, U> Into 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> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

§